Skip to main content
POST
Complete an onboarding document upload

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

id
string<uuid>
required

The onboarding document ID

Response

The document was already completed; returned as it is

A document a company holds for a subject, as the list, read and complete responses carry it

id
string<uuid>
required
Example:

"9c1e7b3a-2d4f-4a6b-8c0d-5e7f9a1b3c2d"

company_id
string
required

The company the document was presented for (the organization itself or one of its merchants)

Example:

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

subject_document_number
string
required

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

Example:

"81146431023"

type
enum<string>
required

RNM_* and ID_DOCUMENT_* only arrive from a provider's capture; SELFIE from a capture or an upload

Available options:
CNH_FRONT,
CNH_BACK,
CNH_DIGITAL,
RG_FRONT,
RG_BACK,
RNE_FRONT,
RNE_BACK,
RNM_FRONT,
RNM_BACK,
ID_DOCUMENT_FRONT,
ID_DOCUMENT_BACK,
SELFIE,
ARTICLES_OF_INCORPORATION,
POWER_OF_ATTORNEY,
PROOF_OF_ADDRESS,
PROOF_OF_INCOME,
FINANCIAL_STATEMENT,
OTHER
Example:

"PROOF_OF_ADDRESS"

status
enum<string>
required

PENDING_UPLOAD until complete; NOT_VALIDATED once the file is recorded and until a provider judges it; VALIDATED when a provider accepted it; REJECTED once a provider refused it while none had accepted it (see rejections), while the providers that did not refuse it keep using it; a refusal does not undo VALIDATED, except on a SHARED reference, and a later acceptance turns REJECTED into VALIDATED; SUPERSEDED when a newer document of the same subject and type replaced it, when complete found its bytes already stored in another document (superseded_by_id), or when Rinne closed an upload whose URL expired with nothing received (superseded_by_id null).

Available options:
PENDING_UPLOAD,
NOT_VALIDATED,
VALIDATED,
REJECTED,
SUPERSEDED
Example:

"NOT_VALIDATED"

source
enum<string>
required

UPLOAD by the customer; PROVIDER from a provider's capture; SHARED a reference to a document another organization validated for the same subject

Available options:
UPLOAD,
PROVIDER,
SHARED
Example:

"UPLOAD"

requirement_id
string<uuid> | null
required

The EVIDENCE_PACKAGE requirement the document is attached to; null for every other document

Example:

null

file_name
string | null
required

The name given at upload, or the name the provider's capture produced; null on a SHARED document

Example:

"address.pdf"

content_type
string | null
required

The file's MIME type; null until the upload completes and on a SHARED document

Example:

"application/pdf"

file_size_bytes
integer | null
required

null until the upload completes and on a SHARED document

Example:

125430

upload_url_expires_at
string<date-time> | null
required

When the signed upload URL stops accepting the file; null once uploaded

Example:

null

rejections
object[]
required

In the list, read and complete responses, the provider refusals of these bytes, newest first, from every document of the organization that holds the same file for the same subject under the same type, or as a provider's capture or under ID_DOCUMENT_*, RNM_* or SELFIE, whose refusals follow the bytes under every type, this one included (a provider's capture lists every refusal of its bytes for the subject, whatever the type). The entity of a webhook carries the refusals recorded on this document only

superseded_by_id
string<uuid> | null
required

The document that replaced this one, or that already held its bytes, when SUPERSEDED

Example:

null

screening
enum<string> | null
required

Rinne's own check of the file: PENDING until Rinne looks at it, then PASSED or FAILED, with screening_note saying why on a FAILED. Today it blocks nothing: a FAILED document still satisfies its requirement and still goes to the provider, so it tells you what to replace before the provider refuses it. Your own upload of the same subject and type replaces it; a file reused from another organization or captured by a provider stays listed beside the new one. null on a document Rinne does not screen: a SELFIE, the RNM_* and ID_DOCUMENT_* a provider's capture produces, and an attachment to an EVIDENCE_PACKAGE.

Available options:
PENDING,
PASSED,
FAILED,
null
Example:

"PENDING"

screening_note
string | null
required

The screener's note on a FAILED, saying why the document did not pass; null on any other verdict

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"