v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

CAAS

Send document to analysis

Send a document to analysis

NOTE: Client_id is blocked if this call is made to the same CPF over 50 times in the same hour

Envia um documento por vez para análise.

OBS: Client_id é bloqueado caso esta chamada seja realizada para o mesmo CPF acima de 50 vezes na mesma hora

put/v2/process/document/{id_caas}

Path parameters

id_caasstring required

Pipeline id

Request body

Tipos de documentos

mimeType'image/jpeg' | 'image/png' | 'application/pdf'

MimeTypes available (if PDF is sent as a Selfie type, this item will not be accepted in the internal validation process)

MimeTypes disponíveis (caso enviado PDF para tipo Selfie, este item não será aceito no processo de validação interna)

namestring

Nome do arquivo

base64string

Arquivo encodado em base64

Example request

{
  "type": "SELF",
  "mimeType": "image/png",
  "name": "self1347.png",
  "base64": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAA6lBMVEX////9zJtRNir3lB78vIXzbCE7JRn//fv9x5T8voj8wo7+59BaQDX6ypnXq4L9yZf3lF58aF9gRzz0xJXGm3fpu47/9u7/+fT9z6L+7Nn7z5r5rFD5s15sVUuXhn/y8O/o5eNxUj+qhGSUcFb+0q34njLPx8SIdW21qqXc19TGvbnSy8iwpJ6ik43TqIBpSzqIZk65kW58W0aeel2Sb1WRgHn+3sOYblBLNyz92Lf+4sf6rHn5oGv7tYP1fCz6rnT2j071fjj2ih/82Kz5rlX7yIv6u3H4nTHSm2++i2Tsr3yVfWrKlWr1gyCZwkRKAAAGUElEQVR4nMVaaVviPBRlKbSFQtnKJiiguDAiqzqU0WFkZnSc1///d96kabrQNiRNOp4PPlrTe05u7hYeUql4kAeX19Orfq3W71erV/en1zcxDcXhngDmTABadXp5ljz72eRKC5I7qE7kJNkHt1UCOUJtOkiIXb4N8XsorpKIB/m6RkkPcSo6GOQJ7e7xQVwL5Welh6gOhNGfHY+8UCd8EcR/w3L4PtwK4b8kpf0/UHAbn16IglMu/kxmypmP15z8MB95avMNx/k76Mevi3KM9A+BFjsfeQPAUTCJxz8RxA9wGUuAmAOwUIuTDJfi+EGHjiHgSqSADHt3HAjlz9SYBUzFCsgwZ0LsHhiBKiO/4BMAYCyIAouAjSmbANEhwHwG8cYwItiKkYg+eACmeiw+BhnHo5sEBNyzCBDaCGwwRaH4LGSsxvzDYAhYpkO+aTwCLB6IX4eGo9knCliOyum0EVVDEhYwWzfqaQt34Qs0FgFsMTCbrxbltItGQgK0IcRs5rhY0wB1o1xKH2LBLSCQhsNVw3AJSnXDMOoBXrIPeOrA/I5ARquASYCvEs7KxwkDKA8PBfRZBHzxbp/k62iURgfpyNQLPN3w3NnTYrUczldEd5RX8+ESp4Sx9Ak4ZRFw5kafHeOl1XGP1Od4zarkfweC6W4i47c0O/ZLnt3MowTM3TVLpHvtEcB2Q8XnN7Jt+6LaCOc3vGsa6JEnDgZMAuyrsYbdDZyprUeLxgJ6IiIMynDnYMloDWhX6NnI4WeqQ85U7HjbaGBWY3EeEQT18wX2TRmXLdcrjGO5fTdeRB03NZxywDQSplL3xNNmgHMGjJ8Z2v2Ym98KDAtsd8PmQpSAOo7BDgu/qb6JEpC2J7RH1aTnf5Ckd/TaQas3KGKifjAf2NXpjyQ9UPtflSRJCwowZvl85khjrs/z+fzI+8Qux++SpDYpBVwAfgmVXm/GG9NBH1gn9+a/g1OwZuV5gqJpCG1e0PF34FrpMSBgPUndA+NDEv/dfWoC1uQ976ER9dEySheID9baP4E6MPtahbaJgTnKV7/CRZ6DQrXwzTJKFwXWCUhvAQ9oeYTgDOpiZa9puI9K0M7Sskl5BgparB2m4RLZnpE80LAF+DyHcgBCoRKA1lpB4CMrI9vE9lCaWWuWPuHAjm1TohJQQGv/g7Hrs77IHwR4CMoZGKe+crHCIShJBSoBbck5g4PZx1iMjg7I9cbozh8ljczw3TbZphKwcc+Avxun4WSI+aUNlYAiXj5fkwKeHgo2KBWpBMjOCwUh/OkCtqdQfkbSwS+oYgSo2B51R77Ab4gRgK1RtgKAFk4ERQQ/PtF2i1oA7gdigsAOAeppAKGz0QH/hQgBF0CBvmGayBBaYH5oEwzrob8GAIpPk8X5fmwI/JJqh4iiSgQFdMUnCkXC1kB2qWqhoKrkfKUrPlFoEizrTn6rpCOgHQQjsCeYTisFuPsCMVn3fPypDsk4DWJEvw8yKQ8o0Ob+cpvJJ4DhOhSBFpcLmMpvBEiZeBR8OYgQGgXbrT/1dHW7DXOAkK83hiWCvq1Uvm2fQAqCVHzafqtUtmG1gDcFbITWY92iRQBSQksRXxV2QYhDpUAoQyIiEIFUkAngLMJeRNZD2Iyi/icoABAic1GJPAERGegBc08Quv8YCoTzg0hkqMltgfHnQqbuS2ZS3+9uEscTjH0i27fRIUypCHHmbyY0TUIstM0kd48hd8xQP2zMTqLf7ffBBD1AUXQd9CDwQ4E9kf7qKQLFtF5wpnLWu68YAWl7Kv9MAQC6Yt2MPk8A1qELbz5sAiD+rQBT8l+IC5LEfwOgxWa7e859P3TA99zz7ukh8ULQ6fbGHzmIim8SUSrWw9xrr5tgKW52T7IQSEFu94Q/oHjaoSfP1r9PuonUY8wO8ZLD+LHb/XD++HAWiNdg9rI+fOQCeH7xreiJDMrNSTaAZyK95QZB9xJ5H0IPz8H1wvNHkN6SsBeQFftxqG1bxMtHBLeNMfcnND9J5mnwkyct5V+89BC/Yp+DSfI+A8bxEkLM9hHiOKHVO26XHj3mm3ozPPdi44SxNBYFHb+LMdO8UBRND8GgoCV8/xBj+jgQGn8uerT83WT4s9kuHX8zKf5sli4V9skJoGtNv5MT8JtKwGtyAl6DbP8DB1uimQNWVe8AAAAASUVORK5CYII="
}

Response

Success

Tipos de documentos

mimeType'image/jpeg' | 'image/png' | 'application/pdf'

MimeTypes available (if PDF is sent as a Selfie type, this item will not be accepted in the internal validation process)

MimeTypes disponíveis (caso enviado PDF para tipo Selfie, este item não será aceito no processo de validação interna)

namestring

Nome do documento

urlstring

Url do documento