Skip to main content
GET
/
api
/
v3
/
applicants
List existing 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": "DE",
            "city": "Berlin",
            "postal_code": "10999",
            "street": "Wiener Straße 17"
          }
        },
        "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": "DE",
            "city": "Berlin",
            "postal_code": "10999",
            "street": "Wiener Straße 17"
          }
        },
        "custom_fields": {}
      },
      "last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      "aml_screening_enabled": false,
      "last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      "last_screened_at": "2023-07-18T15:32:13.000Z",
      "last_tags": [],
      "tg_profile": "1234567890",
      "search_options": {
        "risk_scores": [],
        "tags": [],
        "sources": [
          "<string>"
        ],
        "fuzziness": true,
        "fuzziness_level": 1,
        "phonetics": true,
        "mode": 0
      }
    }
  ],
  "has_next": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.dataspike.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
ds-api-token
string
header
required

Query Parameters

​
page
integer
default:0

Current page

​
limit
integer
default:10

Limit of returned applicants per page

Response

200 - application/json

List of the applicants

​
data
object[]
required

Object contains a list of an existing Applicant profiles

Object contains detailed information about the requested applicant, including various attributes associated with the applicant`s profile, facilitating a comprehensive understanding of their data.

​
has_next
boolean
default:false

This property serves as an indicator of whether there is a next page available in the paginated result