Skip to main content
GET
Get onboarding document with download URL

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

affiliationId
string
required

The affiliation ID

documentId
string
required

The onboarding document ID

Response

Onboarding document with signed download URL

A document an affiliation sent, with a signed download URL

id
string
required

This send of the document to the affiliation's provider, not the document's own id (onboarding_document_id). GET /v1/affiliations/{affiliationId}/onboarding-documents/{documentId} (and its /v1/merchants/{merchantId} twin) accepts either this id or the onboarding_document_id.

Example:

"c5fdf2e4-1b9b-6108-aece-69991d5h4905"

onboarding_document_id
string
required

The document sent, as the company's onboarding documents list it (GET /v1/onboarding-documents, or its /v1/merchants/{merchantId} twin); several affiliations that sent one document share it

Example:

"7d3b9a1e-2f4c-4e8a-9b1d-5c6e7f8a9b0c"

type
enum<string>
required

The document's type in Rinne's vocabulary; file_type is the name the provider received

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:

"CNH_DIGITAL"

file_type
string
required

The document's type as the provider received it (e.g., CNH_FRONT, SELFIE, CONTRATO_SOCIAL)

Example:

"CNH_FRONT"

file_name
string
required

Generated filename in storage; empty for another organization's file shared with this one, which exposes nothing of it

Example:

"CNH_FRONT_a1b2c3d4.pdf"

content_type
string | null
required

MIME type of the document; null for another organization's shared file

Example:

"application/pdf"

file_size_bytes
integer | null
required

File size in bytes; null for another organization's shared file

Example:

125430

created_at
string<date-time>
required

When the document was stored

Example:

"2023-06-15T14:30:00.000Z"

download_url
string<uri>
required

Signed URL for downloading the document (expires after 1 hour)

Example:

"https://storage.rinne.com.br/bucket/path/to/file?signature=..."

download_url_expires_at
string<date-time>
required

When the download URL expires

Example:

"2023-06-15T15:30:00.000Z"