curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/biometric-verifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"provider": "CELCOIN",
"subject_document_number": "811.464.310-23",
"redirect_url": "https://app.example.com/onboarding/done"
}
'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/biometric-verifications"
payload = {
"provider": "CELCOIN",
"subject_document_number": "811.464.310-23",
"redirect_url": "https://app.example.com/onboarding/done"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
provider: 'CELCOIN',
subject_document_number: '811.464.310-23',
redirect_url: 'https://app.example.com/onboarding/done'
})
};
fetch('https://api-sandbox.rinne.com.br/core/v1/biometric-verifications', 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/biometric-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'CELCOIN',
'subject_document_number' => '811.464.310-23',
'redirect_url' => 'https://app.example.com/onboarding/done'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.rinne.com.br/core/v1/biometric-verifications"
payload := strings.NewReader("{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.rinne.com.br/core/v1/biometric-verifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/biometric-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}"
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"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"status": 400,
"details": {
"issues": [
{
"field": "email",
"type": "REQUIRED",
"message": "Field 'email' is required",
"value": "invalid_value",
"constraints": {
"min": 18,
"max": 120
}
}
]
},
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"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": "CONFLICT_ERROR",
"message": "A BiometricVerification with this subject_document_number already exists",
"status": 409,
"details": {
"pending_verification_id": "2b6f0a5e-7c1d-4f1a-9a3e-2d0c1b7e8f90"
}
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Start a biometric verification
Requires the biometric-verification.create permission.
Starts a liveness capture of the authenticated company’s contact at the provider and returns the provider’s own capture URL
(verification_url), to be handed to the person as is; verification_url_expires_at is Rinne’s clock
plus the lifetime the provider granted. The result arrives through the
biometric-verification.status-changed webhook event: APPROVED stores the selfie as a SELFIE
onboarding document and the provider’s evidence package; REPROVED carries the provider’s
rejection_reason and stores the evidence package only.
provider must offer biometric verifications (today CELCOIN); any other answers 400 on
provider. subject_document_number must be the authenticated company’s contact’s document number; anyone else answers
400 on subject_document_number. One verification per person and provider is pending at a time:
a second request answers 409 with details.pending_verification_id.
curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/biometric-verifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"provider": "CELCOIN",
"subject_document_number": "811.464.310-23",
"redirect_url": "https://app.example.com/onboarding/done"
}
'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/biometric-verifications"
payload = {
"provider": "CELCOIN",
"subject_document_number": "811.464.310-23",
"redirect_url": "https://app.example.com/onboarding/done"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
provider: 'CELCOIN',
subject_document_number: '811.464.310-23',
redirect_url: 'https://app.example.com/onboarding/done'
})
};
fetch('https://api-sandbox.rinne.com.br/core/v1/biometric-verifications', 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/biometric-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider' => 'CELCOIN',
'subject_document_number' => '811.464.310-23',
'redirect_url' => 'https://app.example.com/onboarding/done'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.rinne.com.br/core/v1/biometric-verifications"
payload := strings.NewReader("{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.rinne.com.br/core/v1/biometric-verifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/biometric-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"CELCOIN\",\n \"subject_document_number\": \"811.464.310-23\",\n \"redirect_url\": \"https://app.example.com/onboarding/done\"\n}"
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"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"status": 400,
"details": {
"issues": [
{
"field": "email",
"type": "REQUIRED",
"message": "Field 'email' is required",
"value": "invalid_value",
"constraints": {
"min": 18,
"max": 120
}
}
]
},
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}{
"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": "CONFLICT_ERROR",
"message": "A BiometricVerification with this subject_document_number already exists",
"status": 409,
"details": {
"pending_verification_id": "2b6f0a5e-7c1d-4f1a-9a3e-2d0c1b7e8f90"
}
}
}{
"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
Body
The provider that runs the capture; it must offer biometric verifications
CELCOIN "CELCOIN"
The document number (CPF) of the company's contact; punctuation is ignored
"811.464.310-23"
Where the provider sends the person after the capture
"https://app.example.com/onboarding/done"
Response
The verification, PENDING, with the provider's capture URL
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"

