Skip to content
Gowd Platform Production

Upload onboarding document

POST
/order/v1/banking/accounts/documents

Upload an onboarding document file (pdf, png, jpg, jpeg, up to 10MB) for an existing account request. The document is attached to the request under the declared documentType.

object
file
required

Document file (pdf, png, jpg, jpeg). Maximum size of 10MB.

string format: binary
documentType
required

Which onboarding document of the account request this file is.

string
Allowed values: socialContract cnpjCard proofAddress proofBankAddress partnerProofAddress documentRepresentative selfieRepresentative ir kyc pepDeclaration incomeStatement
accountRequestId
required

Id of the account request this document belongs to, returned by the create account request endpoint. The request must exist, belong to the authenticated company and still be pending. Any previous document in the same field is kept in its history.

string format: uuid

Resource successfully created

object
documentId
required

Identifier of the uploaded document.

string format: uuid
url
required

Read URL of the uploaded document to be used on the onboardingDocuments fields of the account request.

string
documentType
required

Declared document type; matches the onboardingDocuments field the URL belongs in.

string
Allowed values: socialContract cnpjCard proofAddress proofBankAddress partnerProofAddress documentRepresentative selfieRepresentative ir kyc pepDeclaration incomeStatement
accountRequestId

Account request this document was linked to, when informed on the upload.

string format: uuid
attached
required

Whether the document was written onto the account request. True only when accountRequestId was informed; otherwise place the reference yourself when creating the request.

boolean
object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string

Unauthorized Request

object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string
object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string
object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string