Skip to navigation

Upload accreditation document (PDF)

Registers a PDF slot and returns a presigned uploadUrl (HTTP PUT, 1 hour). Company kinds are PJ-only and allowed while status is PENDING_BIOMETRY, BIOMETRY_APPROVED, or PENDING_REVIEW (rejected for FAILED / INTEGRATING / ACTIVE). account_opening_terms is optional for PF and PJ and stays accepted until status is ACTIVE or FAILED (including INTEGRATING). After this 201, PUT the PDF bytes to uploadUrl before the URL expires. sizeBytes is required and is part of the URL signature: the PUT must send exactly that many bytes (max 50 MiB). A required slot does not fulfil the documentary requirement — GET keeps that kind in missingDocumentKinds until the object exists in the KYC archive with size > 0 (and, when the sanitizer is on, after a successful scan). kind=other is capped at 10 files per accreditation.

Required kinds by company.legalForm:

  • mei, ltda: company_articles
  • sa, cooperative: the above plus cnpj_card, financial_statements

Optional for all: company_proof_of_address, business_license, regulatory_license, account_opening_terms, other (other allows multiple files, max 10; fileName required). account_opening_terms does not block account opening. Typed kinds are one-per-accreditation (re-upload replaces). Document freshness (e.g. proof of address) is checked by the CorpX operator during review, who may still request it.

Upload in parallel with biometrics. Missing required kinds block operator approve unless they set forceIncompleteDocuments (audited). BaaS integrators only.

Centralized biometry tenants: there is no uploadUrl. Send the PDF in contentBase64 (up to 4 MB) and it is forwarded to the tenant’s KYC. Only company_articles, company_proof_of_address and financial_statements are accepted; the response is 201 with deliveryStatus: forwarded.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accreditationIdstringRequired

Accreditation (onboarding) identifier returned on creation.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
kindenumRequired
sizeByteslongRequired1-52428800

Actual PDF size in bytes (max 50 MiB). Part of the upload URL signature.

fileNamestringOptional

Required when kind=other (shown to reviewers).

contentTypeenumOptionalDefaults to application/pdf
Allowed values:
contentBase64stringOptional
Centralized biometry tenants only. The PDF itself, base64, up to 4 MB decoded. Forwarded to the tenant's KYC instead of returning an upload URL.

Response

Document slot created; upload the PDF via uploadUrl.

documentIdstringOptional
kindenumOptional
uploadUrlstringOptional

Presigned S3 URL — PUT exactly sizeBytes bytes with the same Content-Type.

uploadExpiresAtdatetimeOptional
sizeByteslongOptional
deliveryStatusenumOptional
Slot only. The kind stays in missingDocumentKinds until the object is in the KYC archive.
Allowed values:
scanStatusenumOptional

Uploads are archived only after real type detection, antivirus and sanitization (the PDF is rasterized), which takes a few seconds. Infected, corrupted or unexpected-type files are rejected and shown as rejected in the operator review.

Allowed values:
infostringOptional
Human readable note about the signed PUT and scanning step.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
500
Internal Server Error