Skip to main content
POST
/
api
/
v3
/
sdk
/
{short_id}
/
proceed
Proceed with an existing Verification
curl --request POST \
  --url https://api.dataspike.io/api/v3/sdk/{short_id}/proceed \
  --header 'ds-api-token: <api-key>'
import requests

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

headers = {"ds-api-token": "<api-key>"}

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

print(response.text)
const options = {method: 'POST', headers: {'ds-api-token': '<api-key>'}};

fetch('https://api.dataspike.io/api/v3/sdk/{short_id}/proceed', 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}/proceed",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

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

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

req.Header.Add("ds-api-token", "<api-key>")

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}/proceed")
.header("ds-api-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "VDBA1B2EA6A28A7D2",
  "checks": {
    "document_mrz": {
      "data": {
        "document_type": "P",
        "country": "DEU",
        "name": "John",
        "surname": "Doe",
        "doc_number": "P-1234567890",
        "nationality": "DEU",
        "birth_date": "1983-03-21",
        "sex": "M",
        "expiry_date": "2021-02-24"
      },
      "pending_documents": [],
      "errors": [
        {
          "code": 1001,
          "message": "document parsing failed"
        }
      ]
    },
    "face_comparison": {
      "pending_documents": [],
      "errors": [
        {
          "code": 1001,
          "message": "document parsing failed"
        }
      ]
    },
    "poa": {
      "pending_documents": [],
      "errors": [
        {
          "code": 1001,
          "message": "document parsing failed"
        }
      ]
    },
    "liveness": {
      "data": {
        "estimated_age": 37,
        "age_interval": [
          32,
          45
        ]
      },
      "pending_documents": [],
      "errors": [
        {
          "code": 1001,
          "message": "document parsing failed"
        }
      ]
    }
  },
  "expires_at": "2023-07-18T15:32:13.000Z",
  "settings": {
    "poi_required": true,
    "poi_allowed_documents": [],
    "face_comparison_required": true,
    "face_comparison_allowed_documents": [],
    "poa_required": false,
    "allow_poi_manual_uploads": false,
    "allow_desktop": false,
    "disable_cross_check_by_bio": false,
    "disable_cross_check_by_photo": false,
    "disable_verify_poa_country_match_with_poi": false,
    "countries": [
      "FR"
    ],
    "ui_settings": {},
    "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>"
      }
    }
  },
  "redirect_url": "https://example.org/redirect",
  "country_code": "DE"
}
{
"pending_documents": [],
"message": "<string>"
}

Authorizations

ds-api-token
string
header
required

Path Parameters

short_id
string
required

Existing Verification Short Id

Example:

"VDBA1B2EA6A28A7D2"

Response

Verification response

Minimized Verification Object used for SDK

id
string
required

Short verification id

Example:

"VDBA1B2EA6A28A7D2"

status
enum<string>
required
Available options:
active,
expired,
completed
checks
object
required

Object describes required checks and it`s current status

expires_at
string<ISO-8601>
required

Verification expiration timestamp

Example:

"2023-07-18T15:32:13.000Z"

settings
object | null
required

Verification profile settings

redirect_url
string

merchant's website reidrect url on completion

Example:

"https://example.org/redirect"

country_code
string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

Example:

"DE"