Start KYC

curl --request POST \
  --url https://api.qash.ai/api/v1/partner/kyc \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-key>' \
  --data '
{
  "userId": "03384ada-a9c5-4c2e-a1bd-a13629ba060c"
}
'

{
  "success": true,
  "verificationUrl": "https://inquiry.withpersona.com/verify?inquiry-id=inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw",
  "inquiryId": "inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw"
}

{
  "success": false,
  "error": "Invalid birthDate format. Use YYYY-MM-DD"
}

{
  "success": false,
  "error": "Invalid partner credentials"
}

{
  "success": false,
  "error": "User not found"
}

{
  "success": false,
  "error": "KYC already in progress for this user"
}

{
  "success": false,
  "error": "Failed to create Persona inquiry"
}

POST

api

partner

kyc

curl --request POST \
  --url https://api.qash.ai/api/v1/partner/kyc \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-key>' \
  --data '
{
  "userId": "03384ada-a9c5-4c2e-a1bd-a13629ba060c"
}
'

{
  "success": true,
  "verificationUrl": "https://inquiry.withpersona.com/verify?inquiry-id=inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw",
  "inquiryId": "inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw"
}

{
  "success": false,
  "error": "Invalid birthDate format. Use YYYY-MM-DD"
}

{
  "success": false,
  "error": "Invalid partner credentials"
}

{
  "success": false,
  "error": "User not found"
}

{
  "success": false,
  "error": "KYC already in progress for this user"
}

{
  "success": false,
  "error": "Failed to create Persona inquiry"
}

Requires X-Api-Key and X-Api-Secret headers. See Authentication for details.

Redirect the user to the returned verificationUrl to complete their identity check through Persona. Once completed, Persona notifies Qash automatically and the user’s status transitions to active — no polling or webhook required on your end.

Calling this again while a verification is already in progress does not error — it returns 200 with isExisting: true and the same verificationUrl/inquiryId as before, so it’s safe to call defensively.

Returns 422 with KYC already finalized with status: <status> only if the user’s most recent KYC has already reached a terminal state (approved, declined, rejected, failed, or expired). Call KYC status to check current status before retrying.

Authorizations

X-Api-Key

string

header

required

Partner API key. Generated from Qash Dashboard → Settings → API Keys.

X-Api-Secret

string

header

required

Partner API secret. Shown once at creation — store it securely.

Body

application/json

KYC initiation payload.

userId

string<uuid>

required

ID of the user to verify, obtained from POST /users.

Example:

"03384ada-a9c5-4c2e-a1bd-a13629ba060c"

firstName

string

User's first name. Optional — improves Persona pre-fill if provided.

Example:

"Juan"

lastName

string

User's last name. Optional — improves Persona pre-fill if provided.

Example:

"Pérez"

string<email>

User's email address. Optional — improves Persona pre-fill if provided.

Example:

"usuario@empresa.com"

phone

string

Phone number in international format.

Example:

"+573001234567"

birthDate

string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-04-15"

Response

KYC initiated successfully.

success

boolean

required

Example:

true

data

object

required

Hide child attributes

data.inquiryId

string

required

Persona inquiry ID for tracking the verification.

Example:

"inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw"

data.verificationUrl

string<uri> | null

required

URL to redirect the user to for completing identity verification via Persona.

Example:

"https://inquiry.withpersona.com/verify?inquiry-id=inq_A3VPwfoLJtprzJxREEeq3kmz6MyYyw"

data.isExisting

boolean

required

True if this returns an already in-progress verification instead of creating a new one.

Example:

false

data.message

string

required

Human-readable status message.

Example:

"KYC verification started. Please complete the verification process."

Exchange rates / TRM

Cards

Users

Login

User profile

KYC

Account Management

Financials

Authorizations

Body

Response