Authorizations
Path Parameters
Fetch Verifications by Applicant ID
Example:
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Query Parameters
Current page
Limit of returned items per page
curl --request GET \
--url https://api.dataspike.io/api/v3/verifications/applicant/{applicant_id} \
--header 'ds-api-token: <api-key>'{
"data": [
{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"status": "initial",
"documents": [
{
"document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"document_type": "passport"
}
],
"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"
}
]
}
},
"created_at": "2023-07-18T15:32:13.000Z",
"completed_at": "2023-07-18T15:32:13.000Z",
"verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
"verification_url_id": "VDBA1B2EA6A28A7D2",
"country_code": "DE",
"expires_at": "2023-07-18T15:32:13.000Z",
"poi_data": {
"parsed_type": "passport",
"has_mrz": true,
"raw_mrz_type": "P",
"country": "DEU",
"full_name": "John Doe",
"name": "John",
"surname": "Doe",
"document_number": "P-1234567890",
"nationality": "DEU",
"birth_date": "1983-03-21",
"sex": "M",
"expiry_date": "2021-02-24",
"issue_date": "2021-02-24",
"pin": "<string>",
"card_number": "<string>",
"license_number": "<string>",
"license_type": "<string>",
"license_class": "<string>",
"cpf_number": "<string>",
"vin": "<string>",
"nin": "<string>",
"occupation": "<string>",
"polling_unit": "<string>",
"region": "<string>",
"restrictions": "<string>",
"height": "<string>",
"registration_date": "<string>",
"parents_names": "<string>",
"endorsements": "<string>"
},
"is_sandbox": false,
"profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"settings": {
"poi_required": true,
"poi_allowed_documents": [
"passport"
],
"face_comparison_required": true,
"face_comparison_allowed_documents": [
"selfie"
],
"poa_required": false,
"disable_cross_check_by_bio": false,
"disable_cross_check_by_photo": false,
"disable_verify_poa_country_match_with_poi": false,
"countries": [
"FR"
],
"allow_poi_manual_uploads": false,
"allow_desktop": false,
"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>"
}
}
},
"aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
"manual_fields": {
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"dob": "<string>",
"gender": "M",
"citizenship": "<string>",
"address": "<string>",
"custom_fields": {}
},
"custom_files": {}
}
],
"has_next": false
}Retrieve detailed information about an existing verification by providing existing Applicant ID as a URL parameter.
curl --request GET \
--url https://api.dataspike.io/api/v3/verifications/applicant/{applicant_id} \
--header 'ds-api-token: <api-key>'{
"data": [
{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"status": "initial",
"documents": [
{
"document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"document_type": "passport"
}
],
"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"
}
]
}
},
"created_at": "2023-07-18T15:32:13.000Z",
"completed_at": "2023-07-18T15:32:13.000Z",
"verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
"verification_url_id": "VDBA1B2EA6A28A7D2",
"country_code": "DE",
"expires_at": "2023-07-18T15:32:13.000Z",
"poi_data": {
"parsed_type": "passport",
"has_mrz": true,
"raw_mrz_type": "P",
"country": "DEU",
"full_name": "John Doe",
"name": "John",
"surname": "Doe",
"document_number": "P-1234567890",
"nationality": "DEU",
"birth_date": "1983-03-21",
"sex": "M",
"expiry_date": "2021-02-24",
"issue_date": "2021-02-24",
"pin": "<string>",
"card_number": "<string>",
"license_number": "<string>",
"license_type": "<string>",
"license_class": "<string>",
"cpf_number": "<string>",
"vin": "<string>",
"nin": "<string>",
"occupation": "<string>",
"polling_unit": "<string>",
"region": "<string>",
"restrictions": "<string>",
"height": "<string>",
"registration_date": "<string>",
"parents_names": "<string>",
"endorsements": "<string>"
},
"is_sandbox": false,
"profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"settings": {
"poi_required": true,
"poi_allowed_documents": [
"passport"
],
"face_comparison_required": true,
"face_comparison_allowed_documents": [
"selfie"
],
"poa_required": false,
"disable_cross_check_by_bio": false,
"disable_cross_check_by_photo": false,
"disable_verify_poa_country_match_with_poi": false,
"countries": [
"FR"
],
"allow_poi_manual_uploads": false,
"allow_desktop": false,
"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>"
}
}
},
"aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
"manual_fields": {
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"dob": "<string>",
"gender": "M",
"citizenship": "<string>",
"address": "<string>",
"custom_fields": {}
},
"custom_files": {}
}
],
"has_next": false
}Fetch Verifications by Applicant ID
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Current page
Limit of returned items per page