Initiate a new KYC Verification for an existing User.

A request sent to start KYC verification.

Body Params

Data to initiate KYC.

string
required
length between 40 and 40

A User identifier. Begins with 'usr-' followed by a v4 UUID

string
enum
required

The type of KYC process.

  • full - A KYC process that requires document scanning.
  • shipping - A KYC form that only collects a shipping address.
  • rfi - A Request For Information collection whenever some additional are asked to the user. For instance a Proof of address.
  • import - A KYC process that imports pre-verified identity data from a trusted partner platform.
Allowed:
string

An optional URI that the KYC webview will redirect to after the user completes their submission

Responses

400

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

403

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.

429

The user has sent too many requests in a given amount of time ("rate limiting").

500

The server has encountered a situation it does not know how to handle.

502

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

503

The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.

504

This error response is given when the server is acting as a gateway and cannot get a response in time.

Language
Credentials
Header
Response
Choose an example:
application/json