Skip to main content
GET
/
v1
/
affiliations
/
{affiliationId}
/
onboarding-documents
/
{documentId}
Get onboarding document with download URL
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/affiliations/{affiliationId}/onboarding-documents/{documentId} \
  --header 'x-api-key: <api-key>'
{
  "id": "c5fdf2e4-1b9b-6108-aece-69991d5h4905",
  "file_type": "CNH_FRONT",
  "file_name": "CNH_FRONT_a1b2c3d4.pdf",
  "created_at": "2023-06-15T14:30:00.000Z",
  "download_url": "https://storage.rinne.com.br/bucket/path/to/file?signature=...",
  "download_url_expires_at": "2023-06-15T15:30:00.000Z",
  "content_type": "application/pdf",
  "file_size_bytes": 125430
}

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

Onboarding document with signed download URL

​
id
string
required

Document unique identifier

Example:

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

​
file_type
string
required

Type of document (e.g., CNH_FRONT, SELFIE, CONTRATO_SOCIAL)

Example:

"CNH_FRONT"

​
file_name
string
required

Generated filename in storage

Example:

"CNH_FRONT_a1b2c3d4.pdf"

​
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"

​
content_type
string | null

MIME type of the document

Example:

"application/pdf"

​
file_size_bytes
integer | null

File size in bytes

Example:

125430