Authorizations
Query Parameters
Current page
Limit of returned applicants per page
Response
200 - application/json
List of the applicants
curl --request GET \
--url https://api.dataspike.io/api/v3/applicants \
--header 'ds-api-token: <api-key>'{
"data": [
{
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"external_id": "external_user_id_123",
"type": "Person",
"email": "john.doe@example.org",
"phone": "+1234567890",
"system_info": {
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"dob": "1987-12-24T00:00:00.000Z",
"gender": "M",
"citizenship": "DE",
"country": "DE",
"address": "Paris, France",
"addresses": {
"residence": {
"country": "<any>",
"city": "<any>",
"postal_code": "<any>",
"street": "<any>"
}
},
"custom_fields": {}
},
"provided_info": {
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"dob": "1987-12-24T00:00:00.000Z",
"gender": "M",
"citizenship": "DE",
"country": "DE",
"address": "Paris, France",
"addresses": {
"residence": {
"country": "<any>",
"city": "<any>",
"postal_code": "<any>",
"street": "<any>"
}
},
"custom_fields": {}
},
"last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"verification_status": "initial",
"aml_screening_enabled": false,
"last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"last_screened_at": "2023-07-18T15:32:13.000Z",
"last_risk_score": "Low",
"last_tags": [
"Finance"
],
"tg_profile": "1234567890",
"search_options": {
"risk_scores": [
"Low"
],
"tags": [
"Finance"
],
"sources": [
"<string>"
],
"fuzziness": true,
"fuzziness_level": 0.5,
"phonetics": true,
"mode": 0
}
}
],
"has_next": false
}Allows to retrieve a collection of existing applicant profiles within the system.
curl --request GET \
--url https://api.dataspike.io/api/v3/applicants \
--header 'ds-api-token: <api-key>'{
"data": [
{
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"external_id": "external_user_id_123",
"type": "Person",
"email": "john.doe@example.org",
"phone": "+1234567890",
"system_info": {
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"dob": "1987-12-24T00:00:00.000Z",
"gender": "M",
"citizenship": "DE",
"country": "DE",
"address": "Paris, France",
"addresses": {
"residence": {
"country": "<any>",
"city": "<any>",
"postal_code": "<any>",
"street": "<any>"
}
},
"custom_fields": {}
},
"provided_info": {
"full_name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"dob": "1987-12-24T00:00:00.000Z",
"gender": "M",
"citizenship": "DE",
"country": "DE",
"address": "Paris, France",
"addresses": {
"residence": {
"country": "<any>",
"city": "<any>",
"postal_code": "<any>",
"street": "<any>"
}
},
"custom_fields": {}
},
"last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"verification_status": "initial",
"aml_screening_enabled": false,
"last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"last_screened_at": "2023-07-18T15:32:13.000Z",
"last_risk_score": "Low",
"last_tags": [
"Finance"
],
"tg_profile": "1234567890",
"search_options": {
"risk_scores": [
"Low"
],
"tags": [
"Finance"
],
"sources": [
"<string>"
],
"fuzziness": true,
"fuzziness_level": 0.5,
"phonetics": true,
"mode": 0
}
}
],
"has_next": false
}Current page
Limit of returned applicants per page
List of the applicants