Skip to main content

Submit individual KYX

POST 
/kyx/individual

Submits KYX (identity verification) for a previously created individual. Identity documents are sent inline as a map of filename to base64-encoded file content. The individual must pass KYX before it can be paid out or cash out.

Request​

Body

required

    id uuid

    Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    UUID v4

    individual_id uuidrequired

    Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

    UUID v4

    docs

    object

    required

    Map of document filename to base64-encoded file content. The key is the original filename (e.g. "passport.jpg"); the value is the base64-encoded contents of that file.

    property name* string

    Base64-encoded file content.

Responses​

KYX submission accepted. The response envelope carries no resource body; verification is processed asynchronously.

Schema

    status string

    Possible values: [success]

    code integer

    Possible values: [201]

    data undefined[]

    Empty data array; the submission carries no resource body.

    message string
Loading...