Skip to main content
POST
Answer an onboarding requirement

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

id
string<uuid>
required

The requirement ID

Body

application/json
text
string

The answer; surrounding whitespace is trimmed. Required for INFORMATION; optional for EVIDENCE_PACKAGE, whose attachments may carry the answer

Maximum string length: 10000
Example:

"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

id
string<uuid>
required
Example:

"7f3d9c2a-5b1e-4c8d-9a6f-0e2b4d6c8a10"

company_id
string
required

The company the requirement applies to (the organization itself or one of its merchants)

Example:

"c0a8012e-4d3b-4a6e-8f1b-1a2b3c4d5e6f"

provider
enum<string>
required
Available options:
CELCOIN,
CAPPTA
Example:

"CELCOIN"

type
enum<string>
required

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.

Available options:
IDENTITY_DOCUMENT,
BIOMETRIC_VERIFICATION,
ARTICLES_OF_INCORPORATION,
POWER_OF_ATTORNEY,
PROOF_OF_ADDRESS,
PROOF_OF_INCOME,
FINANCIAL_STATEMENT,
INFORMATION,
EVIDENCE_PACKAGE,
OTHER
Example:

"IDENTITY_DOCUMENT"

subject_document_number
string
required

Whom the requirement is about, digits only (a CPF or a CNPJ)

Example:

"81146431023"

subject_role
enum<string>
required

The subject's role for the company

Available options:
COMPANY,
CONTACT,
PARTNER_COMPANY
Example:

"CONTACT"

origin
enum<string>
required

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

Available options:
BASE,
PROVIDER_REQUEST,
STAFF
Example:

"BASE"

description
string | null
required

What is being asked, for PROVIDER_REQUEST and STAFF rows; null on BASE rows

Example:

null

status
enum<string>
required

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).

Available options:
PENDING,
SATISFIED,
REJECTED,
WAIVED
Example:

"PENDING"

accepted_document_types
enum<string>[] | null
required

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

Available options:
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
Example:
satisfied_by
object | null
required

The evidence that meets it; null unless SATISFIED

waived_at
string<date-time> | null
required
Example:

null

created_at
string<date-time>
required
Example:

"2026-10-09T12:00:00.000Z"

updated_at
string<date-time>
required
Example:

"2026-10-09T12:00:00.000Z"