Handles `GET /v1/platform/catalog`.
curl --request GET \
--url https://api.example.com/v1/platform/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/platform/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/platform/catalog', 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.example.com/v1/platform/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.example.com/v1/platform/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/platform/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/platform/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"capabilities": [
{
"capture": {
"document_number_required": true
},
"code": "<string>",
"country": "<string>",
"country_name": "<string>",
"created_at": "<string>",
"display_name": "<string>",
"document_type": "PASSPORT",
"enabled": true,
"extraction_support": "AUTOMATED",
"revision": 1,
"updated_at": "<string>",
"reader": "NG_NIN_SLIP"
}
]
}Platform
Handles `GET /v1/platform/catalog`.
Errors
404 when no operator credential is configured, 401 without the
operator token, 503 when the store cannot be reached.
GET
/
v1
/
platform
/
catalog
Handles `GET /v1/platform/catalog`.
curl --request GET \
--url https://api.example.com/v1/platform/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/platform/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/platform/catalog', 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.example.com/v1/platform/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.example.com/v1/platform/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.example.com/v1/platform/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/platform/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"capabilities": [
{
"capture": {
"document_number_required": true
},
"code": "<string>",
"country": "<string>",
"country_name": "<string>",
"created_at": "<string>",
"display_name": "<string>",
"document_type": "PASSPORT",
"enabled": true,
"extraction_support": "AUTOMATED",
"revision": 1,
"updated_at": "<string>",
"reader": "NG_NIN_SLIP"
}
]
}Authorizations
The platform operator's token, from ESECTRA_PLATFORM_OPERATOR_TOKEN on the API. Administers the global verification catalog; it is not a tenant key and opens no tenant route. Absent on a deployment that has not set it, in which case the platform routes answer 404.
Response
Every entry, enabled or not
A catalog listing.
Entries, ordered by country then document type.
Show child attributes
Show child attributes