Create verification
curl --request POST \
--url https://api.beltic.com/v1/identity/verifications \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "verification/idv",
"relationships": {
"session": {
"data": {
"type": "session",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"document": {
"data": {
"type": "document/idv",
"id": "223e4567-e89b-12d3-a456-426614174000"
}
}
},
"meta": {
"auto_update_session": true
}
}
}
'import requests
url = "https://api.beltic.com/v1/identity/verifications"
payload = { "data": {
"type": "verification/idv",
"relationships": {
"session": { "data": {
"type": "session",
"id": "123e4567-e89b-12d3-a456-426614174000"
} },
"document": { "data": {
"type": "document/idv",
"id": "223e4567-e89b-12d3-a456-426614174000"
} }
},
"meta": { "auto_update_session": True }
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'verification/idv',
relationships: {
session: {data: {type: 'session', id: '123e4567-e89b-12d3-a456-426614174000'}},
document: {data: {type: 'document/idv', id: '223e4567-e89b-12d3-a456-426614174000'}}
},
meta: {auto_update_session: true}
}
})
};
fetch('https://api.beltic.com/v1/identity/verifications', 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.beltic.com/v1/identity/verifications",
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([
'data' => [
'type' => 'verification/idv',
'relationships' => [
'session' => [
'data' => [
'type' => 'session',
'id' => '123e4567-e89b-12d3-a456-426614174000'
]
],
'document' => [
'data' => [
'type' => 'document/idv',
'id' => '223e4567-e89b-12d3-a456-426614174000'
]
]
],
'meta' => [
'auto_update_session' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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.beltic.com/v1/identity/verifications"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<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.beltic.com/v1/identity/verifications")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {},
"meta": {}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}Identity API — Verifications (Legacy)
Create Verification
Create a new verification request. Processing is performed synchronously.
The data.type field determines the verification type and must be one of:
verification/idv: Identity document verification (requires adocument/idvrelationship)verification/address: Address document verification (requires adocument/addressrelationship)verification/business: Business verification / KYB (requires abusinessrelationship)
The session relationship is optional. When meta.auto_update_session is true, a session must be provided and will be updated with the extracted data upon a passing verification.
Meta options:
auto_update_session: Whentrueand the verification passes, the session is automatically updated with the extracted information. Requires asessionrelationship.
POST
/
v1
/
identity
/
verifications
Create verification
curl --request POST \
--url https://api.beltic.com/v1/identity/verifications \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "verification/idv",
"relationships": {
"session": {
"data": {
"type": "session",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"document": {
"data": {
"type": "document/idv",
"id": "223e4567-e89b-12d3-a456-426614174000"
}
}
},
"meta": {
"auto_update_session": true
}
}
}
'import requests
url = "https://api.beltic.com/v1/identity/verifications"
payload = { "data": {
"type": "verification/idv",
"relationships": {
"session": { "data": {
"type": "session",
"id": "123e4567-e89b-12d3-a456-426614174000"
} },
"document": { "data": {
"type": "document/idv",
"id": "223e4567-e89b-12d3-a456-426614174000"
} }
},
"meta": { "auto_update_session": True }
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'verification/idv',
relationships: {
session: {data: {type: 'session', id: '123e4567-e89b-12d3-a456-426614174000'}},
document: {data: {type: 'document/idv', id: '223e4567-e89b-12d3-a456-426614174000'}}
},
meta: {auto_update_session: true}
}
})
};
fetch('https://api.beltic.com/v1/identity/verifications', 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.beltic.com/v1/identity/verifications",
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([
'data' => [
'type' => 'verification/idv',
'relationships' => [
'session' => [
'data' => [
'type' => 'session',
'id' => '123e4567-e89b-12d3-a456-426614174000'
]
],
'document' => [
'data' => [
'type' => 'document/idv',
'id' => '223e4567-e89b-12d3-a456-426614174000'
]
]
],
'meta' => [
'auto_update_session' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <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.beltic.com/v1/identity/verifications"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<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.beltic.com/v1/identity/verifications")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"verification/idv\",\n \"relationships\": {\n \"session\": {\n \"data\": {\n \"type\": \"session\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\n }\n },\n \"document\": {\n \"data\": {\n \"type\": \"document/idv\",\n \"id\": \"223e4567-e89b-12d3-a456-426614174000\"\n }\n }\n },\n \"meta\": {\n \"auto_update_session\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {},
"meta": {}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Body
application/json
- verification/idv
- verification/address
- verification/business
Show child attributes
Show child attributes
Example:
{
"type": "verification/idv",
"relationships": {
"session": {
"data": {
"type": "session",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"document": {
"data": {
"type": "document/idv",
"id": "223e4567-e89b-12d3-a456-426614174000"
}
}
},
"meta": { "auto_update_session": true }
}
Response
Verification created and processed successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I