MEmeow
Entities

Submit Representative KYC Data

Submit identity (KYC) data for a representative you added. Verification runs server-side; poll the entity onboarding status endpoint for the result. Use this when you hold the representative's identity details; otherwise mint a verification link for them to self-verify.

post/entities/{entity_id}/representatives/{representative_id}/kyc

Request

Path parameters

representative_idstring required

The representative, as returned in representatives on GET /entities/{entity_id}.

entity_idstring required

The entity being onboarded.

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.

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

representative_idstring uuid required

ID of the representative whose KYC was submitted.

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

Changes

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