Create KYC Link

cURL

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "country": "MX",
  "partnerRedirectUri": "<string>"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link"

payload = {
    "country": "MX",
    "partnerRedirectUri": "<string>"
}
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({country: 'MX', partnerRedirectUri: '<string>'})
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'country' => 'MX',
    'partnerRedirectUri' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link"

	payload := strings.NewReader("{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("partner-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "kycLink": "string"
  }
}

POST

api

partner

users

{userId}

kyc

verification-link

cURL

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "country": "MX",
  "partnerRedirectUri": "<string>"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link"

payload = {
    "country": "MX",
    "partnerRedirectUri": "<string>"
}
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({country: 'MX', partnerRedirectUri: '<string>'})
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'country' => 'MX',
    'partnerRedirectUri' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link"

	payload := strings.NewReader("{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("partner-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/kyc/verification-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"MX\",\n  \"partnerRedirectUri\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "kycLink": "string"
  }
}

Generates a direct KYC verification link for an existing user. Redirect the user to this link to complete identity verification with the KYC provider.

Important Notes

The user must be created first via Create User.
Each kycLink is tied to a unique session. If expired, generate a new link.
If partnerRedirectUri is not provided, the user may not be redirected after completing KYC.
Supports both HTTPS and custom mobile URI schemes (e.g., myapp://).

Use Cases

Initiate KYC: Redirect the user to complete identity verification after account creation.
Email or app link: Embed the kycLink in an onboarding email or app screen.
Custom redirect: Use partnerRedirectUri to bring the user back to your app after verification.

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

User Ownership Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”Partner information is required for this operation”
401	`UNAUTHORIZED`	”User is not associated with the partner”

Endpoint-Specific Errors

HTTP Status	Code	Message
400	`INVALID_USER_INPUT_ERROR`	”Invalid User Input”
400	`INVALID_VERIFICATION_TYPE_FOR_USER`	” users can only request verification”
400	`KYC_TEMPLATE_NOT_CONFIGURED_ERROR`	”KYC template not configured for “
404	`NOT_FOUND_ERROR`	”Requested User was not found”
500	`INTERNAL_SERVER_ERROR`	”Failed to create verification link”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Path Parameters

userId

string

required

The user ID

Body

application/json

country

enum<string>

required

The country code for the partner

@description The country must be a valid ISO 3166-1 alpha-2 country code, see: @link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Available options:

MX,

DO,

US,

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

CH,

GB,

MC,

SM,

AD,

VA

Example:

"MX"

partnerRedirectUri

string

The redirect URI for the partner to redirect the user after the KYC process is completed

Response

KYC verification link generated successfully. Returns the URL the user must visit to complete verification.

success

boolean

Example:

true

data

object

Show child attributes

​Important Notes

​Use Cases

​Error Codes

​Common Errors

​User Ownership Errors

​Endpoint-Specific Errors

Authorizations

Path Parameters

Body

Response

Important Notes

Use Cases

Error Codes

Common Errors

User Ownership Errors

Endpoint-Specific Errors