zyphe-sdk (1.9.1)

Download OpenAPI specification:Download

License:

SDK: Verification Requests

Create a verification request

Authorizations:

x-api-key

path Parameters

flow_id

required

string <uuid>

Example: 123e4567-e89b-12d3-a456-426614174000

Flow ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Request Body schema: application/json
required

	Array of any (VerificationIdentifierCredential) Credentials to enable for this identity (e.g. wallet, magic-link). The first `Wallet` entry determines the `zid`; all entries are provisioned on identity creation.
email	string or null Email address of the user. Used for notifications and as the `zid` when no wallet credential is provided.
	object or null Arbitrary key-value metadata to attach to this verification request.

Responses

Request samples

Payload

Content type

application/json

{"credentials": [{"address": "string",
"chain": "ETHEREUM",
"type": "WALLET"
}
],
"email": "string",
"customData": {"property1": null,
"property2": null
}
}

Response samples

Content type

application/json

{"email": "string",
"flowSlug": "string",
"flowStepSlug": "string",
"isSandbox": true,
"verificationRequest": {"amlResult": {"adverseMedia": true,
"createdAt": "2019-08-24T14:15:22Z",
"data": {"entities": [{"entity": {"address": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthCountry": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthDate": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthPlace": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"country": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"email": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"firstName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"gender": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"lastName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"match": true,
"middleName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"name": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"nationality": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"occupancies": [{"endDate": {"controls": [ ],
"value": [ ]
},
"post": [null
],
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
}
}
],
"phone": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"position": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"sanctions": [{"authority": {"controls": [ ],
"value": [ ]
},
"authorityId": {"controls": [ ],
"value": [ ]
},
"country": {"controls": [ ],
"value": [ ]
},
"date": {"controls": [ ],
"value": [ ]
},
"duration": {"controls": [ ],
"value": [ ]
},
"endDate": {"controls": [ ],
"value": [ ]
},
"listingDate": {"controls": [ ],
"value": [ ]
},
"program": {"controls": [ ],
"value": [ ]
},
"reason": {"controls": [ ],
"value": [ ]
},
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
},
"unscId": {"controls": [ ],
"value": [ ]
}
}
],
"score": 0.1,
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"title": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"topics": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
}
},
"hasSanctions": true,
"isPep": true,
"match": true,
"matchScore": 0.1,
"riskCountries": ["string"
],
"riskPositions": ["string"
],
"riskRelationships": ["string"
],
"riskScore": {"riskLevel": "low",
"riskScorePercent": 0,
"sourcesCount": 0
},
"riskTopics": ["string"
]
}
],
"metadata": {"adverseMedia": {"articles": [{"eventGroup": "string",
"language": "string",
"locations": ["string"
],
"publishedDate": "2019-08-24T14:15:22Z",
"relevanceScore": 0.1,
"snippet": "string",
"source": "string",
"title": "string",
"topics": ["string"
],
"url": "string"
}
],
"checkedAt": "2019-08-24T14:15:22Z",
"hasHit": true,
"provider": "VERIFY",
"totalArticleCount": 0,
"totalEventCount": 0
},
"agentReview": {"enactedAction": "approve",
"policyVersion": "string",
"rationale": "string",
"residualRiskScore": 0.1,
"reviewedAt": "2019-08-24T14:15:22Z",
"suggested": true,
"verdictAction": "approve"
},
"checkedAt": "2019-08-24T14:15:22Z",
"companyQuery": {"companyName": "string",
"country": "string",
"registrationNumber": "string"
},
"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"approve": {"reason": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"moderation": "approved",
"query": {"dateOfBirth": "string",
"firstName": "string",
"lastName": "string"
},
"summary": {"hasAdverseMedia": true,
"hasPep": true,
"hasSanctions": true,
"highRiskEntitiesCount": 0,
"highestRiskLevel": "low",
"highestRiskScore": 0,
"totalEntities": 0
}
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"namedPersonRef": "6ed4ea79-b112-45b5-9a50-00e9a2825e1e",
"pep": true,
"sanctions": true,
"subjectType": "PERSON",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"attemptsCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customData": {"property1": null,
"property2": null
},
"dvResult": {"adminComment": "string",
"authenticityChecks": [[0
]
],
"browser": "string",
"class": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"data": {"property1": null,
"property2": null
},
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentScorePercent": 0,
"documentType": 0,
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"manualReviewAt": "2019-08-24T14:15:22Z",
"manualReviewNote": "string",
"manualReviewerId": "e044d43f-3a8b-43af-9b7a-95b2095b0b64",
"manualReviewerZid": "string",
"originalVrHistoryId": "e3407d54-5658-4ad1-a0d4-2133b69a753a",
"platform": "string",
"portraitMatchPercent": 0,
"processAdditionalData": {"autoOneClickKycData": {"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb"
},
"biometricCheckData": null,
"documentExpiredWebhookSentAt": "2019-08-24",
"imageQuality": [{"checkType": "glare",
"probability": 0,
"result": "passed"
}
],
"rawLivenessData": null,
"securityChecks": {"property1": "string",
"property2": "string"
},
"status": {"documentType": "passed",
"expiry": "passed",
"mrz": "passed",
"overall": "passed"
}
},
"provinceCode": "string",
"reasons": ["UNKNOWN"
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"validUntil": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"formResult": {"assignedRiskTags": [{"addedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removedAt": "2019-08-24T14:15:22Z",
"source": {"by": "6d5a269d-39eb-437d-afdb-2080c51fa5fc",
"kind": "manual"
},
"tag": "string",
"weight": 0.1
}
],
"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"form": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"sections": [{"items": [{"content": {"label": {"property1": null,
"property2": null
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [ ],
"tags": [ ]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z"
},
"formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"riskFactorKeys": ["string"
],
"sections": [{"items": [{"content": {"label": {"property1": "string",
"property2": "string"
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [null
],
"tags": [null
]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"geolocationResult": {"blacklistedIp": true,
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceFingerprint": "string",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ipAddress": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"vpn": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity": {"createdAt": "2019-08-24T14:15:22Z",
"defaultOrganizationId": "b8c6d7f2-93a8-47a9-a281-9086316be7e8",
"email": "string",
"emailVerified": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isActive": true,
"role": "ANONYMOUS",
"settings": {"lastEnvironmentIsSandbox": true,
"locale": "en"
},
"updatedAt": "2019-08-24T14:15:22Z",
"zid": "string"
},
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"kybResult": {"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"phoneResult": {"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"phoneNumberE164": "string",
"phoneNumberLast4": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"poaResult": {"checkedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentType": "PAY_SLIP",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"reason": "string",
"replayerZid": "string",
"spidResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z",
"walletResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"message": "string",
"reason": "string",
"signature": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"walletAddress": "string",
"walletChain": "string"
}
},
"zid": "string",
"zypheAccessSig": "string",
"zypheToken": "string"
}

Get the next verification step

Authorizations:

x-api-key

path Parameters

flow_id

required

string <uuid>

Example: 123e4567-e89b-12d3-a456-426614174000

Flow ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier
email	string or null Email address of the user whose verification progress should be queried.
credentialType	string or null Enum: "PASSWORD" "MAGIC_LINK" "PASSKEY" "BOT_TOKEN" "WALLET" "EXTERNAL_ID" Credential type for wallet or external-ID based resolution (`WALLET` or `EXTERNAL_ID`).
chain	string or null Enum: "ETHEREUM" "ETHEREUM_TESTNET" "SOLANA" "SOLANA_TESTNET" Wallet chain. Required when `credentialType` is `WALLET`.
address	string or null Wallet address. Required when `credentialType` is `WALLET`.
externalId	string or null External identifier. Required when `credentialType` is `EXTERNAL_ID`.

Responses

Response samples

Content type

application/json

{"customData": {"property1": null,
"property2": null
},
"executedActions": [{"actionConfig": {"actionType": "setStatus",
"value": "REQUIRES_MANUAL_REVIEW"
},
"actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0"
}
],
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"isCompleted": true,
"nextStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Submits identity document images for document verification. Call this after `next-step` returns a document verification step.

Authorizations:

x-api-key

path Parameters

flow_id required	string <uuid> Flow ID
verification_request_id required	string <uuid> Verification Request ID

query Parameters

sandbox

boolean or null

Use sandbox environment

Request Body schema: application/json
required

allowedDocumentTypes	Array of integers <int64> [ items <int64 > ]
browser	string or null
countryCode required	string
forceDocumentType	integer or null <int64>
	Array of objects (InputImage) Images to process (base64-encoded, provider-agnostic format). Either images OR (session_token + interview_id) must be provided, not both.
interviewId	string or null Interview/session ID for session-based providers (e.g. Incode). If provided along with session_token, the backend will fetch results from the provider.
platform	string or null
provinceCode	string or null
sessionToken	string or null Session token for session-based providers (e.g. Incode JWT). If provided along with interview_id, the backend will fetch results from the provider.

Responses

Request samples

Payload

Content type

application/json

{"allowedDocumentTypes": [0
],
"browser": "string",
"countryCode": "string",
"forceDocumentType": 0,
"images": [{"pageIndex": "front",
"source": "string",
"value": "string"
}
],
"interviewId": "string",
"platform": "string",
"provinceCode": "string",
"sessionToken": "string"
}

Response samples

Content type

application/json

{"attemptsCount": 0,
"jobId": "string",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Retrieves the liveness challenge configuration for the current verification request. Use the returned data to present the liveness capture UI to the user.

Authorizations:

x-api-key

path Parameters

flow_id required	string <uuid> Flow ID
verification_request_id required	string <uuid> Verification Request ID

query Parameters

sandbox

boolean or null

Use sandbox environment

Responses

Response samples

Content type

application/json

No sample

Submits liveness capture data (selfie or video) for processing. Call this after completing the liveness challenge from `liveness-challenge`.

Authorizations:

x-api-key

path Parameters

flow_id required	string <uuid> Flow ID
verification_request_id required	string <uuid> Verification Request ID

query Parameters

sandbox

boolean or null

Use sandbox environment

Request Body schema: application/json
required

challengeId required	string <uuid>
movementImagesQuantity required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"challengeId": "007cfdcc-a46d-4340-a4c6-216ec2e4009c",
"movementImagesQuantity": 0
}

Response samples

Content type

application/json

{"jobId": "string",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Submits the user's document selection (country and document type) to complete the document selection step.

Call this after next-step returns a document-selection step, then call next-step again to proceed.

Authorizations:

x-api-key

path Parameters

flow_id required	string <uuid> Flow ID
verification_request_id required	string <uuid> Verification Request ID

query Parameters

sandbox

boolean or null

Use sandbox environment

Request Body schema: application/json
required

country	string or null ISO 3166-1 alpha-2 country code of the document to be verified (e.g. `"US"`, `"GB"`). Optional — omit to allow any country.
documentType	integer or null <int64> Numeric document type identifier. Optional — omit to allow any document type.

Responses

Request samples

Payload

Content type

application/json

{"country": "string",
"documentType": 0
}

Response samples

Content type

application/json

{"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

SDK: Organizations

List flow results

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
flow_slug required	string Flow slug to scope results to

query Parameters

	object (Pagination)
sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Responses

Response samples

Content type

application/json

{"page": [{"amlResults": [{"adverseMedia": true,
"createdAt": "2019-08-24T14:15:22Z",
"data": {"entities": [{"entity": {"address": {"controls": [ ],
"value": [ ]
},
"birthCountry": {"controls": [ ],
"value": [ ]
},
"birthDate": {"controls": [ ],
"value": [ ]
},
"birthPlace": {"controls": [ ],
"value": [ ]
},
"country": {"controls": [ ],
"value": [ ]
},
"email": {"controls": [ ],
"value": [ ]
},
"firstName": {"controls": [ ],
"value": [ ]
},
"gender": {"controls": [ ],
"value": [ ]
},
"lastName": {"controls": [ ],
"value": [ ]
},
"match": true,
"middleName": {"controls": [ ],
"value": [ ]
},
"name": {"controls": [ ],
"value": [ ]
},
"nationality": {"controls": [ ],
"value": [ ]
},
"occupancies": [null
],
"phone": {"controls": [ ],
"value": [ ]
},
"position": {"controls": [ ],
"value": [ ]
},
"sanctions": [null
],
"score": 0.1,
"sources": [null
],
"title": {"controls": [ ],
"value": [ ]
},
"topics": {"controls": [ ],
"value": [ ]
}
},
"hasSanctions": true,
"isPep": true,
"match": true,
"matchScore": 0.1,
"riskCountries": ["string"
],
"riskPositions": ["string"
],
"riskRelationships": ["string"
],
"riskScore": {"riskLevel": "low",
"riskScorePercent": 0,
"sourcesCount": 0
},
"riskTopics": ["string"
]
}
],
"metadata": {"adverseMedia": {"articles": [{"eventGroup": null,
"language": null,
"locations": [ ],
"publishedDate": null,
"relevanceScore": null,
"snippet": null,
"source": null,
"title": null,
"topics": [ ],
"url": null
}
],
"checkedAt": "2019-08-24T14:15:22Z",
"hasHit": true,
"provider": "VERIFY",
"totalArticleCount": 0,
"totalEventCount": 0
},
"agentReview": {"enactedAction": "approve",
"policyVersion": "string",
"rationale": "string",
"residualRiskScore": 0.1,
"reviewedAt": "2019-08-24T14:15:22Z",
"suggested": true,
"verdictAction": "approve"
},
"checkedAt": "2019-08-24T14:15:22Z",
"companyQuery": {"companyName": "string",
"country": "string",
"registrationNumber": "string"
},
"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"approve": { }
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"moderation": "approved",
"query": {"dateOfBirth": "string",
"firstName": "string",
"lastName": "string"
},
"summary": {"hasAdverseMedia": true,
"hasPep": true,
"hasSanctions": true,
"highRiskEntitiesCount": 0,
"highestRiskLevel": "low",
"highestRiskScore": 0,
"totalEntities": 0
}
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"namedPersonRef": "6ed4ea79-b112-45b5-9a50-00e9a2825e1e",
"pep": true,
"sanctions": true,
"subjectType": "PERSON",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"assignedRiskTags": [{"addedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removedAt": "2019-08-24T14:15:22Z",
"source": {"by": "6d5a269d-39eb-437d-afdb-2080c51fa5fc",
"kind": "manual"
},
"tag": "string",
"weight": 0.1
}
],
"createdAt": "2019-08-24T14:15:22Z",
"customData": {"property1": null,
"property2": null
},
"dvResults": [{"adminComment": "string",
"authenticityChecks": [[0
]
],
"browser": "string",
"class": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"data": {"property1": null,
"property2": null
},
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentScorePercent": 0,
"documentType": 0,
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"manualReviewAt": "2019-08-24T14:15:22Z",
"manualReviewNote": "string",
"manualReviewerId": "e044d43f-3a8b-43af-9b7a-95b2095b0b64",
"manualReviewerZid": "string",
"originalVrHistoryId": "e3407d54-5658-4ad1-a0d4-2133b69a753a",
"platform": "string",
"portraitMatchPercent": 0,
"processAdditionalData": {"autoOneClickKycData": {"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb"
},
"biometricCheckData": null,
"documentExpiredWebhookSentAt": "2019-08-24",
"imageQuality": [{"checkType": "glare",
"probability": 0,
"result": "passed"
}
],
"rawLivenessData": null,
"securityChecks": {"property1": "string",
"property2": "string"
},
"status": {"documentType": "passed",
"expiry": "passed",
"mrz": "passed",
"overall": "passed"
}
},
"provinceCode": "string",
"reasons": ["UNKNOWN"
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"validUntil": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"flow": {"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"jdm": {"edges": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
"targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
}
],
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": {"position": {"x": 0.1,
"y": 0.1
},
"property1": null,
"property2": null
},
"type": "START"
}
]
},
"name": "string",
"slug": "string",
"steps": [{"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"successUrl": "string",
"themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76",
"updatedAt": "2019-08-24T14:15:22Z",
"webhookUrl": "string"
},
"flowSlug": "string",
"formResults": [{"assignedRiskTags": [{"addedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removedAt": "2019-08-24T14:15:22Z",
"source": {"by": "6d5a269d-39eb-437d-afdb-2080c51fa5fc",
"kind": "manual"
},
"tag": "string",
"weight": 0.1
}
],
"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"form": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"sections": [{"items": [{"content": null,
"type": null
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z"
},
"formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"riskFactorKeys": ["string"
],
"sections": [{"items": [{"content": {"label": { },
"name": null,
"options": null,
"requiredWhen": null,
"risk": null,
"type": null,
"value": null,
"visibleWhen": null
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"geolocationResults": [{"blacklistedIp": true,
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceFingerprint": "string",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ipAddress": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"vpn": true
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity": {"createdAt": "2019-08-24T14:15:22Z",
"defaultOrganizationId": "b8c6d7f2-93a8-47a9-a281-9086316be7e8",
"email": "string",
"emailVerified": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isActive": true,
"role": "ANONYMOUS",
"settings": {"lastEnvironmentIsSandbox": true,
"locale": "en"
},
"updatedAt": "2019-08-24T14:15:22Z",
"zid": "string"
},
"jdmData": {"property1": {"data": {"amlPep": true,
"amlRiskScorePercent": 0,
"amlSanctions": true,
"dateOfExpiry": "2019-08-24T14:15:22Z",
"documentType": 0,
"issuingCountry": "string",
"livenessStatus": "PASSED",
"numberOfAttempts": 0,
"status": "PASSED",
"property1": true,
"property2": true
},
"type": "DV"
},
"property2": {"data": {"amlPep": true,
"amlRiskScorePercent": 0,
"amlSanctions": true,
"dateOfExpiry": "2019-08-24T14:15:22Z",
"documentType": 0,
"issuingCountry": "string",
"livenessStatus": "PASSED",
"numberOfAttempts": 0,
"status": "PASSED",
"property1": true,
"property2": true
},
"type": "DV"
}
},
"kybResults": [{"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"organization": {"address": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"creationSource": "SELF_SERVE",
"email": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"industry": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"registrationNumber": "string",
"settings": {"askPasskeyCreation": true,
"createdAt": "2019-08-24T14:15:22Z",
"delayFlowResults": true,
"emailNotifications": ["string"
],
"extendedWebhook": true,
"oneClickAlwaysRequestUnlockVault": true,
"published": true,
"skipSignedAccess": true,
"slackNotifications": ["string"
],
"telegramNotifications": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"webhookSecret": "string",
"webhookWithLegacy": true
},
"slug": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"website": "string"
},
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"phoneResults": [{"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"phoneNumberE164": "string",
"phoneNumberLast4": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"poaResults": [{"checkedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentType": "PAY_SLIP",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"reviewSuggestion": {"confidence": 0.1,
"suggestion": "approved"
},
"riskScorePercent": 0,
"spidResults": [{"createdAt": "2019-08-24T14:15:22Z",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}
],
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z",
"walletResults": [{"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"message": "string",
"reason": "string",
"signature": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"walletAddress": "string",
"walletChain": "string"
}
]
}
],
"totalCount": 0
}

SDK: KYB

Send a UBO KYC reminder

Sends (or re-sends) the KYC invitation email to a specific UBO on a KYB case, identified by their position in uboDefinitions. Use this to drive UBO outreach on demand — for example when automatic UBO KYC emails are disabled for the flow.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID
recipient_index required	integer >= 0 Index of the UBO to send the KYC email to, matching the order in uboDefinitions

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Responses

Response samples

Content type

application/json

{"enqueued": true
}

Add UBOs to a KYB case

Adds one or more ultimate beneficial owners to an existing KYB case and returns the updated KYB result.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Request Body schema: application/json
required

required

Array of objects (AddKybPersonInput)

Array

country required	string
dateOfBirth required	string
email	string or null When present, the person is sent a KYC invitation and must complete full KYC for the KYB to be approvable. When absent, the person is screened by name only (AML) and is not notified — a clean name-AML result is sufficient (and required) for that person.
firstName required	string
gender required	string
lastName required	string

Responses

Request samples

Payload

Content type

application/json

{"persons": [{"country": "string",
"dateOfBirth": "string",
"email": "string",
"firstName": "string",
"gender": "string",
"lastName": "string"
}
]
}

Response samples

Content type

application/json

{"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Remove a UBO from a KYB case

Removes an ultimate beneficial owner from a KYB case by their stable id and returns the updated KYB result.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID
person_id required	string <uuid> Stable id of the UBO to remove

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Responses

Response samples

Content type

application/json

{"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Add directors to a KYB case

Adds one or more directors to an existing KYB case and returns the updated KYB result.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Request Body schema: application/json
required

required

Array of objects (AddKybPersonInput)

Array

country required	string
dateOfBirth required	string
email	string or null When present, the person is sent a KYC invitation and must complete full KYC for the KYB to be approvable. When absent, the person is screened by name only (AML) and is not notified — a clean name-AML result is sufficient (and required) for that person.
firstName required	string
gender required	string
lastName required	string

Responses

Request samples

Payload

Content type

application/json

{"persons": [{"country": "string",
"dateOfBirth": "string",
"email": "string",
"firstName": "string",
"gender": "string",
"lastName": "string"
}
]
}

Response samples

Content type

application/json

{"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Remove a director from a KYB case

Removes a director from a KYB case by their stable id and returns the updated KYB result.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID
person_id required	string <uuid> Stable id of the director to remove

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Responses

Response samples

Content type

application/json

{"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
}

Request a KYB document

Requests an additional document from the business on a KYB case and returns the created document request.

Authorizations:

None

path Parameters

organization_id required	string <uuid> Organization ID
kyb_result_id required	string <uuid> KYB result ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Request Body schema: application/json
required

body	string or null Optional email body; defaults to a generated body referencing the document.
description	string or null Optional description shown to the client; defaults to a generated message.
documentKey required	string Catalog `key` of the on-demand document to request (must be on-demand for this country).
recipientEmail	string or null Optional recipient override; defaults to the business contact email.
subject	string or null Optional email subject; defaults to a generated subject referencing the document.

Responses

Request samples

Payload

Content type

application/json

{"body": "string",
"description": "string",
"documentKey": "string",
"recipientEmail": "string",
"subject": "string"
}

Response samples

Content type

application/json

{"clarificationFields": ["string"
],
"clarificationResponse": {"decision": "string",
"fields": [{"fieldKey": "string",
"value": "string"
}
],
"reason": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"documentName": "string",
"fieldStatuses": {"property1": "PENDING",
"property2": "PENDING"
},
"fulfilledAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kybResultId": "f5562446-1011-4206-8c94-acf89f06e857",
"presignedUrl": "string",
"previousValues": {"property1": "string",
"property2": "string"
},
"requestType": "STANDARD",
"requestedByIdentityId": "bff67664-4117-4397-bb6b-0a1426d25791",
"reviewReason": "string",
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z",
"uploadedFilename": "string",
"uploadedS3Key": "string"
}

SDK: AML

Run a live AML screening and return the raw provider matches

Queries the configured screening provider (OpenSanctions/Yente or WorldCheck) and returns its raw FollowTheMoney-shaped entity matches — no risk scoring, no persistence. This is the "Stage A only" slice of the on-demand AML flow. Billed per call via pay-as-you-go.

Authorizations:

None

path Parameters

organization_id

required

string <uuid>

Organization ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Request Body schema: application/json
required

required	object (SdkAmlScreenQuery) Every meaningful OpenSanctions/Yente search field as an optional string. Result-only fields (sanctions, topics, position occupancies) are not exposed as inputs.
subjectType	string (AmlSubjectType) Enum: "PERSON" "COMPANY" The screened subject of an AML result. DTO mirror of the DB `AmlSubjectType` entity enum (converted via `From<entities::AmlSubjectType>`); lets consumers tell a company AML result from a person one. Defaults to `Person` (every result predating this field was a person).

Responses

Request samples

Payload

Content type

application/json

{"query": {"address": "string",
"alias": "string",
"birthCountry": "string",
"birthDate": "string",
"birthPlace": "string",
"country": "string",
"email": "string",
"firstName": "string",
"gender": "string",
"lastName": "string",
"middleName": "string",
"name": "string",
"nationality": "string",
"passportNumber": "string",
"phone": "string",
"position": "string",
"registrationNumber": "string",
"title": "string"
},
"subjectType": "PERSON"
}

Response samples

Content type

application/json

{"entities": [{"address": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"birthCountry": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"birthDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"birthPlace": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"country": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"email": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"firstName": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"gender": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"lastName": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"match": true,
"middleName": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"name": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"nationality": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"occupancies": [{"endDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"post": [{"country": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"description": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"dissolutionDate": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"inceptionDate": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"name": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"numberOfSeats": [0
],
"organization": [{"country": {"controls": [ ],
"value": [ ]
},
"description": {"controls": [ ],
"value": [ ]
},
"name": {"controls": [ ],
"value": [ ]
},
"summary": {"controls": [ ],
"value": [ ]
}
}
],
"subnationalArea": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"summary": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"topics": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
}
}
],
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"startDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"status": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
}
}
],
"phone": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"position": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"sanctions": [{"authority": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"authorityId": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"country": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"date": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"duration": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"endDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"listingDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"program": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"reason": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"startDate": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"status": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"unscId": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": null
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
}
}
],
"score": 0.1,
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"title": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
},
"topics": {"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"markAsFalsePositive": {"comment": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"value": ["string"
]
}
}
],
"format": "string",
"provider": "string"
}

API Keys

Flows

Get full flow details

path Parameters

slug

required

string

Flow slug

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier
zypheAccessSig	string or null Signed access token (JWS). Required only when flow signed access is enabled.

Responses

Response samples

Content type

application/json

{"flow": {"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"jdm": {"edges": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
"targetId": "cbca1126-180e-4334-9df8-cf82289d378b"
}
],
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": {"position": {"x": 0.1,
"y": 0.1
},
"property1": null,
"property2": null
},
"type": "START"
}
]
},
"name": "string",
"slug": "string",
"steps": [{"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"successUrl": "string",
"themeId": "53fe7fb9-b3ba-4541-bf79-a49c12f44b76",
"updatedAt": "2019-08-24T14:15:22Z",
"webhookUrl": "string"
},
"flowPartnerOrganizationsNames": ["string"
],
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"organizationName": "string",
"settings": {"askPasskeyCreation": true,
"createdAt": "2019-08-24T14:15:22Z",
"delayFlowResults": true,
"emailNotifications": ["string"
],
"extendedWebhook": true,
"oneClickAlwaysRequestUnlockVault": true,
"published": true,
"skipSignedAccess": true,
"slackNotifications": ["string"
],
"telegramNotifications": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z",
"webhookSecret": "string",
"webhookWithLegacy": true
},
"theme": {"borderRadius": "string",
"createdAt": "2019-08-24T14:15:22Z",
"dark": {"accent": "string",
"background": "string",
"card": "string",
"logoUrl": "string"
},
"fontFamily": "string",
"fontLicense": {"attested": true,
"attestedAt": "2019-08-24T14:15:22Z",
"attestedByIdentityId": "cc362adb-664d-4772-8417-48109c24a679"
},
"fontUrl": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isDefault": true,
"light": {"accent": "string",
"background": "string",
"card": "string",
"logoUrl": "string"
},
"name": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
}

Verification Requests

Get a verification request

Authorizations:

jwt-auth

path Parameters

flow_id required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Flow ID
verification_request_id required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Verification Request ID

query Parameters

sandbox

boolean or null

Whether to use sandbox mode

Responses

Response samples

Content type

application/json

{"externalId": "string",
"identity": {"createdAt": "2019-08-24T14:15:22Z",
"defaultOrganizationId": "b8c6d7f2-93a8-47a9-a281-9086316be7e8",
"email": "string",
"emailVerified": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isActive": true,
"role": "ANONYMOUS",
"settings": {"lastEnvironmentIsSandbox": true,
"locale": "en"
},
"updatedAt": "2019-08-24T14:15:22Z",
"zid": "string"
},
"passkey": {"challenge": "string",
"credentialId": "string",
"options": { },
"prfSalt": "string"
},
"verificationRequest": {"amlResult": {"adverseMedia": true,
"createdAt": "2019-08-24T14:15:22Z",
"data": {"entities": [{"entity": {"address": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthCountry": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthDate": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthPlace": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"country": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"email": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"firstName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"gender": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"lastName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"match": true,
"middleName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"name": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"nationality": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"occupancies": [{"endDate": {"controls": [ ],
"value": [ ]
},
"post": [null
],
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
}
}
],
"phone": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"position": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"sanctions": [{"authority": {"controls": [ ],
"value": [ ]
},
"authorityId": {"controls": [ ],
"value": [ ]
},
"country": {"controls": [ ],
"value": [ ]
},
"date": {"controls": [ ],
"value": [ ]
},
"duration": {"controls": [ ],
"value": [ ]
},
"endDate": {"controls": [ ],
"value": [ ]
},
"listingDate": {"controls": [ ],
"value": [ ]
},
"program": {"controls": [ ],
"value": [ ]
},
"reason": {"controls": [ ],
"value": [ ]
},
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
},
"unscId": {"controls": [ ],
"value": [ ]
}
}
],
"score": 0.1,
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"title": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"topics": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
}
},
"hasSanctions": true,
"isPep": true,
"match": true,
"matchScore": 0.1,
"riskCountries": ["string"
],
"riskPositions": ["string"
],
"riskRelationships": ["string"
],
"riskScore": {"riskLevel": "low",
"riskScorePercent": 0,
"sourcesCount": 0
},
"riskTopics": ["string"
]
}
],
"metadata": {"adverseMedia": {"articles": [{"eventGroup": "string",
"language": "string",
"locations": ["string"
],
"publishedDate": "2019-08-24T14:15:22Z",
"relevanceScore": 0.1,
"snippet": "string",
"source": "string",
"title": "string",
"topics": ["string"
],
"url": "string"
}
],
"checkedAt": "2019-08-24T14:15:22Z",
"hasHit": true,
"provider": "VERIFY",
"totalArticleCount": 0,
"totalEventCount": 0
},
"agentReview": {"enactedAction": "approve",
"policyVersion": "string",
"rationale": "string",
"residualRiskScore": 0.1,
"reviewedAt": "2019-08-24T14:15:22Z",
"suggested": true,
"verdictAction": "approve"
},
"checkedAt": "2019-08-24T14:15:22Z",
"companyQuery": {"companyName": "string",
"country": "string",
"registrationNumber": "string"
},
"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"approve": {"reason": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"moderation": "approved",
"query": {"dateOfBirth": "string",
"firstName": "string",
"lastName": "string"
},
"summary": {"hasAdverseMedia": true,
"hasPep": true,
"hasSanctions": true,
"highRiskEntitiesCount": 0,
"highestRiskLevel": "low",
"highestRiskScore": 0,
"totalEntities": 0
}
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"namedPersonRef": "6ed4ea79-b112-45b5-9a50-00e9a2825e1e",
"pep": true,
"sanctions": true,
"subjectType": "PERSON",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"attemptsCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customData": {"property1": null,
"property2": null
},
"dvResult": {"adminComment": "string",
"authenticityChecks": [[0
]
],
"browser": "string",
"class": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"data": {"property1": null,
"property2": null
},
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentScorePercent": 0,
"documentType": 0,
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"manualReviewAt": "2019-08-24T14:15:22Z",
"manualReviewNote": "string",
"manualReviewerId": "e044d43f-3a8b-43af-9b7a-95b2095b0b64",
"manualReviewerZid": "string",
"originalVrHistoryId": "e3407d54-5658-4ad1-a0d4-2133b69a753a",
"platform": "string",
"portraitMatchPercent": 0,
"processAdditionalData": {"autoOneClickKycData": {"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb"
},
"biometricCheckData": null,
"documentExpiredWebhookSentAt": "2019-08-24",
"imageQuality": [{"checkType": "glare",
"probability": 0,
"result": "passed"
}
],
"rawLivenessData": null,
"securityChecks": {"property1": "string",
"property2": "string"
},
"status": {"documentType": "passed",
"expiry": "passed",
"mrz": "passed",
"overall": "passed"
}
},
"provinceCode": "string",
"reasons": ["UNKNOWN"
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"validUntil": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"formResult": {"assignedRiskTags": [{"addedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removedAt": "2019-08-24T14:15:22Z",
"source": {"by": "6d5a269d-39eb-437d-afdb-2080c51fa5fc",
"kind": "manual"
},
"tag": "string",
"weight": 0.1
}
],
"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"form": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"sections": [{"items": [{"content": {"label": {"property1": null,
"property2": null
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [ ],
"tags": [ ]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z"
},
"formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"riskFactorKeys": ["string"
],
"sections": [{"items": [{"content": {"label": {"property1": "string",
"property2": "string"
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [null
],
"tags": [null
]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"geolocationResult": {"blacklistedIp": true,
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceFingerprint": "string",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ipAddress": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"vpn": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity": {"createdAt": "2019-08-24T14:15:22Z",
"defaultOrganizationId": "b8c6d7f2-93a8-47a9-a281-9086316be7e8",
"email": "string",
"emailVerified": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isActive": true,
"role": "ANONYMOUS",
"settings": {"lastEnvironmentIsSandbox": true,
"locale": "en"
},
"updatedAt": "2019-08-24T14:15:22Z",
"zid": "string"
},
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"kybResult": {"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"phoneResult": {"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"phoneNumberE164": "string",
"phoneNumberLast4": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"poaResult": {"checkedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentType": "PAY_SLIP",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"reason": "string",
"replayerZid": "string",
"spidResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z",
"walletResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"message": "string",
"reason": "string",
"signature": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"walletAddress": "string",
"walletChain": "string"
}
},
"wallet": {"address": "string",
"chain": "ETHEREUM"
}
}

Get completed verification requests

Authorizations:

jwt-auth

path Parameters

flow_id

required

string <uuid>

Example: 123e4567-e89b-12d3-a456-426614174000

Flow ID

query Parameters

sandbox required	boolean
locale	string (Locale) Enum: "en" "it" "de" "es" "fr" "hi" "id" "pt" Locale identifier

Responses

Response samples

Content type

application/json

[{"amlResult": {"adverseMedia": true,
"createdAt": "2019-08-24T14:15:22Z",
"data": {"entities": [{"entity": {"address": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthCountry": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthDate": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"birthPlace": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"country": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"email": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"firstName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"gender": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"lastName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"match": true,
"middleName": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"name": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"nationality": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"occupancies": [{"endDate": {"controls": [ ],
"value": [ ]
},
"post": [null
],
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
}
}
],
"phone": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"position": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"sanctions": [{"authority": {"controls": [ ],
"value": [ ]
},
"authorityId": {"controls": [ ],
"value": [ ]
},
"country": {"controls": [ ],
"value": [ ]
},
"date": {"controls": [ ],
"value": [ ]
},
"duration": {"controls": [ ],
"value": [ ]
},
"endDate": {"controls": [ ],
"value": [ ]
},
"listingDate": {"controls": [ ],
"value": [ ]
},
"program": {"controls": [ ],
"value": [ ]
},
"reason": {"controls": [ ],
"value": [ ]
},
"sources": [null
],
"startDate": {"controls": [ ],
"value": [ ]
},
"status": {"controls": [ ],
"value": [ ]
},
"unscId": {"controls": [ ],
"value": [ ]
}
}
],
"score": 0.1,
"sources": [{"name": "string",
"title": "string",
"url": "string"
}
],
"title": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
},
"topics": {"controls": [{"identityId": null,
"operation": null,
"timestamp": null,
"zid": null
}
],
"value": ["string"
]
}
},
"hasSanctions": true,
"isPep": true,
"match": true,
"matchScore": 0.1,
"riskCountries": ["string"
],
"riskPositions": ["string"
],
"riskRelationships": ["string"
],
"riskScore": {"riskLevel": "low",
"riskScorePercent": 0,
"sourcesCount": 0
},
"riskTopics": ["string"
]
}
],
"metadata": {"adverseMedia": {"articles": [{"eventGroup": "string",
"language": "string",
"locations": ["string"
],
"publishedDate": "2019-08-24T14:15:22Z",
"relevanceScore": 0.1,
"snippet": "string",
"source": "string",
"title": "string",
"topics": ["string"
],
"url": "string"
}
],
"checkedAt": "2019-08-24T14:15:22Z",
"hasHit": true,
"provider": "VERIFY",
"totalArticleCount": 0,
"totalEventCount": 0
},
"agentReview": {"enactedAction": "approve",
"policyVersion": "string",
"rationale": "string",
"residualRiskScore": 0.1,
"reviewedAt": "2019-08-24T14:15:22Z",
"suggested": true,
"verdictAction": "approve"
},
"checkedAt": "2019-08-24T14:15:22Z",
"companyQuery": {"companyName": "string",
"country": "string",
"registrationNumber": "string"
},
"controls": [{"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"operation": {"approve": {"reason": "string"
}
},
"timestamp": "2019-08-24T14:15:22Z",
"zid": "string"
}
],
"moderation": "approved",
"query": {"dateOfBirth": "string",
"firstName": "string",
"lastName": "string"
},
"summary": {"hasAdverseMedia": true,
"hasPep": true,
"hasSanctions": true,
"highRiskEntitiesCount": 0,
"highestRiskLevel": "low",
"highestRiskScore": 0,
"totalEntities": 0
}
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"namedPersonRef": "6ed4ea79-b112-45b5-9a50-00e9a2825e1e",
"pep": true,
"sanctions": true,
"subjectType": "PERSON",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"attemptsCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customData": {"property1": null,
"property2": null
},
"dvResult": {"adminComment": "string",
"authenticityChecks": [[0
]
],
"browser": "string",
"class": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"data": {"property1": null,
"property2": null
},
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentScorePercent": 0,
"documentType": 0,
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"manualReviewAt": "2019-08-24T14:15:22Z",
"manualReviewNote": "string",
"manualReviewerId": "e044d43f-3a8b-43af-9b7a-95b2095b0b64",
"manualReviewerZid": "string",
"originalVrHistoryId": "e3407d54-5658-4ad1-a0d4-2133b69a753a",
"platform": "string",
"portraitMatchPercent": 0,
"processAdditionalData": {"autoOneClickKycData": {"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb"
},
"biometricCheckData": null,
"documentExpiredWebhookSentAt": "2019-08-24",
"imageQuality": [{"checkType": "glare",
"probability": 0,
"result": "passed"
}
],
"rawLivenessData": null,
"securityChecks": {"property1": "string",
"property2": "string"
},
"status": {"documentType": "passed",
"expiry": "passed",
"mrz": "passed",
"overall": "passed"
}
},
"provinceCode": "string",
"reasons": ["UNKNOWN"
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"validUntil": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"formResult": {"assignedRiskTags": [{"addedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removedAt": "2019-08-24T14:15:22Z",
"source": {"by": "6d5a269d-39eb-437d-afdb-2080c51fa5fc",
"kind": "manual"
},
"tag": "string",
"weight": 0.1
}
],
"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"form": {"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"sections": [{"items": [{"content": {"label": {"property1": null,
"property2": null
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [ ],
"tags": [ ]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z"
},
"formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"riskFactorKeys": ["string"
],
"sections": [{"items": [{"content": {"label": {"property1": "string",
"property2": "string"
},
"name": "string",
"options": null,
"requiredWhen": { },
"risk": {"factors": [null
],
"tags": [null
]
},
"type": "date",
"value": null,
"visibleWhen": { }
},
"type": "InputField"
}
],
"label": {"property1": "string",
"property2": "string"
},
"name": "string"
}
],
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"geolocationResult": {"blacklistedIp": true,
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceFingerprint": "string",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ipAddress": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"vpn": true
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identity": {"createdAt": "2019-08-24T14:15:22Z",
"defaultOrganizationId": "b8c6d7f2-93a8-47a9-a281-9086316be7e8",
"email": "string",
"emailVerified": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isActive": true,
"role": "ANONYMOUS",
"settings": {"lastEnvironmentIsSandbox": true,
"locale": "en"
},
"updatedAt": "2019-08-24T14:15:22Z",
"zid": "string"
},
"identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
"kybResult": {"assignedAt": "2019-08-24T14:15:22Z",
"assignedToIdentityId": "4320f3c3-8ca3-46ff-91aa-ad418c7a1fed",
"businessInformation": {"address": "string",
"businessActivity": "string",
"city": "string",
"companyName": "string",
"companyType": "string",
"contactEmail": "string",
"country": "string",
"incorporationDate": "string",
"postZipCode": "string",
"registrationNumber": "string"
},
"businessInformationVerification": {"property1": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
},
"property2": {"agentReasoning": "string",
"catalogValue": "string",
"disagreementSources": ["submitted"
],
"documentValue": "string",
"matchType": "match",
"submittedValue": "string",
"suggestedValue": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"directorDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"documentUploads": [{"documentType": "string",
"filename": "string",
"presignedUrl": "string",
"s3Key": "string"
}
],
"effectiveRequiredDocuments": [{"key": "string",
"label": "string",
"onDemand": true,
"required": true,
"validationSchema": null
}
],
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"fundedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metadata": { },
"nextAction": "CLIENT",
"pepAndSanctionsStatus": "REVIEW",
"reason": "string",
"report": "string",
"status": "ACQUIRING",
"uboDefinitions": [{"country": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"firstName": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"lastName": "string"
}
],
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"phoneResult": {"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"phoneNumberE164": "string",
"phoneNumberLast4": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"poaResult": {"checkedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"documentType": "PAY_SLIP",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "UNKNOWN",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"reason": "string",
"replayerZid": "string",
"spidResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"reason": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4"
},
"status": "PENDING",
"updatedAt": "2019-08-24T14:15:22Z",
"walletResult": {"createdAt": "2019-08-24T14:15:22Z",
"flowResultId": "f842deda-7b24-4524-8232-f33c5f261770",
"flowStep": {"config": {"amlAgenticMode": "DISABLED",
"documentSelectionStepId": "b40bc63e-ef37-44fa-b9ed-72d0c863ef6b",
"incodeConfigurationId": "string",
"kycValiditySeconds": 0,
"labels": "{ \"en_button_label\": \"Next step\" }",
"maxAttempts": "5",
"minimumAge": 0,
"poaFromGovcheck": true,
"processImagesOverrides": {"authParams": {"property1": null,
"property2": null
},
"checkAuth": true,
"scenario": "string"
},
"requiredDocumentFields": ["firstName"
],
"reverificationLeadSeconds": 0,
"thresholds": {"property1": 0.1,
"property2": 0.1
}
},
"createdAt": "2019-08-24T14:15:22Z",
"failureUrl": "string",
"flowId": "ccd52024-9c9c-4751-993a-9d75a778bf9d",
"gotoStepId": "3670e068-8c55-4fe5-ba94-faac3539ee75",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"order": 0,
"slug": "string",
"successUrl": "string",
"type": "DV",
"updatedAt": "2019-08-24T14:15:22Z"
},
"flowStepId": "10a85e41-8dfe-4c2c-b207-278e137391eb",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"message": "string",
"reason": "string",
"signature": "string",
"status": "PASSED",
"updatedAt": "2019-08-24T14:15:22Z",
"verificationRequestId": "21948c97-1944-4395-87f4-b00ba0261bd4",
"walletAddress": "string",
"walletChain": "string"
}
}
]

zyphe-sdk (1.9.1)

SDK: Verification Requests

Create a verification request

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the next verification step

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Submits identity document images for document verification. Call this after `next-step` returns a document verification step.

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieves the liveness challenge configuration for the current verification request. Use the returned data to present the liveness capture UI to the user.

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Submits liveness capture data (selfie or video) for processing. Call this after completing the liveness challenge from `liveness-challenge`.

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Submits the user's document selection (country and document type) to complete the document selection step.

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SDK: Organizations

List flow results

Authorizations:

path Parameters

query Parameters

Responses

Response samples

SDK: KYB

Send a UBO KYC reminder

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Add UBOs to a KYB case

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove a UBO from a KYB case

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Add directors to a KYB case

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required