HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Create a KYC application for a user

post
https://sandbox.getunblock.com/user/kyc/applicant

First step to start a KYC process for a user by creating an applicant, this is a one off call per user.

Body Params
address
object
required
string
required

Date format should be YYYY-MM-DD

string
enum
required
Allowed:
string

Social Security Number (SSN) for US users. Optional field, but required for US users to verify and be able to use US-based bank accounts. Must be exactly 9 digits with no dashes or spaces. Forbidden values are rejected (e.g. all zeros, area number 666, or invalid group/serial numbers per SSA rules).

string

IP Address of the user. Required for US users and when uploading KYC docs over API.

string

Phone number in the E.164 standard. Necessary to e.g. complete non-doc based Proof of Address from the US.

mailing_address
object

Optional mailing address. If provided for US, state is required.

string
enum

User occupation (optional)

Responses
204

KYC application created

Updated 8 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago