Skip to main content
POST
Create a partner customer KYC record. The path {id} is the partner-provided KYC id, later referenced as kyc_id on onramp, offramp, and withdraw orders. Fails with 409 Conflict if a record with that id already exists. See the Partner Customer KYC guide for the field reference and required-field rules.

​
Authentication

​
Partner-App-Key
string
required
Your partner app key.
​
X-HSPay-Signature
string
required
Base64-encoded Ed25519 signature of the sign data.
​
X-HSPay-Timestamp
string
required
Unix timestamp (seconds) of the request. Must be within 60 seconds of server time.

​
Path Parameters

​
id
string
required
Partner-provided unique id for this customer. Use this value as kyc_id on subsequent orders.

​
Body Parameters

​
name
string
required
Full name.
​
email
string
required
Email.
​
phone
string
required
Phone number.
​
address
string
required
Residential address.
​
id_number
string
required
Identity document number.
​
id_type
integer
required
1 = Citizen ID, 2 = Passport, 3 = License.
​
sex
integer
required
1 = Male, 2 = Female, 3 = Other.
​
nationality
string
required
Nationality.
​
date_of_issue
string
required
Identity document issue date in ISO YYYY-MM-DD format.
​
date_of_expiry
string
required
Identity document expiry date in ISO YYYY-MM-DD format.