curl --request POST \
--url https://api.dataspike.io/api/v3/sdk/{short_id}/proceed \
--header 'ds-api-token: <api-key>'{
"id": "VDBA1B2EA6A28A7D2",
"status": "active",
"checks": {
"document_mrz": {
"data": {
"document_type": "Passport",
"country": "DE",
"name": "John",
"surname": "Doe",
"doc_number": "P-1234567890",
"nationality": "British",
"birth_date": "871224",
"sex": "M",
"expiry_date": "201224"
},
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"face_comparison": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"poa": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"liveness": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
}
},
"expires_at": "2023-07-18T15:32:13.000Z",
"settings": {
"poi_required": true,
"poi_allowed_documents": [
"passport"
],
"face_comparison_required": true,
"face_comparison_allowed_documents": [
"selfie"
],
"poa_required": false,
"allow_poi_manual_uploads": false,
"allow_desktop": false,
"disable_cross_check_by_bio": false,
"disable_cross_check_by_photo": false,
"disable_verify_poa_country_match_with_poi": false,
"countries": [
"FR"
],
"ui_settings": {},
"manual_field_settings": {
"enabled": true,
"description": "<string>",
"full_name": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"email": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"phone": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"country": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"dob": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"gender": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"citizenship": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"address": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"certificate_of_incorporation": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"ownership_document": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"custom_fields": [
{
"label": "<string>",
"caption": "<string>",
"order": 123,
"options": {
"choices": [
"<string>"
],
"type": "<string>"
}
}
]
},
"finish_screen_settings": {
"enabled": true,
"settings": {
"title": "<string>",
"main_text": "<string>",
"redirect_warning": "<string>",
"cta": "<string>",
"redirect_link": "<string>"
}
}
},
"redirect_url": "https://example.org/redirect",
"country_code": "DE"
}To proceed verification further call this method. Should be used after all the required documents has been uploaded.
Recovering from errors:
pending_documents - need to upload missed docs. pending_documents field indicates which documents are missed.
country_unknown - we can’t detect country in POI document. Please specify country by set_country API request or use another document.
curl --request POST \
--url https://api.dataspike.io/api/v3/sdk/{short_id}/proceed \
--header 'ds-api-token: <api-key>'{
"id": "VDBA1B2EA6A28A7D2",
"status": "active",
"checks": {
"document_mrz": {
"data": {
"document_type": "Passport",
"country": "DE",
"name": "John",
"surname": "Doe",
"doc_number": "P-1234567890",
"nationality": "British",
"birth_date": "871224",
"sex": "M",
"expiry_date": "201224"
},
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"face_comparison": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"poa": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
},
"liveness": {
"status": "pending",
"pending_documents": [
"passport"
],
"errors": [
{
"code": 1001,
"message": "document parsing failed"
}
]
}
},
"expires_at": "2023-07-18T15:32:13.000Z",
"settings": {
"poi_required": true,
"poi_allowed_documents": [
"passport"
],
"face_comparison_required": true,
"face_comparison_allowed_documents": [
"selfie"
],
"poa_required": false,
"allow_poi_manual_uploads": false,
"allow_desktop": false,
"disable_cross_check_by_bio": false,
"disable_cross_check_by_photo": false,
"disable_verify_poa_country_match_with_poi": false,
"countries": [
"FR"
],
"ui_settings": {},
"manual_field_settings": {
"enabled": true,
"description": "<string>",
"full_name": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"email": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"phone": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"country": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"dob": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"gender": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"citizenship": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"address": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"certificate_of_incorporation": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"ownership_document": {
"enabled": true,
"caption": "<string>",
"order": 123,
"optional": true
},
"custom_fields": [
{
"label": "<string>",
"caption": "<string>",
"order": 123,
"options": {
"choices": [
"<string>"
],
"type": "<string>"
}
}
]
},
"finish_screen_settings": {
"enabled": true,
"settings": {
"title": "<string>",
"main_text": "<string>",
"redirect_warning": "<string>",
"cta": "<string>",
"redirect_link": "<string>"
}
}
},
"redirect_url": "https://example.org/redirect",
"country_code": "DE"
}Existing Verification Short Id
"VDBA1B2EA6A28A7D2"
Verification response
Minimized Verification Object used for SDK
Short verification id
"VDBA1B2EA6A28A7D2"
active, expired, completed Object describes required checks and it`s current status
Show child attributes
MRZ check Recognized MRZ data of document. Object describes verification check, required documents and status
Show child attributes
Show child attributes
MRZ document type
"Passport"
Country of the document, reference https://www.iban.com/country-codes
"DE"
Extracted name
"John"
Extracted surname
"Doe"
Document number
"P-1234567890"
Extracted nationality
"British"
Extracted birth date in YYMMDD format
"871224"
Extracted sex, typically M or F
"M"
Extracted birth date in YYMMDD format
"201224"
Describes possible document check statuses for a specific verification
pending, in_progress, verified, failed, canceled, expired List of required documents, that were not uploaded yet
Possible document type
passport, id_card, residence_permit, driver_license, poa, selfie, liveness_photo, kyb_certificate_of_incorporation, kyb_ownership_document Show child attributes
General parsing and detection
| Code | Message | Description |
|---|---|---|
| 1001 | "document parsing failed" | Processing of document fails due to any reason. Most common cases - image doesn't have any document, corrupted file, etc. |
| 1103 | "expiry date not recognized" | Expiry date on document not parsed or detected |
Document MRZ errors
| Code | Message | Description |
|---|---|---|
| 2001 | "document mrz detection failed" | MRZ Zone not detected at document |
| 2002 | "document number" | Document number not detected on document or invalid |
| 2003 | "birth date" | Birth date not detected or invalid |
| 2004 | "expiry date" | Expiry date not detected or invalid |
| 2005 | "final" | Checksum of fields is invalid |
| 2006 | "country code" | Country code not detected or invalid |
| 2010 | "document validation failed" | General error of mrz validation |
Expiration
| Code | Message | Description |
|---|---|---|
| 3001 | "document expired" | Document expired |
Document mismatch
| Code | Message | Description |
|---|---|---|
| 3100 | "document mismatch" | The uploaded document does not match the stated |
Face comparison
| Code | Message | Description |
|---|---|---|
| 4001 | "no face were found on image" | Face not found in image |
| 4002 | "face comparison failed" | Face doesn't match with document |
| 4003 | "images are identical" | Face image and document image are identical |
Proof of address
| Code | Message | Description |
|---|---|---|
| 4500 | "Name in PoA document not verified" | - |
| 4501 | "Surname in PoA document not verified" | - |
| 4502 | "Country in PoA document not verified" | - |
| 4503 | "PoA document is not applicable" | - |
| 4504 | "PoA Document is too old" | - |
| 4505 | "Can't process poa document" | - |
Liveness
| Code | Message | Description |
|---|---|---|
| 5000 | "Liveness check not passed" | - |
| 5001 | "deepfake" | Photo is deepfake |
| 5002 | "spoof" | Photo is spoofed |
| 5003 | "move closer" | Photo spoofed or disputed. hint for user: move closer |
| 5004 | "check lighting" | Photo spoofed or disputed. hint for user: check lighting |
| 5005 | "disputed" | Photo liveness is disputed |
| 5006 | "small resolution" | Photo spoofed or disputed. hint for user: image resolution too small. Check camera settings |
| 5007 | "3d depth of face" | Photo spoofed or disputed. hint for user: It can be lighting or angle of face. |
Verification
| Code | Message | Description |
|---|---|---|
| 8000 | "verification expired" | Verification expired |
| 8001 | "verification canceled" | Verification canceled |
1001
Descriptive error for a corresponding error code
"document parsing failed"
Face comparison check, can be within selfie or liveness_photo documents Object describes verification check, required documents and status
Show child attributes
Describes possible document check statuses for a specific verification
pending, in_progress, verified, failed, canceled, expired List of required documents, that were not uploaded yet
Possible document type
passport, id_card, residence_permit, driver_license, poa, selfie, liveness_photo, kyb_certificate_of_incorporation, kyb_ownership_document Show child attributes
General parsing and detection
| Code | Message | Description |
|---|---|---|
| 1001 | "document parsing failed" | Processing of document fails due to any reason. Most common cases - image doesn't have any document, corrupted file, etc. |
| 1103 | "expiry date not recognized" | Expiry date on document not parsed or detected |
Document MRZ errors
| Code | Message | Description |
|---|---|---|
| 2001 | "document mrz detection failed" | MRZ Zone not detected at document |
| 2002 | "document number" | Document number not detected on document or invalid |
| 2003 | "birth date" | Birth date not detected or invalid |
| 2004 | "expiry date" | Expiry date not detected or invalid |
| 2005 | "final" | Checksum of fields is invalid |
| 2006 | "country code" | Country code not detected or invalid |
| 2010 | "document validation failed" | General error of mrz validation |
Expiration
| Code | Message | Description |
|---|---|---|
| 3001 | "document expired" | Document expired |
Document mismatch
| Code | Message | Description |
|---|---|---|
| 3100 | "document mismatch" | The uploaded document does not match the stated |
Face comparison
| Code | Message | Description |
|---|---|---|
| 4001 | "no face were found on image" | Face not found in image |
| 4002 | "face comparison failed" | Face doesn't match with document |
| 4003 | "images are identical" | Face image and document image are identical |
Proof of address
| Code | Message | Description |
|---|---|---|
| 4500 | "Name in PoA document not verified" | - |
| 4501 | "Surname in PoA document not verified" | - |
| 4502 | "Country in PoA document not verified" | - |
| 4503 | "PoA document is not applicable" | - |
| 4504 | "PoA Document is too old" | - |
| 4505 | "Can't process poa document" | - |
Liveness
| Code | Message | Description |
|---|---|---|
| 5000 | "Liveness check not passed" | - |
| 5001 | "deepfake" | Photo is deepfake |
| 5002 | "spoof" | Photo is spoofed |
| 5003 | "move closer" | Photo spoofed or disputed. hint for user: move closer |
| 5004 | "check lighting" | Photo spoofed or disputed. hint for user: check lighting |
| 5005 | "disputed" | Photo liveness is disputed |
| 5006 | "small resolution" | Photo spoofed or disputed. hint for user: image resolution too small. Check camera settings |
| 5007 | "3d depth of face" | Photo spoofed or disputed. hint for user: It can be lighting or angle of face. |
Verification
| Code | Message | Description |
|---|---|---|
| 8000 | "verification expired" | Verification expired |
| 8001 | "verification canceled" | Verification canceled |
1001
Descriptive error for a corresponding error code
"document parsing failed"
Proof of Address check Object describes verification check, required documents and status
Show child attributes
Describes possible document check statuses for a specific verification
pending, in_progress, verified, failed, canceled, expired List of required documents, that were not uploaded yet
Possible document type
passport, id_card, residence_permit, driver_license, poa, selfie, liveness_photo, kyb_certificate_of_incorporation, kyb_ownership_document Show child attributes
General parsing and detection
| Code | Message | Description |
|---|---|---|
| 1001 | "document parsing failed" | Processing of document fails due to any reason. Most common cases - image doesn't have any document, corrupted file, etc. |
| 1103 | "expiry date not recognized" | Expiry date on document not parsed or detected |
Document MRZ errors
| Code | Message | Description |
|---|---|---|
| 2001 | "document mrz detection failed" | MRZ Zone not detected at document |
| 2002 | "document number" | Document number not detected on document or invalid |
| 2003 | "birth date" | Birth date not detected or invalid |
| 2004 | "expiry date" | Expiry date not detected or invalid |
| 2005 | "final" | Checksum of fields is invalid |
| 2006 | "country code" | Country code not detected or invalid |
| 2010 | "document validation failed" | General error of mrz validation |
Expiration
| Code | Message | Description |
|---|---|---|
| 3001 | "document expired" | Document expired |
Document mismatch
| Code | Message | Description |
|---|---|---|
| 3100 | "document mismatch" | The uploaded document does not match the stated |
Face comparison
| Code | Message | Description |
|---|---|---|
| 4001 | "no face were found on image" | Face not found in image |
| 4002 | "face comparison failed" | Face doesn't match with document |
| 4003 | "images are identical" | Face image and document image are identical |
Proof of address
| Code | Message | Description |
|---|---|---|
| 4500 | "Name in PoA document not verified" | - |
| 4501 | "Surname in PoA document not verified" | - |
| 4502 | "Country in PoA document not verified" | - |
| 4503 | "PoA document is not applicable" | - |
| 4504 | "PoA Document is too old" | - |
| 4505 | "Can't process poa document" | - |
Liveness
| Code | Message | Description |
|---|---|---|
| 5000 | "Liveness check not passed" | - |
| 5001 | "deepfake" | Photo is deepfake |
| 5002 | "spoof" | Photo is spoofed |
| 5003 | "move closer" | Photo spoofed or disputed. hint for user: move closer |
| 5004 | "check lighting" | Photo spoofed or disputed. hint for user: check lighting |
| 5005 | "disputed" | Photo liveness is disputed |
| 5006 | "small resolution" | Photo spoofed or disputed. hint for user: image resolution too small. Check camera settings |
| 5007 | "3d depth of face" | Photo spoofed or disputed. hint for user: It can be lighting or angle of face. |
Verification
| Code | Message | Description |
|---|---|---|
| 8000 | "verification expired" | Verification expired |
| 8001 | "verification canceled" | Verification canceled |
1001
Descriptive error for a corresponding error code
"document parsing failed"
Liveness check, verify that provided image is not spoofed Object describes verification check, required documents and status
Show child attributes
Describes possible document check statuses for a specific verification
pending, in_progress, verified, failed, canceled, expired List of required documents, that were not uploaded yet
Possible document type
passport, id_card, residence_permit, driver_license, poa, selfie, liveness_photo, kyb_certificate_of_incorporation, kyb_ownership_document Show child attributes
General parsing and detection
| Code | Message | Description |
|---|---|---|
| 1001 | "document parsing failed" | Processing of document fails due to any reason. Most common cases - image doesn't have any document, corrupted file, etc. |
| 1103 | "expiry date not recognized" | Expiry date on document not parsed or detected |
Document MRZ errors
| Code | Message | Description |
|---|---|---|
| 2001 | "document mrz detection failed" | MRZ Zone not detected at document |
| 2002 | "document number" | Document number not detected on document or invalid |
| 2003 | "birth date" | Birth date not detected or invalid |
| 2004 | "expiry date" | Expiry date not detected or invalid |
| 2005 | "final" | Checksum of fields is invalid |
| 2006 | "country code" | Country code not detected or invalid |
| 2010 | "document validation failed" | General error of mrz validation |
Expiration
| Code | Message | Description |
|---|---|---|
| 3001 | "document expired" | Document expired |
Document mismatch
| Code | Message | Description |
|---|---|---|
| 3100 | "document mismatch" | The uploaded document does not match the stated |
Face comparison
| Code | Message | Description |
|---|---|---|
| 4001 | "no face were found on image" | Face not found in image |
| 4002 | "face comparison failed" | Face doesn't match with document |
| 4003 | "images are identical" | Face image and document image are identical |
Proof of address
| Code | Message | Description |
|---|---|---|
| 4500 | "Name in PoA document not verified" | - |
| 4501 | "Surname in PoA document not verified" | - |
| 4502 | "Country in PoA document not verified" | - |
| 4503 | "PoA document is not applicable" | - |
| 4504 | "PoA Document is too old" | - |
| 4505 | "Can't process poa document" | - |
Liveness
| Code | Message | Description |
|---|---|---|
| 5000 | "Liveness check not passed" | - |
| 5001 | "deepfake" | Photo is deepfake |
| 5002 | "spoof" | Photo is spoofed |
| 5003 | "move closer" | Photo spoofed or disputed. hint for user: move closer |
| 5004 | "check lighting" | Photo spoofed or disputed. hint for user: check lighting |
| 5005 | "disputed" | Photo liveness is disputed |
| 5006 | "small resolution" | Photo spoofed or disputed. hint for user: image resolution too small. Check camera settings |
| 5007 | "3d depth of face" | Photo spoofed or disputed. hint for user: It can be lighting or angle of face. |
Verification
| Code | Message | Description |
|---|---|---|
| 8000 | "verification expired" | Verification expired |
| 8001 | "verification canceled" | Verification canceled |
1001
Descriptive error for a corresponding error code
"document parsing failed"
Verification expiration timestamp
"2023-07-18T15:32:13.000Z"
Verification profile settings
Show child attributes
POI (proof of identity) check is required.
Allowed documents for POI check
passport, driver_license, id_card, residence_permit Face comparison check is required
Allowed documents for face comparison check
selfie, liveness_photo POA (proof of address) check is required
Allow manual upload POI documents from files (now live photo)
Allow uploads throught desktop. False means only mobile allowed
Don't do cross check by name and birth date in POI document across organization.
Don't do cross check by photo of applicant across organization.
Disable requirement that country in POA document should be match within country in POI document
List of allowed countries
Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes
ui settigns to customize SDK
Manual field settings
Show child attributes
Manual field setting
Show child attributes
Caption of field
Position order in UI
This field is optional for submitter when true
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Caption of field
Position order in UI
This field is optional for submitter when true
Manual field setting
Show child attributes
Manual field setting
Show child attributes
Caption of field
Position order in UI
This field is optional for submitter when true
Manual field setting
Show child attributes
Caption of field
Position order in UI
This field is optional for submitter when true
Show child attributes
Verification finish screen settings
Show child attributes
Show child attributes
Redirect to this url after verification has finished
merchant's website reidrect url on completion
"https://example.org/redirect"
Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes
"DE"