Skip to main content

Create an individual

POST 
/individuals

Creates an individual (a natural person, e.g. a casino player) under your partner account. The individual starts in pending status; submit KYX and have it approved before paying the individual or letting them cash out.

Request​

Body

required

    id uuid

    Optional client-supplied id; generated if omitted.

    first_name stringrequired

    Individual's given name.

    last_name stringrequired

    Individual's family name.

    email emailrequired

    Must be unique.

    phone_number stringnullable

    Contact phone number. Non-digit characters are stripped, so formatting is accepted.

    address

    object

    nullable

    Residential address. Optional at creation; required for KYX verification.

    country stringrequired

    Possible values: Value must match regular expression ^[A-Z]{2}$

    ISO 3166-1 alpha-2 country code, e.g. US

    line1 stringrequired

    Street address line 1.

    line2 stringnullable

    Street address line 2.

    zip stringrequired

    Postal / ZIP code.

    city stringrequired

    City.

    state stringrequired

    State / province / region.

    birthdate

    object

    nullable

    Date of birth. Optional at creation; required for KYX verification.

    year integerrequired

    4-digit year of birth.

    month integerrequired

    Possible values: >= 1 and <= 12

    Month of birth (1-12).

    day integerrequired

    Possible values: >= 1 and <= 31

    Day of birth (1-31).

    government_id

    object

    nullable

    Government-issued identifier. Optional at creation; required for KYX verification.

    type stringrequired

    Possible values: [us_ssn, passport, unknown]

    Type of government identifier.

    value stringrequired

    The identifier value (e.g. SSN digits or passport number).

Responses​

Individual created successfully

Schema

    status string

    Possible values: [success]

    data

    object

    id uuid
    code integer

    Possible values: [201]

    message string

    Possible values: [Successful request]

Loading...