curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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{
"id": "2b6f0a5e-7c1d-4f1a-9a3e-2d0c1b7e8f90",
"company_id": "c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f",
"provider": "CELCOIN",
"subject_document_number": "81146431023",
"status": "PENDING",
"verification_url": "https://biometric.provider.example/session/abc",
"verification_url_expires_at": "2026-10-09T12:00:00.000Z",
"redirect_url": "https://app.example.com/onboarding/done",
"selfie_onboarding_document_id": null,
"approved_at": null,
"rejection_reason": {
"code": "RRU008",
"message": "Identity could not be confirmed during the biometric validation test"
},
"created_at": "2026-10-08T12:00:00.000Z",
"updated_at": "2026-10-08T12:00:00.000Z",
"evidence_download_url": "https://storage.googleapis.com/onboarding-documents/...",
"evidence_download_url_expires_at": "2026-10-08T13:00:00.000Z"
}{
"error": {
"code": "AUTHENTICATION_ERROR",
"message": "Authentication required to access this resource",
"status": 401,
"details": {
"reason": "Invalid API key"
},
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "AUTHORIZATION_ERROR",
"message": "You need 'admin' permissions to access this resource",
"status": 403,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Company with ID '123' not found",
"status": 404,
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Get a biometric verification
Requires the merchant.biometric-verification.view permission.
The response adds evidence_download_url and evidence_download_url_expires_at, a signed URL to the provider’s evidence package valid for one hour, null until the package is stored.
curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/biometric-verifications/{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{
"id": "2b6f0a5e-7c1d-4f1a-9a3e-2d0c1b7e8f90",
"company_id": "c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f",
"provider": "CELCOIN",
"subject_document_number": "81146431023",
"status": "PENDING",
"verification_url": "https://biometric.provider.example/session/abc",
"verification_url_expires_at": "2026-10-09T12:00:00.000Z",
"redirect_url": "https://app.example.com/onboarding/done",
"selfie_onboarding_document_id": null,
"approved_at": null,
"rejection_reason": {
"code": "RRU008",
"message": "Identity could not be confirmed during the biometric validation test"
},
"created_at": "2026-10-08T12:00:00.000Z",
"updated_at": "2026-10-08T12:00:00.000Z",
"evidence_download_url": "https://storage.googleapis.com/onboarding-documents/...",
"evidence_download_url_expires_at": "2026-10-08T13:00:00.000Z"
}{
"error": {
"code": "AUTHENTICATION_ERROR",
"message": "Authentication required to access this resource",
"status": 401,
"details": {
"reason": "Invalid API key"
},
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "AUTHORIZATION_ERROR",
"message": "You need 'admin' permissions to access this resource",
"status": 403,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Company with ID '123' not found",
"status": 404,
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Authorizations
Company API key for authentication
Path Parameters
The merchant ID
The biometric verification ID
Response
The verification
A biometric verification of a company contact at a provider
"2b6f0a5e-7c1d-4f1a-9a3e-2d0c1b7e8f90"
The company the verification was created for (the organization itself or one of its merchants)
"c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f"
CELCOIN "CELCOIN"
The verified person's document number (CPF), digits only
"81146431023"
PENDING until the provider reports the capture; APPROVED or REPROVED from its result;
EXPIRED when the capture URL expired with no result.
PENDING, APPROVED, REPROVED, EXPIRED "PENDING"
The provider's capture URL, to be handed to the person as is
"https://biometric.provider.example/session/abc"
When the capture URL stops working
"2026-10-09T12:00:00.000Z"
Where the provider sends the person after the capture, when given at creation
"https://app.example.com/onboarding/done"
The SELFIE onboarding document an APPROVED result produced; null otherwise
null
When the verification became APPROVED; null on any other status
null
The provider's reason for a REPROVED result; null otherwise
Show child attributes
Show child attributes
"2026-10-08T12:00:00.000Z"
"2026-10-08T12:00:00.000Z"
A signed URL to the provider's evidence package, valid for one hour. Returned to the
owner organization only; null for a merchant and until the package is stored.
"https://storage.googleapis.com/onboarding-documents/..."
When evidence_download_url stops working
"2026-10-08T13:00:00.000Z"

