curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"text": "The business sells coffee and pastries to walk-in customers."
}
'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer"
payload = { "text": "The business sells coffee and pastries to walk-in customers." }
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({text: 'The business sells coffee and pastries to walk-in customers.'})
};
fetch('https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer', 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/onboarding-requirements/{id}/answer",
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([
'text' => 'The business sells coffee and pastries to walk-in customers.'
]),
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/onboarding-requirements/{id}/answer"
payload := strings.NewReader("{\n \"text\": \"The business sells coffee and pastries to walk-in customers.\"\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/onboarding-requirements/{id}/answer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"The business sells coffee and pastries to walk-in customers.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer")
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 \"text\": \"The business sells coffee and pastries to walk-in customers.\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7f3d9c2a-5b1e-4c8d-9a6f-0e2b4d6c8a10",
"company_id": "c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f",
"provider": "CELCOIN",
"type": "IDENTITY_DOCUMENT",
"subject_document_number": "81146431023",
"subject_role": "CONTACT",
"origin": "BASE",
"description": null,
"status": "PENDING",
"accepted_document_types": [
"CNH_DIGITAL",
"CNH_FRONT",
"CNH_BACK",
"RG_FRONT",
"RG_BACK",
"RNE_FRONT",
"RNE_BACK"
],
"satisfied_by": {
"onboarding_document_ids": [
"9c1e7b3a-2d4f-4a6b-8c0d-5e7f9a1b3c2d"
],
"biometric_verification_id": null,
"answer": null
},
"waived_at": null,
"created_at": "2026-10-09T12:00:00.000Z",
"updated_at": "2026-10-09T12: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": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}Answer an onboarding requirement
Requires the onboarding-requirement.edit permission.
Answers an INFORMATION or EVIDENCE_PACKAGE requirement of the company and returns the row resolved. An
INFORMATION requirement needs text. An EVIDENCE_PACKAGE collects files first — uploads that name
it in requirement_id — and is closed by this call, with or without text; without text it needs at
least one completed attachment the provider has not refused. Once closed, the package takes no more
attachments until the provider refuses it. A later answer replaces the earlier one in the resolution.
Any other requirement type, and a waived one, answers 400 on requirement_id.
curl --request POST \
--url https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"text": "The business sells coffee and pastries to walk-in customers."
}
'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer"
payload = { "text": "The business sells coffee and pastries to walk-in customers." }
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({text: 'The business sells coffee and pastries to walk-in customers.'})
};
fetch('https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer', 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/onboarding-requirements/{id}/answer",
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([
'text' => 'The business sells coffee and pastries to walk-in customers.'
]),
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/onboarding-requirements/{id}/answer"
payload := strings.NewReader("{\n \"text\": \"The business sells coffee and pastries to walk-in customers.\"\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/onboarding-requirements/{id}/answer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"The business sells coffee and pastries to walk-in customers.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/onboarding-requirements/{id}/answer")
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 \"text\": \"The business sells coffee and pastries to walk-in customers.\"\n}"
response = http.request(request)
puts response.read_body{
"id": "7f3d9c2a-5b1e-4c8d-9a6f-0e2b4d6c8a10",
"company_id": "c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f",
"provider": "CELCOIN",
"type": "IDENTITY_DOCUMENT",
"subject_document_number": "81146431023",
"subject_role": "CONTACT",
"origin": "BASE",
"description": null,
"status": "PENDING",
"accepted_document_types": [
"CNH_DIGITAL",
"CNH_FRONT",
"CNH_BACK",
"RG_FRONT",
"RG_BACK",
"RNE_FRONT",
"RNE_BACK"
],
"satisfied_by": {
"onboarding_document_ids": [
"9c1e7b3a-2d4f-4a6b-8c0d-5e7f9a1b3c2d"
],
"biometric_verification_id": null,
"answer": null
},
"waived_at": null,
"created_at": "2026-10-09T12:00:00.000Z",
"updated_at": "2026-10-09T12: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": "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 requirement ID
Body
The answer; surrounding whitespace is trimmed. Required for INFORMATION; optional for EVIDENCE_PACKAGE, whose attachments may carry the answer
10000"The business sells coffee and pastries to walk-in customers."
Response
The requirement, resolved with the new answer
One thing a company must prove to a provider, with its status derived from the evidence Rinne holds
"7f3d9c2a-5b1e-4c8d-9a6f-0e2b4d6c8a10"
The company the requirement applies to (the organization itself or one of its merchants)
"c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f"
CELCOIN, CAPPTA "CELCOIN"
What meets it: IDENTITY_DOCUMENT a CNH_DIGITAL or the front and back of one identity document;
BIOMETRIC_VERIFICATION an approved biometric verification of the subject; ARTICLES_OF_INCORPORATION,
POWER_OF_ATTORNEY, PROOF_OF_ADDRESS, PROOF_OF_INCOME, FINANCIAL_STATEMENT and OTHER a document
of the same type; INFORMATION a text answer; EVIDENCE_PACKAGE files attached to it and closed by an answer.
IDENTITY_DOCUMENT, BIOMETRIC_VERIFICATION, ARTICLES_OF_INCORPORATION, POWER_OF_ATTORNEY, PROOF_OF_ADDRESS, PROOF_OF_INCOME, FINANCIAL_STATEMENT, INFORMATION, EVIDENCE_PACKAGE, OTHER "IDENTITY_DOCUMENT"
Whom the requirement is about, digits only (a CPF or a CNPJ)
"81146431023"
The subject's role for the company
COMPANY, CONTACT, PARTNER_COMPANY "CONTACT"
BASE from the provider's base set for the company's shape; PROVIDER_REQUEST from a provider's rejection review; STAFF added by Rinne staff
BASE, PROVIDER_REQUEST, STAFF "BASE"
What is being asked, for PROVIDER_REQUEST and STAFF rows; null on BASE rows
null
Derived at read time: PENDING with no usable evidence; SATISFIED with satisfied_by; REJECTED when the
only evidence is one the provider refused; WAIVED when staff waived it or the company's shape no longer
calls for it (waived_at set).
PENDING, SATISFIED, REJECTED, WAIVED "PENDING"
The document types that meet the requirement at this provider (the identity family for IDENTITY_DOCUMENT, the type of the same name otherwise, each only when the provider accepts it); null for a requirement no document meets
CNH_FRONT, CNH_BACK, CNH_DIGITAL, RG_FRONT, RG_BACK, RNE_FRONT, RNE_BACK, ARTICLES_OF_INCORPORATION, POWER_OF_ATTORNEY, PROOF_OF_ADDRESS, PROOF_OF_INCOME, FINANCIAL_STATEMENT, OTHER [
"CNH_DIGITAL",
"CNH_FRONT",
"CNH_BACK",
"RG_FRONT",
"RG_BACK",
"RNE_FRONT",
"RNE_BACK"
]
The evidence that meets it; null unless SATISFIED
Show child attributes
Show child attributes
null
"2026-10-09T12:00:00.000Z"
"2026-10-09T12:00:00.000Z"

