cURL
curl --request POST \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "075986f3-282b-4555-bfcd-fad973e32596",
"redirect_url": "https://yourapp.com/kyc/return"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link"
payload = {
"customer_id": "075986f3-282b-4555-bfcd-fad973e32596",
"redirect_url": "https://yourapp.com/kyc/return"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_id: '075986f3-282b-4555-bfcd-fad973e32596',
redirect_url: 'https://yourapp.com/kyc/return'
})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/generate-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://sandbox.zapyd.com/cms/api/v1/kyc/generate-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([
'customer_id' => '075986f3-282b-4555-bfcd-fad973e32596',
'redirect_url' => 'https://yourapp.com/kyc/return'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <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://sandbox.zapyd.com/cms/api/v1/kyc/generate-link"
payload := strings.NewReader("{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<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://sandbox.zapyd.com/cms/api/v1/kyc/generate-link")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"url": "https://app.zapyd.com/kyc?kyc_id=977c8923-3818-4880-bfbf-65436635ea91",
"is_mocked": true
}
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later."
}KYC
Generate KYC Link
Generates a hosted KYC link for a customer. US customers complete KYC only through this link.
POST
/
kyc
/
generate-link
cURL
curl --request POST \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "075986f3-282b-4555-bfcd-fad973e32596",
"redirect_url": "https://yourapp.com/kyc/return"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link"
payload = {
"customer_id": "075986f3-282b-4555-bfcd-fad973e32596",
"redirect_url": "https://yourapp.com/kyc/return"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_id: '075986f3-282b-4555-bfcd-fad973e32596',
redirect_url: 'https://yourapp.com/kyc/return'
})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/generate-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://sandbox.zapyd.com/cms/api/v1/kyc/generate-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([
'customer_id' => '075986f3-282b-4555-bfcd-fad973e32596',
'redirect_url' => 'https://yourapp.com/kyc/return'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <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://sandbox.zapyd.com/cms/api/v1/kyc/generate-link"
payload := strings.NewReader("{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<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://sandbox.zapyd.com/cms/api/v1/kyc/generate-link")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/generate-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"075986f3-282b-4555-bfcd-fad973e32596\",\n \"redirect_url\": \"https://yourapp.com/kyc/return\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"url": "https://app.zapyd.com/kyc?kyc_id=977c8923-3818-4880-bfbf-65436635ea91",
"is_mocked": true
}
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later."
}Error Codes and Messages
| API Status Code | Response | Reason |
|---|---|---|
| 400 | Customer not found or access denied | Customer not found |
| 400 | Customer not found or access denied | Customer does not belong to the organization |
| 400 | Bad Request | Request validation failed (e.g. invalid customer_id format) |
| 400 | Bad Request | Customer is not eligible to generate a KYC link in their current state |
| 500 | Internal Server Error | Internal Server Error |
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
Zapyd customer ID (UUID) returned by Create Customer.
Example:
"075986f3-282b-4555-bfcd-fad973e32596"
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"
⌘I