curl --request POST \
--url https://api.dataspike.io/api/v3/profiles \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"name": "name for profile",
"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>"
}
}
},
"description": "description of profile."
}
'{
"id": "01827ed5-c228-7a3c-9a31-7ab7cc169d13"
}Create verification profile
curl --request POST \
--url https://api.dataspike.io/api/v3/profiles \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"name": "name for profile",
"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>"
}
}
},
"description": "description of profile."
}
'{
"id": "01827ed5-c228-7a3c-9a31-7ab7cc169d13"
}Create Verification Profile Request
"name for profile"
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
"description of profile."
Return profile id
Id of entity response
Id of entity
"01827ed5-c228-7a3c-9a31-7ab7cc169d13"