Skip to main content
POST
Initiate KYC (Generate KYC URL)

Headers

X-Api-Key
string
required

Your API key (configured in credentials)

X-Signature
string
required

HMAC-SHA256 signature (auto-generated) To test manually: HMAC-SHA256 of apiKey + timestamp (or apiKey + timestamp + userId when X-User-Id is required), keyed with your API secret. The HMAC Generator flow computes this for you.

X-Timestamp
string
required

Unix timestamp in seconds (auto-generated) Unix seconds, e.g. Math.floor(Date.now() / 1000). Must match the timestamp used in the X-Signature computation.

X-Request-Id
string
required

Unique request identifier (auto-generated) Any unique string per request, e.g. a UUID.

X-Platform
string

Platform identifier (e.g. android, ios, web).

X-Real-Ip
string

Device IP address.

X-Latitude
string

Device latitude.

X-Longitude
string

Device longitude.

Body

application/json
country
string
required

ISO alpha-3 country code (e.g. IND, USA). Primary required field.

first_name
string

User's first name.

last_name
string

User's last name.

date_of_birth
string

Date of birth in YYYY-MM-DD format. User must be of legal KYC age.

address
object

User's address. If any sub-field is provided, then address_line1, locality, city, state, and postal_code are all required.

user_nationality_iso2
string

User's nationality as ISO alpha-2 country code (e.g. IN).

Response

Successful response

success
boolean
data
object