Skip to main content
POST
/
api
/
v3
/
sdk
/
{short_id}
/
fields
Set custom fields for applicant by short verification id
curl --request POST \
  --url https://api.dataspike.io/api/v3/sdk/{short_id}/fields \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '
{
  "full_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "country": "<string>",
  "dob": "<string>",
  "citizenship": "<string>",
  "address": "<string>",
  "custom_fields": {}
}
'
import requests

url = "https://api.dataspike.io/api/v3/sdk/{short_id}/fields"

payload = {
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"country": "<string>",
"dob": "<string>",
"citizenship": "<string>",
"address": "<string>",
"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: '<string>',
email: '<string>',
phone: '<string>',
country: '<string>',
dob: '<string>',
citizenship: '<string>',
address: '<string>',
custom_fields: {}
})
};

fetch('https://api.dataspike.io/api/v3/sdk/{short_id}/fields', 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/sdk/{short_id}/fields",
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' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'country' => '<string>',
'dob' => '<string>',
'citizenship' => '<string>',
'address' => '<string>',
'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/sdk/{short_id}/fields"

payload := strings.NewReader("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"address\": \"<string>\",\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/sdk/{short_id}/fields")
.header("ds-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_fields\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.dataspike.io/api/v3/sdk/{short_id}/fields")

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\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"address\": \"<string>\",\n \"custom_fields\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>"
}

Authorizations

ds-api-token
string
header
required

Path Parameters

short_id
string
required

Existing Verification Short Id

Example:

"VDBA1B2EA6A28A7D2"

Body

application/json

Custom fields values

full_name
string
email
string
phone
string
country
string
dob
string

Date of birth.

gender
enum<string>
Available options:
M,
F
citizenship
string
address
string
custom_fields
object

Key - value object, values can be only strings

Response

200 - application/json

Updated

Response with message

message
string
required