Skip to main content
POST
/
api
/
v3
/
applicants
/
{applicant_id}
Update applicant info
curl --request POST \
  --url https://api.dataspike.io/api/v3/applicants/{applicant_id} \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '{
  "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": {}
}'

Authorizations

​
ds-api-token
string
header
required

Path Parameters

​
applicant_id
string<uuid>
required

Existing applicant id

Example:

"01827ed5-c228-7a3c-9a31-7ab7cc169d13"

Body

application/json

Applicant info

  • Option 1
  • Option 2

This object allows you to include any supplementary information about the applicant, such as their first, last name or citizenship.

​
full_name
string

Full Person name, if not specified will fallback to first_name and last name

Example:

"John Doe"

​
first_name
string

First name

Example:

"John"

​
last_name
string

Last name

Example:

"Doe"

​
dob
string<ISO-8601>

Date of birth in ISO-8601 format

Example:

"1987-12-24T00:00:00.000Z"

​
gender
enum<string>

gender that is used in official documents

Available options:
M,
F
Example:

"M"

​
citizenship
string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

Example:

"DE"

​
country
string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

Example:

"DE"

​
address
string

Applicant address, could be used for any type of applicants

Example:

"Paris, France"

​
addresses
object

List of applicant addresses, only residence for now.

​
custom_fields
object

Key - value object, values can be only strings

Response

Applicant updated