Skip to main content
POST
/
api
/
v3
/
profiles
/
{profile_id}
/
link
Create verification public link
curl --request POST \
  --url https://api.dataspike.io/api/v3/profiles/{profile_id}/link \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '{
  "expiration_in_minutes": 240,
  "manual_field_settings": {
    "enabled": true,
    "description": "<string>",
    "full_name": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "email": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "phone": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "country": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "dob": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "gender": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "citizenship": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "address": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "certificate_of_incorporation": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "ownership_document": {
      "enabled": true,
      "caption": "<string>",
      "order": 123,
      "optional": true
    },
    "custom_fields": [
      {
        "label": "<string>",
        "caption": "<string>",
        "order": 123,
        "options": {
          "choices": [
            "<string>"
          ],
          "type": "<string>"
        }
      }
    ]
  },
  "finish_screen_settings": {
    "enabled": true,
    "settings": {
      "title": "<string>",
      "main_text": "<string>",
      "redirect_warning": "<string>",
      "cta": "<string>",
      "redirect_link": "<string>"
    }
  }
}'
{
  "link_id": "LI2V0BVmLfGFQZbZQ3B7CeH3"
}

Authorizations

ds-api-token
string
header
required

Path Parameters

profile_id
string<uuid>
required

Existing profile id

Example:

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

Body

application/json

Verification Link payload

expiration_in_minutes
integer
default:240

Verification created with this link will have this expiration.

Example:

240

manual_field_settings
object

This settings has migrated to VerificationProfileSettings

finish_screen_settings
object

This settings has migrated to VerificationProfileSettings

Response

Link successfully created

Link id properties

Unique id of link. Participated in public url.

Example:

"LI2V0BVmLfGFQZbZQ3B7CeH3"