Get One Check's Document Requests
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests', 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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests",
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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests"
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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests")
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{
"status_code": 123,
"data": {
"check_type": "<string>",
"subject_scope": "<string>",
"subject_name": "<string>",
"has_open_request": false,
"kyc_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyb_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requests": [
{
"status": "open",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outstanding_required": 0,
"note": "<string>",
"requested_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancel_reason": "<string>",
"items": [
{
"label": "<string>",
"kind": "text",
"key": "<string>",
"required": true,
"responded": false,
"help": "<string>",
"text": "<string>",
"file_name": "<string>",
"download_url": "<string>",
"expires_in": 123,
"submitted_at": "2023-11-07T05:31:56Z"
}
]
}
]
},
"query_generated_time": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get One Check's Document Requests
Get everything we have asked for on one verification check, newest request first. Documents you have already sent come back as short-lived download links. Use the key on each item to name your file parts when you answer.
GET
/
v1
/
platform
/
compliance
/
checks
/
{check_id}
/
document-requests
Get One Check's Document Requests
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests', 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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests",
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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests"
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-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/compliance/checks/{check_id}/document-requests")
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{
"status_code": 123,
"data": {
"check_type": "<string>",
"subject_scope": "<string>",
"subject_name": "<string>",
"has_open_request": false,
"kyc_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyb_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subject_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requests": [
{
"status": "open",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outstanding_required": 0,
"note": "<string>",
"requested_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancel_reason": "<string>",
"items": [
{
"label": "<string>",
"kind": "text",
"key": "<string>",
"required": true,
"responded": false,
"help": "<string>",
"text": "<string>",
"file_name": "<string>",
"download_url": "<string>",
"expires_in": 123,
"submitted_at": "2023-11-07T05:31:56Z"
}
]
}
]
},
"query_generated_time": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The verification check's ID — the kyc_record_id or kyb_record_id from the list endpoint, from a compliance_documents.* webhook, or from the user_kyc.* / user_kyb.* verification webhooks. They are all the same value.
Example:
"9f0b1c2d-3e4f-5061-7283-94a5b6c7d8e9"

