Partner Onboarding

Submit KYC Data

Submit identity (KYC) data you have already collected for the applicant, with their consent. Verification runs server-side; the applicant does not need to complete a verification link. The result is usually available asynchronously: poll the application status endpoint for the final kyc_status, or subscribe to the identity_verification.* webhook events. Repeat submissions while a verification is in progress are idempotent and return the current status without re-sending data; corrected data is applied on a new submission after the current attempt completes or fails.

post/partner/applications/{app_id}/kyc

Request

Path parameters

app_idstring required

The onboarding application, as returned when it was created.

Request body

first_namestring required

Legal first name.

last_namestring required

Legal last name.

date_of_birthstring date required

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

id_numberstring password nullable

Government ID number matching id_type. For us_ssn use nine digits, with or without dashes (123-45-6789 or 123456789); for us_ssn_last_4 use the last four digits; for non-US ID types provide the number as issued. Formatting characters are stripped before verification. Required when the representative's country issues an ID type we can verify, and must be omitted when it does not (e.g. the United Kingdom, which has no supported ID type).

id_type'ar_dni' | 'au_drivers_license' | 'au_passport' | 'br_cpf' | 'ca_sin' | 'cl_run' | 'cn_resident_card' | 'co_nit' | 'dk_cpr' | 'eg_national_id' | 'es_dni' | 'es_nie' | 'hk_hkid' | 'in_pan' | 'in_epic' | 'it_cf' | 'jo_civil_id' | 'jp_my_number' | 'ke_huduma_namba' | 'kw_civil_id' | 'mx_curp' | 'mx_rfc' | 'my_nric' | 'ng_nin' | 'nz_drivers_license' | 'om_civil_id' | 'ph_psn' | 'pl_pesel' | 'ro_cnp' | 'sa_national_id' | 'se_pin' | 'sg_nric' | 'tr_tc_kimlik' | 'us_ssn' | 'us_ssn_last_4' | 'za_smart_id'
phone_numberstring nullable

Phone number in E.164 format (e.g. +14155550123).

ipstring ipvanyaddress required

IPv4 or IPv6 address of the end user submitting this verification. Forwarded to the identity-verification provider as a fraud signal.

user_emailstring email required

Email address of the applicant this KYC data belongs to. Must match the user_email the application was created with.

Example request

{
  "first_name": "Felix",
  "last_name": "Whiskers",
  "id_number": "123-45-6789",
  "address": {
    "address": "9 Whisker Way",
    "address_2": "Suite 9",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94105"
  },
  "phone_number": "+14155550123",
  "ip": "203.0.113.42"
}

Response

Successful Response

application_idstring uuid required

Unique application identifier.

user_emailstring required

Email address of the verified applicant.

kyc_status'not_started' | 'pending' | 'action_required' | 'approved' | 'rejected' required

Changes

No recorded changes to this operation across all 1 revision of this API.