Envio de documentos por imagem

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Bodymultipart/form-data

campaign

string

requerido

id da campanha

Exemplo:

9876

personDocumentNumber

string

requerido

CPF do cadastro

Exemplo:

11122233399

senderId

string

requerido

Uso interno. Enviar o campo vazio.

image

file

requerido

Foto da nota (arquvo de imagem JPG, PNG)

seller

string

requerido

Uso interno. Eviar o campo vazio se não usado.

partnerPaymentType

string

requerido

Uso interno. Enviar o campo vazio se não usado

internalCode

string

opcional

Código interno escolhido pelo parceiro.

Exemplo:

acb123XYZ

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v4/document/send' \
--form 'campaign="9876"' \
--form 'personDocumentNumber="11122233399"' \
--form 'senderId=""' \
--form 'image=@""' \
--form 'seller=""' \
--form 'partnerPaymentType=""' \
--form 'internalCode="acb123XYZ"'

Respostas

🟢200Success

application/json

Body

status

string

requerido

code

integer

requerido

message

string

requerido

error

string | null

requerido

data

object

requerido

personDocumentNumber

string

requerido

campaign

string

requerido

protocol

integer

requerido

status

string

requerido

sendDate

string

requerido

protocolToken

string

requerido

document

object

requerido

Examples

SuccessUnauthorized (401)

{
    "status": "success",
    "code": 200,
    "message": "",
    "error": null,
    "data": {
        "personDocumentNumber": "11122233399",
        "campaign": "9876",
        "protocol": 2588,
        "status": "OCR",
        "sendDate": "12/02/2025 16:15:02",
        "protocolToken": "$2y$10$UufooMmkOSH/s7iyyqfooOMpOIPgr190sG2pDrxFOOcPmjTEwrmE2i",
        "document": {
            "fileName": "nota1",
            "documentId": "2faafe99ce321dd4b17g84a3fooe2fd0",
            "dateOcrExpiration": {
                "date": "2025-02-12 16:15:33.351010",
                "timezone_type": 3,
                "timezone": "America/Sao_Paulo"
            },
            "success": true
        }
    }
}