Get government ID document
curl --request GET \
--url https://api.beltic.com/v1/identity/documents/idvs/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.beltic.com/v1/identity/documents/idvs/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.beltic.com/v1/identity/documents/idvs/{id}', 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/documents/idvs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beltic.com/v1/identity/documents/idvs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beltic.com/v1/identity/documents/idvs/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/documents/idvs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/idv",
"attributes": {
"document_type": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"sex": "<string>",
"birth_date": "<string>",
"birth_place": "<string>",
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"personal_number": "<string>",
"document_class": "<string>",
"issuing_country": "<string>",
"place_of_issue": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
],
"front_side": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"back_side": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"portrait": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"signature": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}Identity API — Document IDVs (Legacy)
Get Document IDV
Retrieve a single government ID verification document by ID
GET
/
v1
/
identity
/
documents
/
idvs
/
{id}
Get government ID document
curl --request GET \
--url https://api.beltic.com/v1/identity/documents/idvs/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.beltic.com/v1/identity/documents/idvs/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.beltic.com/v1/identity/documents/idvs/{id}', 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/documents/idvs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beltic.com/v1/identity/documents/idvs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beltic.com/v1/identity/documents/idvs/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/documents/idvs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/idv",
"attributes": {
"document_type": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"sex": "<string>",
"birth_date": "<string>",
"birth_place": "<string>",
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"personal_number": "<string>",
"document_class": "<string>",
"issuing_country": "<string>",
"place_of_issue": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
],
"front_side": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"back_side": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"portrait": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"signature": {
"id": "<string>",
"filename": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
},
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Path Parameters
The unique identifier of the document
Example:
"123e4567-e89b-12d3-a456-426614174000"
Response
Successfully retrieved document
Show child attributes
Show child attributes
Was this page helpful?
⌘I