List Documents

GET/documents

This endpoint allows API users to retrieve a list of documents they have uploaded for a specified individual or company.

Query Parameters

pageinteger

Specify the page number

per_pageinteger

Specify the number of items per page

Response

idstring<uuid>

external_idstring

A reference to the document given by API caller

owner_idstring<uuid>

The ID of an individual or company who owns the document.

category"identity_verification"

More categories will be added over time.

document_type"passport" | "national_id" | "selfie_photo" | "kyc_provider_result"

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

mime_typestring

The type kyc_provider_result can be used to upload reports from the 3rd party KYC providers.

file_namestring

file_idstring

status"none" | "valid" | "pending" | "rejected" | "expired"

expires_atstring<date-time>

Time of expiry of the validity of this identity document.

created_atstring<date-time>

updated_atstring<date-time>

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/documents"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.uat.triple-a.io/api/fiat-payout/v1/documents", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/documents")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/documents") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

[ { "id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "owner_id": "00000000-0000-0000-0000-000000000000", "category": "identity_verification", "document_type": "passport", "mime_type": "string", "file_name": "string", "file_id": "string", "status": "pending", "expires_at": "1970-01-01T00:00:00.000Z", "created_at": "1970-01-01T00:00:00.000Z", "updated_at": "1970-01-01T00:00:00.000Z" } ]