Generate KYC token
curl --request POST \
--url https://ivs.idenfy.com/api/v2/token \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": false,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": [
"<string>"
],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": true,
"reviewSuccessful": true,
"reviewFailed": true,
"questionnaire": "<string>",
"questionnaireRequired": true,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": [
"<string>"
],
"verifyEmail": true,
"verifyPhone": true,
"verifyBank": true,
"verifyBankAccounts": true,
"verifyBankBalances": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"verifyAddress": true,
"checkAml": true,
"checkCriminal": true,
"checkLiveness": true,
"checkFaceBlacklist": true,
"checkDocFaceBlacklist": true,
"checkPersonBlacklist": true,
"checkDuplicateFaces": true,
"checkDuplicateDocFaces": true,
"checkDuplicatePersonalData": true,
"checkDriverLicense": true,
"checkLid": true,
"checkIpProxy": true,
"allowBsnMasking": true,
"nfcRequired": true,
"autoAmlMonitoring": true,
"driverLicenseBack": true,
"faceMatchingThresholdModifier": 123,
"additionalSteps": {},
"additionalData": {},
"utilityBill": true,
"nfcOptional": true,
"ageLimit": 123,
"ageMax": 123
}
'import requests
url = "https://ivs.idenfy.com/api/v2/token"
payload = {
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": False,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": ["<string>"],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": True,
"reviewSuccessful": True,
"reviewFailed": True,
"questionnaire": "<string>",
"questionnaireRequired": True,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": ["<string>"],
"verifyEmail": True,
"verifyPhone": True,
"verifyBank": True,
"verifyBankAccounts": True,
"verifyBankBalances": True,
"verifyBankTransactions": True,
"bankCardVerification": True,
"bankCardPdfUpload": True,
"verifyAddress": True,
"checkAml": True,
"checkCriminal": True,
"checkLiveness": True,
"checkFaceBlacklist": True,
"checkDocFaceBlacklist": True,
"checkPersonBlacklist": True,
"checkDuplicateFaces": True,
"checkDuplicateDocFaces": True,
"checkDuplicatePersonalData": True,
"checkDriverLicense": True,
"checkLid": True,
"checkIpProxy": True,
"allowBsnMasking": True,
"nfcRequired": True,
"autoAmlMonitoring": True,
"driverLicenseBack": True,
"faceMatchingThresholdModifier": 123,
"additionalSteps": {},
"additionalData": {},
"utilityBill": True,
"nfcOptional": True,
"ageLimit": 123,
"ageMax": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '<string>',
externalRef: '<string>',
generateDigitString: false,
expiryTime: 1296000,
locale: '<string>',
country: '<string>',
sessionLength: 1830,
documents: ['<string>'],
firstName: '<string>',
lastName: '<string>',
dateOfBirth: '2023-12-25',
nationality: '<string>',
documentNumber: '<string>',
personalNumber: '<string>',
dateOfExpiry: '2023-12-25',
dateOfIssue: '<string>',
address: '<string>',
successUrl: '<string>',
errorUrl: '<string>',
unverifiedUrl: '<string>',
callbackUrl: '<string>',
showInstructions: true,
reviewSuccessful: true,
reviewFailed: true,
questionnaire: '<string>',
questionnaireRequired: true,
riskAssessmentProfile: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
theme: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
registryCentersCountries: ['<string>'],
verifyEmail: true,
verifyPhone: true,
verifyBank: true,
verifyBankAccounts: true,
verifyBankBalances: true,
verifyBankTransactions: true,
bankCardVerification: true,
bankCardPdfUpload: true,
verifyAddress: true,
checkAml: true,
checkCriminal: true,
checkLiveness: true,
checkFaceBlacklist: true,
checkDocFaceBlacklist: true,
checkPersonBlacklist: true,
checkDuplicateFaces: true,
checkDuplicateDocFaces: true,
checkDuplicatePersonalData: true,
checkDriverLicense: true,
checkLid: true,
checkIpProxy: true,
allowBsnMasking: true,
nfcRequired: true,
autoAmlMonitoring: true,
driverLicenseBack: true,
faceMatchingThresholdModifier: 123,
additionalSteps: {},
additionalData: {},
utilityBill: true,
nfcOptional: true,
ageLimit: 123,
ageMax: 123
})
};
fetch('https://ivs.idenfy.com/api/v2/token', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/api/v2/token")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/api/v2/token",
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([
'clientId' => '<string>',
'externalRef' => '<string>',
'generateDigitString' => false,
'expiryTime' => 1296000,
'locale' => '<string>',
'country' => '<string>',
'sessionLength' => 1830,
'documents' => [
'<string>'
],
'firstName' => '<string>',
'lastName' => '<string>',
'dateOfBirth' => '2023-12-25',
'nationality' => '<string>',
'documentNumber' => '<string>',
'personalNumber' => '<string>',
'dateOfExpiry' => '2023-12-25',
'dateOfIssue' => '<string>',
'address' => '<string>',
'successUrl' => '<string>',
'errorUrl' => '<string>',
'unverifiedUrl' => '<string>',
'callbackUrl' => '<string>',
'showInstructions' => true,
'reviewSuccessful' => true,
'reviewFailed' => true,
'questionnaire' => '<string>',
'questionnaireRequired' => true,
'riskAssessmentProfile' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'theme' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'registryCentersCountries' => [
'<string>'
],
'verifyEmail' => true,
'verifyPhone' => true,
'verifyBank' => true,
'verifyBankAccounts' => true,
'verifyBankBalances' => true,
'verifyBankTransactions' => true,
'bankCardVerification' => true,
'bankCardPdfUpload' => true,
'verifyAddress' => true,
'checkAml' => true,
'checkCriminal' => true,
'checkLiveness' => true,
'checkFaceBlacklist' => true,
'checkDocFaceBlacklist' => true,
'checkPersonBlacklist' => true,
'checkDuplicateFaces' => true,
'checkDuplicateDocFaces' => true,
'checkDuplicatePersonalData' => true,
'checkDriverLicense' => true,
'checkLid' => true,
'checkIpProxy' => true,
'allowBsnMasking' => true,
'nfcRequired' => true,
'autoAmlMonitoring' => true,
'driverLicenseBack' => true,
'faceMatchingThresholdModifier' => 123,
'additionalSteps' => [
],
'additionalData' => [
],
'utilityBill' => true,
'nfcOptional' => true,
'ageLimit' => 123,
'ageMax' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/api/v2/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/api/v2/token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/api/v2/token"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/api/v2/token")
.post(body)
.addHeader("Authorization", "Basic <encoded-value>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()import Foundation
let parameters = [
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": false,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": ["<string>"],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": true,
"reviewSuccessful": true,
"reviewFailed": true,
"questionnaire": "<string>",
"questionnaireRequired": true,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": ["<string>"],
"verifyEmail": true,
"verifyPhone": true,
"verifyBank": true,
"verifyBankAccounts": true,
"verifyBankBalances": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"verifyAddress": true,
"checkAml": true,
"checkCriminal": true,
"checkLiveness": true,
"checkFaceBlacklist": true,
"checkDocFaceBlacklist": true,
"checkPersonBlacklist": true,
"checkDuplicateFaces": true,
"checkDuplicateDocFaces": true,
"checkDuplicatePersonalData": true,
"checkDriverLicense": true,
"checkLid": true,
"checkIpProxy": true,
"allowBsnMasking": true,
"nfcRequired": true,
"autoAmlMonitoring": true,
"driverLicenseBack": true,
"faceMatchingThresholdModifier": 123,
"additionalSteps": [],
"additionalData": [],
"utilityBill": true,
"nfcOptional": true,
"ageLimit": 123,
"ageMax": 123
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://ivs.idenfy.com/api/v2/token")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self)){
"authToken": "<string>",
"scanRef": "<string>",
"tokenType": "IDENTIFICATION",
"message": "<string>",
"redirectUrl": "<string>",
"clientId": "<string>",
"personScanRef": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"locale": "<string>",
"country": "<string>",
"expiryTime": 123,
"sessionLength": 123,
"documents": [
"<string>"
],
"allowedDocuments": {},
"dateOfBirth": "<string>",
"dateOfExpiry": "<string>",
"dateOfIssue": "<string>",
"nationality": "<string>",
"personalNumber": "<string>",
"documentNumber": "<string>",
"sex": "<string>",
"address": "<string>",
"showInstructions": true,
"utilityBill": null,
"additionalSteps": {},
"additionalData": {},
"externalRef": "<string>",
"questionnaire": "<string>",
"registryCentersCountries": [
"<string>"
],
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowBsnMasking": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"checkLid": true,
"checkDriverLicense": true,
"verifyAddress": true,
"checkFaceBlacklist": true,
"verifyEmail": true,
"checkPersonBlacklist": true,
"checkDuplicateDocFaces": true,
"reviewSuccessful": true,
"reviewFailed": true,
"verifyBank": true,
"autoAmlMonitoring": true,
"verifyPhone": true,
"faceMatchingThresholdModifier": 123,
"checkCriminal": true,
"checkAml": true,
"checkDuplicateFaces": true,
"driverLicenseBack": true,
"verifyBankAccounts": true,
"checkDuplicatePersonalData": true,
"verifyBankBalances": true,
"nfcRequired": true,
"checkIpProxy": true,
"checkDocFaceBlacklist": true,
"checkLiveness": true,
"digitString": "<string>"
}Generate KYC token
Creates a KYC verification session token. Pass the returned authToken to your frontend or SDK to launch the verification flow.
POST
/
api
/
v2
/
token
Generate KYC token
curl --request POST \
--url https://ivs.idenfy.com/api/v2/token \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": false,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": [
"<string>"
],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": true,
"reviewSuccessful": true,
"reviewFailed": true,
"questionnaire": "<string>",
"questionnaireRequired": true,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": [
"<string>"
],
"verifyEmail": true,
"verifyPhone": true,
"verifyBank": true,
"verifyBankAccounts": true,
"verifyBankBalances": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"verifyAddress": true,
"checkAml": true,
"checkCriminal": true,
"checkLiveness": true,
"checkFaceBlacklist": true,
"checkDocFaceBlacklist": true,
"checkPersonBlacklist": true,
"checkDuplicateFaces": true,
"checkDuplicateDocFaces": true,
"checkDuplicatePersonalData": true,
"checkDriverLicense": true,
"checkLid": true,
"checkIpProxy": true,
"allowBsnMasking": true,
"nfcRequired": true,
"autoAmlMonitoring": true,
"driverLicenseBack": true,
"faceMatchingThresholdModifier": 123,
"additionalSteps": {},
"additionalData": {},
"utilityBill": true,
"nfcOptional": true,
"ageLimit": 123,
"ageMax": 123
}
'import requests
url = "https://ivs.idenfy.com/api/v2/token"
payload = {
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": False,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": ["<string>"],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": True,
"reviewSuccessful": True,
"reviewFailed": True,
"questionnaire": "<string>",
"questionnaireRequired": True,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": ["<string>"],
"verifyEmail": True,
"verifyPhone": True,
"verifyBank": True,
"verifyBankAccounts": True,
"verifyBankBalances": True,
"verifyBankTransactions": True,
"bankCardVerification": True,
"bankCardPdfUpload": True,
"verifyAddress": True,
"checkAml": True,
"checkCriminal": True,
"checkLiveness": True,
"checkFaceBlacklist": True,
"checkDocFaceBlacklist": True,
"checkPersonBlacklist": True,
"checkDuplicateFaces": True,
"checkDuplicateDocFaces": True,
"checkDuplicatePersonalData": True,
"checkDriverLicense": True,
"checkLid": True,
"checkIpProxy": True,
"allowBsnMasking": True,
"nfcRequired": True,
"autoAmlMonitoring": True,
"driverLicenseBack": True,
"faceMatchingThresholdModifier": 123,
"additionalSteps": {},
"additionalData": {},
"utilityBill": True,
"nfcOptional": True,
"ageLimit": 123,
"ageMax": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: '<string>',
externalRef: '<string>',
generateDigitString: false,
expiryTime: 1296000,
locale: '<string>',
country: '<string>',
sessionLength: 1830,
documents: ['<string>'],
firstName: '<string>',
lastName: '<string>',
dateOfBirth: '2023-12-25',
nationality: '<string>',
documentNumber: '<string>',
personalNumber: '<string>',
dateOfExpiry: '2023-12-25',
dateOfIssue: '<string>',
address: '<string>',
successUrl: '<string>',
errorUrl: '<string>',
unverifiedUrl: '<string>',
callbackUrl: '<string>',
showInstructions: true,
reviewSuccessful: true,
reviewFailed: true,
questionnaire: '<string>',
questionnaireRequired: true,
riskAssessmentProfile: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
theme: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
registryCentersCountries: ['<string>'],
verifyEmail: true,
verifyPhone: true,
verifyBank: true,
verifyBankAccounts: true,
verifyBankBalances: true,
verifyBankTransactions: true,
bankCardVerification: true,
bankCardPdfUpload: true,
verifyAddress: true,
checkAml: true,
checkCriminal: true,
checkLiveness: true,
checkFaceBlacklist: true,
checkDocFaceBlacklist: true,
checkPersonBlacklist: true,
checkDuplicateFaces: true,
checkDuplicateDocFaces: true,
checkDuplicatePersonalData: true,
checkDriverLicense: true,
checkLid: true,
checkIpProxy: true,
allowBsnMasking: true,
nfcRequired: true,
autoAmlMonitoring: true,
driverLicenseBack: true,
faceMatchingThresholdModifier: 123,
additionalSteps: {},
additionalData: {},
utilityBill: true,
nfcOptional: true,
ageLimit: 123,
ageMax: 123
})
};
fetch('https://ivs.idenfy.com/api/v2/token', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/api/v2/token")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/api/v2/token",
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([
'clientId' => '<string>',
'externalRef' => '<string>',
'generateDigitString' => false,
'expiryTime' => 1296000,
'locale' => '<string>',
'country' => '<string>',
'sessionLength' => 1830,
'documents' => [
'<string>'
],
'firstName' => '<string>',
'lastName' => '<string>',
'dateOfBirth' => '2023-12-25',
'nationality' => '<string>',
'documentNumber' => '<string>',
'personalNumber' => '<string>',
'dateOfExpiry' => '2023-12-25',
'dateOfIssue' => '<string>',
'address' => '<string>',
'successUrl' => '<string>',
'errorUrl' => '<string>',
'unverifiedUrl' => '<string>',
'callbackUrl' => '<string>',
'showInstructions' => true,
'reviewSuccessful' => true,
'reviewFailed' => true,
'questionnaire' => '<string>',
'questionnaireRequired' => true,
'riskAssessmentProfile' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'theme' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'registryCentersCountries' => [
'<string>'
],
'verifyEmail' => true,
'verifyPhone' => true,
'verifyBank' => true,
'verifyBankAccounts' => true,
'verifyBankBalances' => true,
'verifyBankTransactions' => true,
'bankCardVerification' => true,
'bankCardPdfUpload' => true,
'verifyAddress' => true,
'checkAml' => true,
'checkCriminal' => true,
'checkLiveness' => true,
'checkFaceBlacklist' => true,
'checkDocFaceBlacklist' => true,
'checkPersonBlacklist' => true,
'checkDuplicateFaces' => true,
'checkDuplicateDocFaces' => true,
'checkDuplicatePersonalData' => true,
'checkDriverLicense' => true,
'checkLid' => true,
'checkIpProxy' => true,
'allowBsnMasking' => true,
'nfcRequired' => true,
'autoAmlMonitoring' => true,
'driverLicenseBack' => true,
'faceMatchingThresholdModifier' => 123,
'additionalSteps' => [
],
'additionalData' => [
],
'utilityBill' => true,
'nfcOptional' => true,
'ageLimit' => 123,
'ageMax' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/api/v2/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/api/v2/token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/api/v2/token"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"clientId\": \"<string>\",\n \"externalRef\": \"<string>\",\n \"generateDigitString\": false,\n \"expiryTime\": 1296000,\n \"locale\": \"<string>\",\n \"country\": \"<string>\",\n \"sessionLength\": 1830,\n \"documents\": [\n \"<string>\"\n ],\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"nationality\": \"<string>\",\n \"documentNumber\": \"<string>\",\n \"personalNumber\": \"<string>\",\n \"dateOfExpiry\": \"2023-12-25\",\n \"dateOfIssue\": \"<string>\",\n \"address\": \"<string>\",\n \"successUrl\": \"<string>\",\n \"errorUrl\": \"<string>\",\n \"unverifiedUrl\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"showInstructions\": true,\n \"reviewSuccessful\": true,\n \"reviewFailed\": true,\n \"questionnaire\": \"<string>\",\n \"questionnaireRequired\": true,\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"theme\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"registryCentersCountries\": [\n \"<string>\"\n ],\n \"verifyEmail\": true,\n \"verifyPhone\": true,\n \"verifyBank\": true,\n \"verifyBankAccounts\": true,\n \"verifyBankBalances\": true,\n \"verifyBankTransactions\": true,\n \"bankCardVerification\": true,\n \"bankCardPdfUpload\": true,\n \"verifyAddress\": true,\n \"checkAml\": true,\n \"checkCriminal\": true,\n \"checkLiveness\": true,\n \"checkFaceBlacklist\": true,\n \"checkDocFaceBlacklist\": true,\n \"checkPersonBlacklist\": true,\n \"checkDuplicateFaces\": true,\n \"checkDuplicateDocFaces\": true,\n \"checkDuplicatePersonalData\": true,\n \"checkDriverLicense\": true,\n \"checkLid\": true,\n \"checkIpProxy\": true,\n \"allowBsnMasking\": true,\n \"nfcRequired\": true,\n \"autoAmlMonitoring\": true,\n \"driverLicenseBack\": true,\n \"faceMatchingThresholdModifier\": 123,\n \"additionalSteps\": {},\n \"additionalData\": {},\n \"utilityBill\": true,\n \"nfcOptional\": true,\n \"ageLimit\": 123,\n \"ageMax\": 123\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/api/v2/token")
.post(body)
.addHeader("Authorization", "Basic <encoded-value>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()import Foundation
let parameters = [
"clientId": "<string>",
"externalRef": "<string>",
"generateDigitString": false,
"expiryTime": 1296000,
"locale": "<string>",
"country": "<string>",
"sessionLength": 1830,
"documents": ["<string>"],
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "2023-12-25",
"nationality": "<string>",
"documentNumber": "<string>",
"personalNumber": "<string>",
"dateOfExpiry": "2023-12-25",
"dateOfIssue": "<string>",
"address": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"showInstructions": true,
"reviewSuccessful": true,
"reviewFailed": true,
"questionnaire": "<string>",
"questionnaireRequired": true,
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCentersCountries": ["<string>"],
"verifyEmail": true,
"verifyPhone": true,
"verifyBank": true,
"verifyBankAccounts": true,
"verifyBankBalances": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"verifyAddress": true,
"checkAml": true,
"checkCriminal": true,
"checkLiveness": true,
"checkFaceBlacklist": true,
"checkDocFaceBlacklist": true,
"checkPersonBlacklist": true,
"checkDuplicateFaces": true,
"checkDuplicateDocFaces": true,
"checkDuplicatePersonalData": true,
"checkDriverLicense": true,
"checkLid": true,
"checkIpProxy": true,
"allowBsnMasking": true,
"nfcRequired": true,
"autoAmlMonitoring": true,
"driverLicenseBack": true,
"faceMatchingThresholdModifier": 123,
"additionalSteps": [],
"additionalData": [],
"utilityBill": true,
"nfcOptional": true,
"ageLimit": 123,
"ageMax": 123
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://ivs.idenfy.com/api/v2/token")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self)){
"authToken": "<string>",
"scanRef": "<string>",
"tokenType": "IDENTIFICATION",
"message": "<string>",
"redirectUrl": "<string>",
"clientId": "<string>",
"personScanRef": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"successUrl": "<string>",
"errorUrl": "<string>",
"unverifiedUrl": "<string>",
"callbackUrl": "<string>",
"locale": "<string>",
"country": "<string>",
"expiryTime": 123,
"sessionLength": 123,
"documents": [
"<string>"
],
"allowedDocuments": {},
"dateOfBirth": "<string>",
"dateOfExpiry": "<string>",
"dateOfIssue": "<string>",
"nationality": "<string>",
"personalNumber": "<string>",
"documentNumber": "<string>",
"sex": "<string>",
"address": "<string>",
"showInstructions": true,
"utilityBill": null,
"additionalSteps": {},
"additionalData": {},
"externalRef": "<string>",
"questionnaire": "<string>",
"registryCentersCountries": [
"<string>"
],
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"theme": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"allowBsnMasking": true,
"verifyBankTransactions": true,
"bankCardVerification": true,
"bankCardPdfUpload": true,
"checkLid": true,
"checkDriverLicense": true,
"verifyAddress": true,
"checkFaceBlacklist": true,
"verifyEmail": true,
"checkPersonBlacklist": true,
"checkDuplicateDocFaces": true,
"reviewSuccessful": true,
"reviewFailed": true,
"verifyBank": true,
"autoAmlMonitoring": true,
"verifyPhone": true,
"faceMatchingThresholdModifier": 123,
"checkCriminal": true,
"checkAml": true,
"checkDuplicateFaces": true,
"driverLicenseBack": true,
"verifyBankAccounts": true,
"checkDuplicatePersonalData": true,
"verifyBankBalances": true,
"nfcRequired": true,
"checkIpProxy": true,
"checkDocFaceBlacklist": true,
"checkLiveness": true,
"digitString": "<string>"
}Authorizations
The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.
Body
application/json
A unique string identifying the client on your side.
Maximum string length:
100IDENTIFICATION— document scan + selfie (default)DOCUMENT— document scan only
Available options:
IDENTIFICATION, DOCUMENT Optional internal reference. Returned as-is in webhooks.
Maximum string length:
40If true, generates an 8-digit mobile app code returned as digitString.
Token validity in seconds. Maximum 2,592,000 (30 days).
Required range:
0 <= x <= 2592000UI language code (e.g. en, de, ko).
Maximum string length:
7Restrict accepted document-issuing country (ISO alpha-2).
Seconds the user has to complete verification once started.
Required range:
60 <= x <= 3600Restrict accepted document types (e.g. PASSPORT, ID_CARD).
Pre-fill client first name. Mismatch triggers SUSPECTED status.
Maximum string length:
100Pre-fill client last name. Mismatch triggers SUSPECTED status.
Maximum string length:
100Pre-fill client date of birth.
Pre-fill client nationality.
Pre-fill document number.
Maximum string length:
50Pre-fill personal/national ID number.
Maximum string length:
50Pre-fill client sex.
Available options:
M, F Pre-fill document expiry date.
Pre-fill document issue date.
Client address for Proof of Address verification.
Redirect URL on successful verification.
Redirect URL on failed verification.
Redirect URL when verification result is unverified.
Override webhook callback URL for this session only.
Enable manual review for successful verifications.
Enable manual review for failed verifications.
Questionnaire key for this session. Pass null to disable.
UUID of the KYC branding theme for this session. If omitted, the theme marked as default in the dashboard is applied.
Request extra document steps. See Additional Steps documentation.
Data for COMPARE-type additional steps.
Minimum required age. Below this triggers SUSPECTED status.
Maximum allowed age. Above this triggers SUSPECTED status.
Response
201 - application/json
Token created successfully.
Pass this to the frontend, SDK, or redirect URL to start verification.
Unique session ID. Store this to correlate with webhook results.
Available options:
IDENTIFICATION, DOCUMENT Direct URL to the hosted verification flow. Redirect the user here or embed in an iFrame.
Token expiry time in seconds.
Show child attributes
Show child attributes
8-digit mobile code. Only present when generateDigitString was true.
Was this page helpful?