openapi: 3.2.0 info: title: conta-de-pagamento-e-marketplace Bank Verification API version: '1.0' servers: - url: https://api.iugu.com/v1 security: - sec0: [] tags: - name: Bank Verification paths: /bank_verification: post: summary: Adicionar/cadastrar Domicílio Bancário description: 'Envia dados para cadastrar ou alterar o domicílio bancário da conta que recebe saques e transferências. Atenção Informe uma conta bancária válida vinculada ao CPF/CNPJ cadastrado na verificação da subconta. Não é possível receber valores em uma conta bancária que tenha um titular diferente do cadastrado na subconta.' operationId: adicionar-domicilio-bancario parameters: - name: Request-Time in: header description: Timestamp do momento que enviar a requisição de assinatura digital (RSA) required: true schema: type: string format: date-time - name: Signature in: header description: Assinatura digital required: true schema: type: string default: signature= - in: header name: X-Signature-Token-Id schema: type: string description: Indica explicitamente qual token/chave deve ser utilizado na assinatura da requisição, informando o ID do token desejado. Se omitido, mantém o comportamento atual. requestBody: content: application/json: schema: type: object required: - agency - account - account_type - bank properties: agency: type: string description: Número da agência account: type: string description: Número da conta account_type: type: string description: Tipo da Conta. **Conta Corrente:** `cc`. **Conta Poupança:** `cp`. **Conta Pagamento:** `cpg`. bank: type: string description: Código do Banco (apenas números). **Consulte a tabela acima**. automatic_validation: type: boolean description: Valida o dígito verificador da conta document: type: string description: Documento de Comprovação dos Dados Bancários (Enviar via multipart ou base64) - (envio opcional) format: binary RAW_BODY: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"success\": true\n}" schema: type: object properties: success: type: boolean example: true default: true '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: text/plain: examples: Result: value: "{\n \"errors\": {\n \"account_type\": [\n \"is invalid\"\n ]\n }\n}" schema: type: object properties: errors: type: object properties: account_type: type: array items: type: string example: is invalid tags: - Bank Verification get: summary: Verificar envio de domicilio bancário description: Consultar dados enviados para alterar domicílio bancário. operationId: verificar-envio-de-domicilio-bancario responses: '200': description: '200' content: application/json: examples: OK (retorno da api): value: "[\n {\n \"id\": \"00000000000000000000000000000000\",\n \"status\": \"accepted\",\n \"created_at\": \"2023-09-25T15:16:31-03:00\",\n \"updated_at\": \"2023-09-25T15:16:32-03:00\",\n \"account\": \"000000000-0\",\n \"agency\": \"0000\",\n \"operation\": null,\n \"feedback\": null,\n \"bank\": \"Itaú\"\n },\n {\n \"id\": \"00000000000000000000000000000000\",\n \"status\": \"accepted\",\n \"created_at\": \"2023-09-25T14:55:59-03:00\",\n \"updated_at\": \"2023-09-25T14:55:59-03:00\",\n \"account\": \"000000000000-0\",\n \"agency\": \"0000\",\n \"operation\": null,\n \"feedback\": null,\n \"bank\": \"Caixa Econômica\"\n },\n {\n \"id\": \"00000000000000000000000000000000\",\n \"status\": \"accepted\",\n \"created_at\": \"2023-09-25T14:51:43-03:00\",\n \"updated_at\": \"2023-09-25T14:51:45-03:00\",\n \"account\": \"000000000000-0\",\n \"agency\": \"0000\",\n \"operation\": null,\n \"feedback\": null,\n \"bank\": \"Caixa Econômica\"\n }\n]" schema: type: array items: type: object properties: id: type: string example: '00000000000000000000000000000000' status: type: string example: accepted created_at: type: string example: '2023-09-25T15:16:31-03:00' updated_at: type: string example: '2023-09-25T15:16:32-03:00' account: type: string example: 000000000-0 agency: type: string example: '0000' operation: {} feedback: {} bank: type: string example: Itaú '400': description: '400' content: application/json: examples: Result: value: "{\n \"errors\": \"Not Found\"\n}" schema: type: object properties: errors: type: string example: Not Found deprecated: false tags: - Bank Verification components: securitySchemes: sec0: type: apiKey name: api_token in: query x-readme-fauxas: true x-provenance: method: searched source: https://dev.iugu.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://dev.iugu.com/reference/adicionar-domicilio-bancario.md - https://dev.iugu.com/reference/atualizar-contato-de-conta.md - https://dev.iugu.com/reference/atualizar-contato-de-subconta.md - https://dev.iugu.com/reference/atualizar-subconta.md - https://dev.iugu.com/reference/buscar-contato-de-subconta.md - https://dev.iugu.com/reference/configurar-conta.md - https://dev.iugu.com/reference/configurar-pagamentos.md - https://dev.iugu.com/reference/consultar-envio-de-documentos.md - https://dev.iugu.com/reference/criar-contato-de-subconta.md - https://dev.iugu.com/reference/criar-subconta.md - https://dev.iugu.com/reference/deletar-contato-de-conta.md - https://dev.iugu.com/reference/desativar-subconta.md - https://dev.iugu.com/reference/informacoes-da-conta.md - https://dev.iugu.com/reference/listar-as-subcontas.md - https://dev.iugu.com/reference/listar-contatos-de-subconta.md - https://dev.iugu.com/reference/pedido-de-saque.md - https://dev.iugu.com/reference/reenviar-documentos.md - https://dev.iugu.com/reference/verificar-envio-de-domicilio-bancario.md merge: pages: 18 deduped: 17 conflicts_kept_first: 0