Get ID Verification images
curl --request GET \
--url http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image \
--header 'Authorization: Bearer <token>'import requests
url = "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image', 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 => "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image",
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 := "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image"
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("http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyID Verification
Get ID Verification images
Download document front and back images for an ID Verification β in the gu1 KYC API for identity verification flows, with examples for id verification images.
GET
/
api
/
kyc
/
id-verification
/
verifications
/
{id}
/
document-front-image
Get ID Verification images
curl --request GET \
--url http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image \
--header 'Authorization: Bearer <token>'import requests
url = "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image', 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 => "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image",
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 := "http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image"
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("http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/api/kyc/id-verification/verifications/{id}/document-front-image")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyOverview
After ID Verification (POST), you can download the front (and, when applicable, back) document images using the GET endpoints below. Put the verificationid in the pathβthe same UUID as verificationId in the POST response or id from list / GET one. No extra query parameters. Same Authorization: Bearer and read KYC permission as the other ID Verification routes.
Use the back endpoint only when that verification actually included a back image; otherwise you may get 404.
Endpoints
Document front
GET https://api.gu1.ai/api/kyc/id-verification/verifications/{verificationId}/document-front-image
Document back
GET https://api.gu1.ai/api/kyc/id-verification/verifications/{verificationId}/document-back-image
Path parameters
string
required
UUID of the ID verification (same as
verificationId from POST or id from list/GET one).Headers
Authorization:Bearer YOUR_API_KEY(required)
X-Organization-Id if your account is organization-scoped.
Responses
| HTTP | Description |
|---|---|
| 200 | Raw image bytes (Content-Type e.g. image/jpeg). |
| 404 | Verification not found, not in your organization, or that image is not available for download. |
Examples
curl -sS -o front.jpg \
-H "Authorization: Bearer YOUR_API_KEY" \
"https://api.gu1.ai/api/kyc/id-verification/verifications/VERIFICATION_UUID/document-front-image"
curl -sS -o back.jpg \
-H "Authorization: Bearer YOUR_API_KEY" \
"https://api.gu1.ai/api/kyc/id-verification/verifications/VERIFICATION_UUID/document-back-image"
Related
Was this page helpful?