Authorizations
Body
application/json
Response
200 - application/json
Return profile id
Id of entity response
Id of entity
Example:
"01827ed5-c228-7a3c-9a31-7ab7cc169d13"
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",
"description": "description of profile.",
"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>"
}
}
}
}'{
"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",
"description": "description of profile.",
"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>"
}
}
}
}'{
"id": "01827ed5-c228-7a3c-9a31-7ab7cc169d13"
}Return profile id
Id of entity response
Id of entity
"01827ed5-c228-7a3c-9a31-7ab7cc169d13"