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": {},
  "custom_fields": {}
}
'

import requests

url = "https://api.dataspike.io/api/v3/applicants/{applicant_id}"

payload = {
    "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": {},
    "custom_fields": {}
}
headers = {
    "ds-api-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {},
    custom_fields: {}
  })
};

fetch('https://api.dataspike.io/api/v3/applicants/{applicant_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dataspike.io/api/v3/applicants/{applicant_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ],
    'custom_fields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "ds-api-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dataspike.io/api/v3/applicants/{applicant_id}"

	payload := strings.NewReader("{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ds-api-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dataspike.io/api/v3/applicants/{applicant_id}")
  .header("ds-api-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dataspike.io/api/v3/applicants/{applicant_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}"

response = http.request(request)
puts response.read_body

POST

api

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": {},
  "custom_fields": {}
}
'

import requests

url = "https://api.dataspike.io/api/v3/applicants/{applicant_id}"

payload = {
    "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": {},
    "custom_fields": {}
}
headers = {
    "ds-api-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {},
    custom_fields: {}
  })
};

fetch('https://api.dataspike.io/api/v3/applicants/{applicant_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dataspike.io/api/v3/applicants/{applicant_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ],
    'custom_fields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "ds-api-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dataspike.io/api/v3/applicants/{applicant_id}"

	payload := strings.NewReader("{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ds-api-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dataspike.io/api/v3/applicants/{applicant_id}")
  .header("ds-api-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dataspike.io/api/v3/applicants/{applicant_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"full_name\": \"John Doe\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"dob\": \"1987-12-24T00:00:00.000Z\",\n  \"gender\": \"M\",\n  \"citizenship\": \"DE\",\n  \"country\": \"DE\",\n  \"address\": \"Paris, France\",\n  \"addresses\": {},\n  \"custom_fields\": {}\n}"

response = http.request(request)
puts response.read_body

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.

Show child attributes

custom_fields

object

Key - value object, values can be only strings

Response

Applicant updated

Get Existing Applicant

Delete Existing Applicant

API documentation

KYT

Update applicant info

Authorizations

Path Parameters

Body

Response