Initiate a KYC submission

POST /kyc/kyc

Parameters

vendorId string Required

No description.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

countryName string

No description.

countryCode string

No description.

documentCountry string

No description.

identityDocumentFrontPage string

No description.

identityDocumentBackPage string

No description.

identityDocumentType enum

No description.

Possible values: passportnational_iddriver_license

faceScan string

No description.

proofOfResidence string

No description.

residenceDocumentType enum

No description.

Possible values: gas_billbank_statementelectricity_billinternet_billrent_agreement

contactNumber string

No description.

contactEmail string

No description.

vendorData object

No description.

vendor enum

No description.

Possible values: veriffnexeramanual

submissionCompleted boolean

No description.

verificationStatus enum

No description.

Possible values: pendingapprovedresubmissionrejected

reason string

No description.

curl -X POST "https://heimdall.qa.zoniqx.com/kyc/kyc" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "countryName": "string", "countryCode": "string", "documentCountry": "string", "identityDocumentFrontPage": "string", "identityDocumentBackPage": "string", "identityDocumentType": "passport", "faceScan": "string", "proofOfResidence": "string", "residenceDocumentType": "gas_bill", "contactNumber": "string", "contactEmail": "user@example.com", "vendorData": { "person": { "lastName": "string", "firstName": "string", "dateOfBirth": "string", "nationality": "string", "yearOfBirth": "string", "placeOfBirth": "string" }, "status": "string", "vendorData": "string", "decisionTime": "string", "acceptanceTime": "string", "anka": { "declarations": {}, "signerAddress": "string", "walletSignature": "string", "signedMessage": "string", "signedFormDocumentId": "string", "digitalSignatureFileId": "string" } }, "vendor": "veriff", "submissionCompleted": false, "verificationStatus": "pending", "reason": "string", "vendorId": "string" }'

const response = await fetch("https://heimdall.qa.zoniqx.com/kyc/kyc", { method: "POST", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "countryName": "string", "countryCode": "string", "documentCountry": "string", "identityDocumentFrontPage": "string", "identityDocumentBackPage": "string", "identityDocumentType": "passport", "faceScan": "string", "proofOfResidence": "string", "residenceDocumentType": "gas_bill", "contactNumber": "string", "contactEmail": "user@example.com", "vendorData": { "person": { "lastName": "string", "firstName": "string", "dateOfBirth": "string", "nationality": "string", "yearOfBirth": "string", "placeOfBirth": "string" }, "status": "string", "vendorData": "string", "decisionTime": "string", "acceptanceTime": "string", "anka": { "declarations": {}, "signerAddress": "string", "walletSignature": "string", "signedMessage": "string", "signedFormDocumentId": "string", "digitalSignatureFileId": "string" } }, "vendor": "veriff", "submissionCompleted": false, "verificationStatus": "pending", "reason": "string", "vendorId": "string" }), }); const data = await response.json();

type KycController_createKycResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/kyc/kyc", { method: "POST", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "countryName": "string", "countryCode": "string", "documentCountry": "string", "identityDocumentFrontPage": "string", "identityDocumentBackPage": "string", "identityDocumentType": "passport", "faceScan": "string", "proofOfResidence": "string", "residenceDocumentType": "gas_bill", "contactNumber": "string", "contactEmail": "user@example.com", "vendorData": { "person": { "lastName": "string", "firstName": "string", "dateOfBirth": "string", "nationality": "string", "yearOfBirth": "string", "placeOfBirth": "string" }, "status": "string", "vendorData": "string", "decisionTime": "string", "acceptanceTime": "string", "anka": { "declarations": {}, "signerAddress": "string", "walletSignature": "string", "signedMessage": "string", "signedFormDocumentId": "string", "digitalSignatureFileId": "string" } }, "vendor": "veriff", "submissionCompleted": false, "verificationStatus": "pending", "reason": "string", "vendorId": "string" }), }); const data: KycController_createKycResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/kyc/kyc" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "countryName": "string", "countryCode": "string", "documentCountry": "string", "identityDocumentFrontPage": "string", "identityDocumentBackPage": "string", "identityDocumentType": "passport", "faceScan": "string", "proofOfResidence": "string", "residenceDocumentType": "gas_bill", "contactNumber": "string", "contactEmail": "user@example.com", "vendorData": { "person": { "lastName": "string", "firstName": "string", "dateOfBirth": "string", "nationality": "string", "yearOfBirth": "string", "placeOfBirth": "string" }, "status": "string", "vendorData": "string", "decisionTime": "string", "acceptanceTime": "string", "anka": { "declarations": {}, "signerAddress": "string", "walletSignature": "string", "signedMessage": "string", "signedFormDocumentId": "string", "digitalSignatureFileId": "string" } }, "vendor": "veriff", "submissionCompleted": False, "verificationStatus": "pending", "reason": "string", "vendorId": "string" } response = requests.post(url, headers=headers, json=payload) data = response.json()