KycReview

A KYC review: create, list, get or update one, or submit a requirement.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

kyc_reviews, err := client.KycReview(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(kyc_reviews)
kyc_review, err := client.KycReview(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(kyc_review)
created, err := client.KycReview(nil).Create(map[string]any{"profile_id": 1, "type": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.KycReview(nil).Update(map[string]any{"id": "example_id", "profile_id": 1, "redirectUrl": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

Construct client as shown in the Lua setup, then call the operations:

local kyc_reviews, err = client:KycReview():list({ profile_id = 1 })
local kyc_review, err = client:KycReview():load({ id = "example_id", profile_id = 1 })
local created, err = client:KycReview():create({ profile_id = 1, type = "example" })
local updated, err = client:KycReview():update({ id = "example_id", profile_id = 1, redirectUrl = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$kyc_reviews = $client->KycReview()->list(["profile_id" => 1]);
$kyc_review = $client->KycReview()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->KycReview()->create(["profile_id" => 1, "type" => "example"]);
$updated = $client->KycReview()->update(["id" => "example_id", "profile_id" => 1, "redirectUrl" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

kyc_reviews = client.KycReview().list({"profile_id": 1})
kyc_review = client.KycReview().load({"id": "example_id", "profile_id": 1})
created = client.KycReview().create({ "profile_id": 1, "type": "example" })
updated = client.KycReview().update({"id": "example_id", "profile_id": 1, "redirectUrl": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

kyc_reviews = client.KycReview.list({ "profile_id" => 1 })
kyc_review = client.KycReview.load({ "id" => "example_id", "profile_id" => 1 })
created = client.KycReview.create({ "profile_id" => 1, "type" => "example" })
updated = client.KycReview.update({ "id" => "example_id", "profile_id" => 1, "redirectUrl" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const kyc_reviews = await client.KycReview().list({ profile_id: 1 })
const kyc_review = await client.KycReview().load({ id: "example_id", profile_id: 1 })
const created = await client.KycReview().create({ profile_id: 1, type: "example" })
const updated = await client.KycReview().update({ id: "example_id", profile_id: 1, redirectUrl: "example" })

Fields

create

POST /profiles/{profileId}/kyc-requirements/{requirementKey}

Operation ID: kycReviewRequirementSubmit.

Authentication: bearer token (UserToken).

Parameters

Request body

multipart/form-data

The request body is any or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object.

Responses

202: KYC requirement successfully submitted

400: Invalid request. Common error scenarios: - No submissionData provided - No kycReviewId provided in submission data - No data provided in submission data - Invalid field values - Missing required files

application/json

401: User is not authorised to access the resource

404: KYC Review or provided requirement key not found

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /profiles/{profileId}/kyc-reviews

Operation ID: kycReviewCreate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

202: KYC Review successfully created

application/json

400: Invalid request (for example unsupported type, null type)

401: User is not authorised to access the resource

404: Underlying action with provided ID is not found (for example quote not found)

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /profiles/{profileId}/kyc-reviews

Operation ID: kycReviewList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Returns a list of KYC Review objects for the profile. Returns an empty list if no KYC Review exists for the profile

application/json

401: User is not authorised to access the resource

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /profiles/{profileId}/kyc-reviews/{kycReviewId}

Operation ID: kycReviewGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Returns the KYC Review object including the requirements field

application/json

401: User is not authorised to access the resource

404: KYC Review not found

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PATCH /profiles/{profileId}/kyc-reviews/{kycReviewId}

Operation ID: kycReviewRedirectUrlUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: Returns the updated KYC Review object

application/json

400: Invalid request (for example not a valid URI)

401: User is not authorised to access the resource

404: KYC Review not found

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.