KYC Dummy results

Requirements

• API key
• DEV Environment
• Finances

Heads up

Dummy results only work on DEV Environment. Using dummy statuses in PROD / TEST Environment will result in error message:

"message": "This endpoint is not available for TESTING/PRODUCTION partners.",

---

Token generation for dummy results

Authorization: API key pair Method: POST Endpoint: https://ivs.idenfy.com/api/v2/token

You can generate a token with dummy auto status and add dummy manual status for verification in the development environment.

Dummy Auto results

The request must contain the same parameters as token generation and dummyStatus, which defines dummy session's auto result.

JSON key	Type	Explanation
dummyStatus	String	Auto status of the verification. Possible values: - APPROVED - DENIED - SUSPECTED - ACTIVE - EXPIRED For value explanations refer to status vocabulary.

Request example

{
  "dummyStatus": "APPROVED",
  "clientId": "100000",
  "firstName": "John Tom",
  "lastName": "Smith",
  "successUrl": "https://www.my-company.com/idenfy/success",
  "errorUrl": "https://www.my-company.com/idenfy/fail",
  "locale": "en",
  "showInstructions": true,
  "expiryTime": 600,
  "sessionLength": 600,
  "country": "lt",
  "documents": ["PASSPORT", "ID_CARD"],
  "dateOfBirth": "1990-12-20",
  "dateOfExpiry": "1990-12-20",
  "dateOfIssue": "1990-12-20",
  "nationality": "lt",
  "personalNumber": "123456789",
  "documentNumber": "123456",
  "sex": "M",
  "address": "Address",
  "tokenType": "IDENTIFICATION",
  "externalRef": "reference"
}

Response example:

Successful API call returns a JSON response with scanRef, that can be used to add dummy manual status.

{
  "message": "Dummy token and verification created successfully",
  "authToken": "pgYQX0z2T8mtcpNj9I20uWVCLKNuG0vgr12f0wAC",
  "scanRef": "ec6a7108-8c26-11e9-9758-309c231b1bac",
  "clientId": "100000",
  "firstName": "JOHN TOM",
  "lastName": "SMITH",
  "successUrl": "https://www.my-company.com/idenfy/success",
  "errorUrl": "https://www.my-company.com/idenfy/fail",
  "locale": "en",
  "showInstructions": true,
  "country": "lt",
  "expiryTime": 600,
  "sessionLength": 600,
  "documents": ["PASSPORT"],
  "dateOfBirth": "1990-12-20",
  "dateOfExpiry": "1990-12-20",
  "dateOfIssue": "1990-12-20",
  "nationality": "lt",
  "personalNumber": "123456789",
  "documentNumber": "123456",
  "sex": "M",
  "digitString": "4823657",
  "address": "Address",
  "tokenType": "IDENTIFICATION",
  "externalRef": "reference"
}

---

Dummy Manual result

Token generation API for dummy results

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/add-dummy-status

Sending request

You can generate a token with dummy auto status and receive a webhook with auto results.

You can add a dummy manual status for the verification in development environment and receive the same webhook as it would after the manual review.

Heads up

• Client's verification should be already created, otherwise, generate a new token with dummyStatus
• For approved verification you need to give FACE_MATCH and DOC_VALIDATED statuses.

The request must contain JSON with these parameters:

Key	Type	Explanation
scanRef	List	A unique string identifying a client verification.
manualFaceMatchResult	String	Dummy manual face status. Possible values: - FACE_MATCH - FACE_MISMATCH - NO_FACE_FOUND - TOO_MANY_FACES - FACE_TOO_BLURRY - FACE_UNCERTAIN - FACE_NOT_ANALYSED - FACE_NOT_CHECKED - FACE_ERROR - AUTO_UNVERIFIABLE - FAKE_FACE For value explanations refer to status vocabulary.
manualDocumentValidity	String	Dummy manual document status. Possible values: - DOC_VALIDATED - DOC_INFO_MISMATCH - DOC_NOT_FOUND - DOC_NOT_FULLY_VISIBLE - DOC_NOT_SUPPORTED - DOC_FACE_NOT_FOUND - DOC_TOO_BLURRY - DOC_FACE_GLARED - MRZ_NOT_FOUND - MRZ_OCR_READING_ERROR - BARCODE_NOT_FOUND - DOC_EXPIRED - COUNTRY_MISMATCH - DOC_TYPE_MISMATCH - DOC_DAMAGED - DOC_FAKE - DOC_ERROR - AUTO_UNVERIFIABLE - DOC_NOT_ANALYSED - DOC_NAME_ERROR - DOC_SURNAME_ERROR - DOC_EXPIRY_ERROR - DOC_DOB_ERROR - DOC_PERSONAL_NUMBER_ERROR - DOC_NUMBER_ERROR - DOC_DATE_OF_ISSUE_ERROR - DOC_SEX_ERROR - DOC_NATIONALITY_ERROR For value explanations refer to status vocabulary

Request example

{
  "scanRef": "unique_scan_ref",
  "manualDocumentValidity": "DOC_ERROR",
  "manualFaceMatchResult": "FACE_MATCH"
}

A successful API call returns a HTTP response with 200 status.