List limit-request document types

GET

https://client.api.corpx.com/v1/limit-requests/document-types

GET

/v1/limit-requests/document-types

curl -G https://client.api.corpx.com/v1/limit-requests/document-types \
     -H "X-Content-SHA256: X-Content-SHA256" \
     -H "X-Request-Signature: X-Request-Signature" \
     -H "X-Request-Timestamp: X-Request-Timestamp" \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>" \
     -d holderType=PF

{
  "holderType": "PF",
  "required": [
    {
      "description": "RG, CNH ou passaporte, frente e verso.",
      "label": "Documento de identidade com foto",
      "required": true,
      "type": "identity_document"
    }
  ],
  "additional": [
    {
      "description": "Última declaração completa, com o recibo de entrega.",
      "label": "Declaração de imposto de renda",
      "required": false,
      "type": "income_tax_return"
    }
  ]
}

Catalog of documents for a limit increase, split into required and additional. holderType is PF (11-digit holder document) or PJ (14). Labels are ready to show. The facade does not inspect file contents.

Authentication

AuthorizationBearer

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

Headers

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

Query parameters

holderTypeenumRequired

PF or PJ.

Allowed values:

Response

Document catalog.

holderTypestring

requiredlist of objects

additionallist of objects

Errors

400

Bad Request Error