Skip to main content
An onboarding requirement is one thing a provider needs from a merchant before it can approve an affiliation: an identity document, a biometric verification, the articles of incorporation, an answer to a question. Requirements are the source of truth for what is missing. The affiliation status says who is waiting on whom; the requirements say exactly what is pending, for which person or merchant, and what would satisfy it. Read them with GET /v1/onboarding-requirements?provider=CELCOIN, or GET /v1/merchants/{merchantId}/onboarding-requirements?provider=CELCOIN for one of your merchants. provider must be a provider that onboards merchants through Rinne, CELCOIN or CAPPTA; any other answers 400.

​
Requirements belong to the merchant

A requirement belongs to a merchant, per provider, and outlives any single affiliation. That is what makes reuse automatic:
  • Created the first time Rinne evaluates the merchant for a provider (a requirements read, an affiliation creation or the link), and kept for as long as the merchant exists.
  • Satisfied the moment matching evidence exists, whichever way it arrived and whenever: before the affiliation, through the link, from an earlier attempt, or from another merchant of your organization where the same person appears.
  • Re-evaluated on every read. When the merchant changes shape, for example its contact becomes a REPRESENTATIVE, the next read adds what became required, waives what no longer applies, and restores a waived one that applies again.

​
What each provider requires

A natural person (PF) needs only the contact’s identity document and biometric verification, and so does a MEI whose contact is a PARTNER; a MEI represented by a REPRESENTATIVE also needs the POWER_OF_ATTORNEY. Anything else the provider asks for arrives as a new requirement after a rejection, and is collected for a new affiliation.
The same rules apply to every merchant; only its shape changes the list.

​
Requirement types

accepted_document_types lists the document types that satisfy each document requirement at that provider, and is null for the types no document satisfies (BIOMETRIC_VERIFICATION, INFORMATION, EVIDENCE_PACKAGE).

​
Who a requirement is about

subject_document_number is the CPF or CNPJ the requirement is about, digits only, and subject_role says who that is for the merchant: Upload each document under the subject the requirement names.

​
Status

A requirement is evaluated every time it is read. It becomes SATISFIED the moment a matching document is stored, a verification is approved or an answer is given, with no call on your side, and every affiliation waiting on it is re-evaluated at the same moment: the last item in submits it.

​
Origin

The base set holds one requirement per type and subject. Every request adds a requirement of its own, so two INFORMATION questions are two requirements with two answers.

​
The response

​
string
required
The requirement’s ID. Use it to answer an INFORMATION or EVIDENCE_PACKAGE requirement and to attach files to a package.
​
string
required
The merchant the requirement applies to.
​
string
required
CELCOIN or CAPPTA.
​
string
required
What is required. See Requirement types.
​
string
required
The CPF or CNPJ the requirement is about, digits only.
​
string
required
CONTACT, COMPANY or PARTNER_COMPANY.
​
string
required
BASE, PROVIDER_REQUEST or STAFF.
​
string | null
What is being asked, for PROVIDER_REQUEST and STAFF requirements; null on BASE ones.
​
string
required
PENDING, SATISFIED, REJECTED or WAIVED, derived at read time.
​
array | null
The document types that satisfy the requirement at this provider; null for a requirement no document satisfies.
​
object | null
The evidence that satisfies it; null unless SATISFIED.
​
string | null
When the requirement was waived.
A complete example response is in Build with the API.

​
Examples

CELCOIN requires the contact’s IDENTITY_DOCUMENT and BIOMETRIC_VERIFICATION and the merchant’s ARTICLES_OF_INCORPORATION. If the same partner was already verified in another merchant of your organization, only the identity document and the articles are pending.
Change the contact to the manager with role REPRESENTATIVE. The next read adds a POWER_OF_ATTORNEY requirement for the merchant, and the identity document and biometric verification are now about the manager.
CELCOIN requires only the person’s IDENTITY_DOCUMENT and BIOMETRIC_VERIFICATION. There is no merchant document to send.
After Rinne reviews the request, the merchant has a new EVIDENCE_PACKAGE requirement with origin PROVIDER_REQUEST and a description such as “Show that the business operates at the registered address”. Attach a storefront photo and a map print, then answer it with a short explanation.