Verification

Verification evidence for a profile.

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:

verifications, err := client.Verification(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(verifications)
created, err := client.Verification(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

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

local verifications, err = client:Verification():list({ profile_id = 1 })
local created, err = client:Verification():create({ profile_id = 1 })

PHP

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

$verifications = $client->Verification()->list(["profile_id" => 1]);
$created = $client->Verification()->create(["profile_id" => 1]);

Python

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

verifications = client.Verification().list({"profile_id": 1})
created = client.Verification().create({ "profile_id": 1 })

Ruby

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

verifications = client.Verification.list({ "profile_id" => 1 })
created = client.Verification.create({ "profile_id" => 1 })

TypeScript

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

const verifications = await client.Verification().list({ profile_id: 1 })
const created = await client.Verification().create({ profile_id: 1 })

Fields

create

POST /profiles/{profileId}/additional-verification/upload-evidences

Operation ID: verificationUploadEvidences.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

The request body is object or object.

Responses

207: Multi-Status - Evidence(s) successfully uploaded, fully or partially

application/json

400: Bad Request - Invalid request payload (for example no evidence, misspelled evidence, unexpected value)

403: Forbidden - The client is not authorized to perform this request

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}/verification-status/required-evidences

Operation ID: verificationGetRequiredEvidences.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved required evidences

application/json

Example response:

{
  "required_evidences": [
    "SOURCE_OF_WEALTH",
    "INCOME",
    "USE_CASE_COUNTRIES"
  ]
}

403: Forbidden - The client is not authorized to perform this request

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

application/json

The response is object.