Skip to main content
POST
cURL

Error Codes and Messages

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
customer_id
string<uuid>
required

Zapyd customer ID (UUID) returned by Create Customer.

Example:

"075986f3-282b-4555-bfcd-fad973e32596"

redirect_url
string<uri>

Optional. Where to send the customer after the KYC flow. Defaults to the redirect URL set for your organization.

Example:

"https://yourapp.com/kyc/return"

Response

Hosted KYC URL generated successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object