Set custom fields for applicant by short verification id

This endpoint should be use for setup custom fields for applicant from SDK.

POST /api/v3/sdk/{short_id}/fields

Set custom fields for applicant by short verification id

cURL

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

200

{
  "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