Enviar imagem do onboarding.

POST

/onboarding/{id}/images

Onboardings

Envia documentos de identificação e selfie para um onboarding previamente criado. Este endpoint é exclusivo para credenciais BaaS e não exige o cabeçalho x-account-id.

Tipos aceitos:

FRONT: frente do documento

BACK: verso do documento

SELFIE: selfie do titular

O upload só é permitido enquanto o onboarding estiver com status Pendente (0) ou Aguardando aprovação (1). Arquivos devem estar em JPG ou PNG, com tamanho máximo de 10 MB.

A funcionalidade depende da preferência ENABLE_ONBOARDING_API_ENDPOINT estar habilitada no ambiente.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

baas.onboarding.write-Permite criar cadastros/onboardings e enviar documentos

Parâmetros de Caminho

Parâmetros Bodymultipart/form-dataNecessário

Respostas

🟢200

application/json

Imagem enviada

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/onboarding//images' \
--form 'type="FRONT"' \
--form 'file=@"(binary)"'

Response Example

200 - Frente do documento

{
    "image": {
        "type": "FRONT",
        "url": "https://example.com/onboarding/38005732-ab00-4e7d-87c0-5835edc1ed65/front.png?{signedUrl}"
    }
}

Página anterior

Criar onboarding no BaaS.

Próxima página

Listar onboardings do BaaS.