Dummy session for developers
You can generate a token with dummy auto status and add dummy manual status for verification in the development environment.
Dummy session for developers is used to test the API with various statuses and receive a webhook without the need to go through the process in the UI.
If you want to test the flow in the UI, please use the redirection methods - Redirection to WEB UI or Redirection using iframe without the dummyStatus
parameter.
Dummy auto result
You can generate a token with dummy auto status and receive a webhook with auto results.
Sending request
Send a HTTP POST request to: https://ivs.idenfy.com/api/v2/token
The request must contain basic auth headers where username is API key and password is API secret.
The Dummy session should only be performed using a development environment. Passing dummyStatus
with TESTING or PRODUCTION environment will result in bad request:
"message": "This endpoint is not available for TESTING/PRODUCTION partners.",
"identifier": "PERMISSIONS_ERROR",
The request must contain the same parameters as token generation and dummyStatus, which defines dummy session's auto result.
JSON key | Type | Constraints | Explanation |
---|---|---|---|
dummyStatus | String | - Max length 30 | Auto status of the verification. Possible values: - APPROVED - DENIED - SUSPECTED - ACTIVE - EXPIRED For value explanations refer to status vocabulary. |
Example request
{
"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"
}
Example responses
Successful API call returns a JSON response with scanRef, that can be used to add dummy manual status.
An example response with all fields provided:
{
"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", "OTHER"],
"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 approve
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.
Sending request
Send a HTTP POST request to: https://ivs.idenfy.com/api/v2/add-dummy-status
The request must contain basic auth headers where username is API key and password is API secret.
Client's verification should be already created, otherwise, generate a new token with dummyStatus
The request must contain JSON with these parameters:
Key | Type | Constraints | Explanation |
---|---|---|---|
scanRef | List | - | A unique string identifying a client verification. |
manualFaceMatchResult | String | - Max length 30 | 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 | - Max length 30 | 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 |
For approved verification you need to give FACE_MATCH and DOC_VALIDATED statuses.
Example request
{
"scanRef": "unique_scan_ref",
"manualDocumentValidity": "DOC_ERROR",
"manualFaceMatchResult": "FACE_MATCH"
}
Example responses
A successful API call returns a HTTP response with 200 status.