/api/partner/v2/users/{id}/kyc/verification-link

Generates a direct KYC verification link for an existing user under your partner account.
This allows you to redirect the user to a KYC provider to complete identity verification.

🔐 Headers

⚠️

This endpoint requires authentication using a valid partner-api-key.

📥 Request Body

📘 Example Request

curl --request POST \
     --url https://staging-api.capa.fi/api/partner/v2/users/d1baa719-f382-4a4a-9940-81063b6fb0bb/kyc/verification-link \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'partner-api-key: {{API-KEY}}' \
     --data '
{
  "country": "MX",
  "partnerRedirectUri": "https://capa.fi"
}
'

📤 Response Body

📘 Example Response

{
  "kycLink": "https://kyc-provider.com/session/abcd-1234"
}

 

⚠️ Important Notes & Requirements

• Partner API Key is mandatory: All requests must include a valid PartnerApiKey in the header. Get your API key.
• User must exist: You must create the user first using the Create User endpoint before generating a verification link.
• Supported Countries: Only supported countries for KYC include MX (Mexico) and DO (Dominican Republic).
• KYC Provider Sessions: Each kycLink is unique and tied to a single verification session. If expired, a new link must be generated.
• Redirection: If partnerRedirectUri is not provided, the user may not be redirected after completing the KYC process.

✅ Use Cases

• Initiate KYC Flow
  Trigger a KYC process for a user immediately after account creation by generating a verification link and directing the user to it.

• Email or App Link
  Embed the kycLink in an onboarding email or app screen so the user can complete verification with one click.

• Custom App Redirect
  Use partnerRedirectUri to bring the user back to your app (web or mobile) after finishing KYC verification with the provider.