{"openapi":"3.0.0","info":{"title":"Open Finance MCP API","description":"API REST do Open Finance MCP (openfinancemcp.ai). Uma plataforma (escritório de contabilidade, BPO,\nsoftware house) cadastra titulares (CPF ou CNPJ), cada titular autoriza os seus bancos, e a plataforma\nlê saldos, transações, faturas de cartão, investimentos e empréstimos por aqui.\n\n## Autenticação\nCrie a chave na sua conta em openfinancemcp.ai e envie em `Authorization: Bearer ofm_live_...`.\nQuando o cliente HTTP não permitir customizar esse header, use `x-api-key: ofm_live_...`.\n\n## Titular de cada chamada\nToda leitura e toda rota de conexão responde por um titular, informado no header `x-holder-document`\n(CPF ou CNPJ, com ou sem máscara; o CNPJ pode ser alfanumérico). Em `GET /v1/balance` o valor `all`\nsoma todos os titulares. As rotas de titulares recebem o documento no caminho e não usam o header.\n\n## Fluxo típico\n1. `POST /v1/holders` com o documento: a resposta traz `authorization_url`. Envie o link ao titular.\n2. O titular escolhe o banco e autoriza. Acompanhe por `GET /v1/holders/{document}` (campo `connections`).\n3. Com uma conexão em `succeeded`, leia `GET /v1/accounts`, `GET /v1/transactions` e as demais leituras.\nPara conectar um banco pela própria plataforma, use `POST /v1/connections` e siga os estados da conexão.\n\n## Paginação\nListas recebem `page` (a partir de 1) e `per_page` (padrão 20, máximo 100) e respondem\n`{ data, pagination: { page, per_page, total, total_pages, prev, next } }`. Pare quando `next` for null.\n\n## Erros\nTodo erro responde `{ error: { code, type, message } }`. Decida pelo `type`; `message` é texto em português.\nTipos frequentes: `unauthorized` (401), `invalid_request` (400), `payment_required` (402, com `reason`\nsubscription_required ou trial_already_used), `holder_not_found` (403, documento não é titular da conta),\n`connection_exists` (409, com `connection_id`), `credentials_on_authorization_page` (422, com\n`authorization_url`), `rate_limited` (429).\n\nValores monetários vêm em reais e datas em ISO 8601.","version":"1.0.0"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Chave de API no formato ofm_live_..."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"A mesma chave, para clientes que não permitem customizar o header Authorization"}},"schemas":{}},"paths":{"/v1/me":{"get":{"operationId":"getMe","summary":"Dados da chave de API","tags":["Conta"],"description":"Confirma que a chave é válida e devolve o usuário dono da conta, os escopos e o limite de requisições por minuto da chave. Não exige o header x-holder-document.","security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"api_key_id":{"type":"string","nullable":true},"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string"}},"rate_limit_per_minute":{"type":"integer"}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/holders":{"get":{"operationId":"listHolders","summary":"Listar titulares","tags":["Titulares"],"description":"Lista os CPFs e CNPJs cadastrados na conta, com o estado de cada um e as conexões bancárias que ele já autorizou. Use o document de cada item no header x-holder-document das leituras.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string","enum":["pending_bank","trial","active","awaiting_payment","suspended","removed"]},"in":"query","name":"status","required":false,"description":"Filtra pelo estado do titular"},{"schema":{"type":"string","enum":["screen","api","mcp","connector"]},"in":"query","name":"source","required":false,"description":"Filtra pela origem do cadastro"},{"schema":{"type":"string","maxLength":100},"in":"query","name":"search","required":false,"description":"Busca por documento, nome ou referência"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"document":{"type":"string","description":"CPF ou CNPJ sem máscara"},"document_type":{"type":"string","enum":["cpf","cnpj"]},"name":{"type":"string","nullable":true,"description":"Nome ou razão social, quando já conhecido"},"reference":{"type":"string","nullable":true,"description":"Referência livre informada pela plataforma no cadastro"},"source":{"type":"string","description":"Onde o titular foi cadastrado: screen, api, mcp ou connector"},"status":{"type":"string","description":"pending_bank (nenhum banco autorizado ainda), trial, active, awaiting_payment, suspended ou removed"},"created_at":{"type":"string","nullable":true},"locked_at":{"type":"string","nullable":true},"trial_consumed_here":{"type":"boolean","description":"Se o teste gratuito deste documento foi usado nesta conta"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"updated_at":{"type":"string","nullable":true}}}}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}},"post":{"operationId":"createHolder","summary":"Cadastrar titular","tags":["Titulares"],"description":"Cadastra um CPF ou CNPJ na conta e devolve authorization_url, a página onde o titular escolhe o banco e autoriza o acesso. Envie esse link ao titular. Responde 201 quando o documento é novo na conta e 200 quando ele já era titular dela (o link é renovado). Erros: 400 para documento inválido, 409 holder_unavailable quando o documento não pode ser conectado nesta conta, 402 com reason trial_already_used quando o teste gratuito desse documento já foi usado.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document"],"properties":{"document":{"type":"string","minLength":11,"maxLength":20,"description":"CPF ou CNPJ, com ou sem máscara. O CNPJ pode ser alfanumérico."},"reference":{"type":"string","maxLength":200,"description":"Referência livre da plataforma, como o código do cliente no seu sistema"}}}}}},"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"holder":{"type":"object","properties":{"id":{"type":"string"},"document":{"type":"string","description":"CPF ou CNPJ sem máscara"},"document_type":{"type":"string","enum":["cpf","cnpj"]},"name":{"type":"string","nullable":true,"description":"Nome ou razão social, quando já conhecido"},"reference":{"type":"string","nullable":true,"description":"Referência livre informada pela plataforma no cadastro"},"source":{"type":"string","description":"Onde o titular foi cadastrado: screen, api, mcp ou connector"},"status":{"type":"string","description":"pending_bank (nenhum banco autorizado ainda), trial, active, awaiting_payment, suspended ou removed"},"created_at":{"type":"string","nullable":true},"locked_at":{"type":"string","nullable":true},"trial_consumed_here":{"type":"boolean","description":"Se o teste gratuito deste documento foi usado nesta conta"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"updated_at":{"type":"string","nullable":true}}}}}},"authorization_url":{"type":"string","nullable":true,"description":"Página onde o titular escolhe o banco e autoriza o acesso. Envie este link ao titular."},"authorization_expires_at":{"type":"string","nullable":true}}}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"holder":{"type":"object","properties":{"id":{"type":"string"},"document":{"type":"string","description":"CPF ou CNPJ sem máscara"},"document_type":{"type":"string","enum":["cpf","cnpj"]},"name":{"type":"string","nullable":true,"description":"Nome ou razão social, quando já conhecido"},"reference":{"type":"string","nullable":true,"description":"Referência livre informada pela plataforma no cadastro"},"source":{"type":"string","description":"Onde o titular foi cadastrado: screen, api, mcp ou connector"},"status":{"type":"string","description":"pending_bank (nenhum banco autorizado ainda), trial, active, awaiting_payment, suspended ou removed"},"created_at":{"type":"string","nullable":true},"locked_at":{"type":"string","nullable":true},"trial_consumed_here":{"type":"boolean","description":"Se o teste gratuito deste documento foi usado nesta conta"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"updated_at":{"type":"string","nullable":true}}}}}},"authorization_url":{"type":"string","nullable":true,"description":"Página onde o titular escolhe o banco e autoriza o acesso. Envie este link ao titular."},"authorization_expires_at":{"type":"string","nullable":true}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"409":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"422":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/holders/{document}":{"get":{"operationId":"getHolder","summary":"Consultar titular","tags":["Titulares"],"description":"Devolve um titular da conta, com o estado e as conexões bancárias autorizadas. Responde 403 holder_not_found quando o documento não é titular desta conta.","parameters":[{"schema":{"type":"string"},"in":"path","name":"document","required":true,"description":"CPF ou CNPJ do titular, com ou sem máscara"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"document":{"type":"string","description":"CPF ou CNPJ sem máscara"},"document_type":{"type":"string","enum":["cpf","cnpj"]},"name":{"type":"string","nullable":true,"description":"Nome ou razão social, quando já conhecido"},"reference":{"type":"string","nullable":true,"description":"Referência livre informada pela plataforma no cadastro"},"source":{"type":"string","description":"Onde o titular foi cadastrado: screen, api, mcp ou connector"},"status":{"type":"string","description":"pending_bank (nenhum banco autorizado ainda), trial, active, awaiting_payment, suspended ou removed"},"created_at":{"type":"string","nullable":true},"locked_at":{"type":"string","nullable":true},"trial_consumed_here":{"type":"boolean","description":"Se o teste gratuito deste documento foi usado nesta conta"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"updated_at":{"type":"string","nullable":true}}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}},"delete":{"operationId":"deleteHolder","summary":"Remover titular","tags":["Titulares"],"description":"Remove o titular da conta e encerra as conexões bancárias dele. Depois disso as leituras desse documento respondem 403.","parameters":[{"schema":{"type":"string"},"in":"path","name":"document","required":true,"description":"CPF ou CNPJ do titular, com ou sem máscara"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"204":{"description":"Sem corpo"},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/holders/{document}/authorization-links":{"post":{"operationId":"createAuthorizationLink","summary":"Gerar novo link de autorização","tags":["Titulares"],"description":"Gera um novo link para o titular autorizar mais um banco ou renovar uma autorização. O link vale 7 dias.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"return_url":{"type":"string","maxLength":2000,"description":"URL https para onde o titular volta depois de autorizar. O domínio precisa estar cadastrado nos domínios de retorno da conta."},"reference":{"type":"string","maxLength":200,"description":"Referência devolvida na URL de retorno"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"document","required":true,"description":"CPF ou CNPJ do titular, com ou sem máscara"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"authorization_url":{"type":"string","description":"Página onde o titular escolhe o banco e autoriza o acesso"},"authorization_expires_at":{"type":"string","description":"Validade do link (7 dias)"}}}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"authorization_url":{"type":"string","description":"Página onde o titular escolhe o banco e autoriza o acesso"},"authorization_expires_at":{"type":"string","description":"Validade do link (7 dias)"}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"409":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"422":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/institutions":{"get":{"operationId":"listInstitutions","summary":"Listar bancos disponíveis","tags":["Instituições"],"description":"Lista os bancos que podem ser conectados, filtrados pelo tipo de documento do titular. Instituições fora do ar não aparecem. O id de cada item é o institution_id de POST /v1/connections.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string","enum":["cpf","cnpj"]},"in":"query","name":"document_type","required":false,"description":"Tipo de documento do titular: cpf (pessoa física) ou cnpj (empresa)"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Use em institution_id de POST /v1/connections"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true},"primary_color":{"type":"string","nullable":true},"document_type":{"type":"string","description":"cpf ou cnpj"},"connection_method":{"type":"string","description":"oauth: o titular autoriza no site do banco. credentials: o titular informa credenciais na página de autorização (Inter empresas)."},"health":{"type":"string","description":"ONLINE ou UNSTABLE"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/connections":{"get":{"operationId":"listConnections","summary":"Listar conexões bancárias do titular","tags":["Conexões"],"description":"Lista as conexões bancárias do titular informado em x-holder-document, com o estado de cada uma e o saldo somado das contas.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"holder_document":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"oauth_url":{"type":"string","nullable":true,"description":"Em waiting_oauth: o link que o titular abre para autorizar no banco"},"oauth_expires_at":{"type":"string","nullable":true},"parameter":{"type":"object","nullable":true,"description":"Em waiting_mfa: o campo que o banco pede","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"placeholder":{"type":"string","nullable":true},"validation":{"type":"string","nullable":true,"description":"Expressão regular que o valor precisa satisfazer"},"validation_message":{"type":"string","nullable":true},"assistive_text":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"optional":{"type":"boolean"},"expires_at":{"type":"string","nullable":true},"data":{"type":"string","nullable":true,"description":"Conteúdo auxiliar, como a imagem de um QR code"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}}}}}},"error":{"type":"object","nullable":true,"properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"accounts_count":{"type":"integer"},"balance":{"type":"number","nullable":true,"description":"Soma dos saldos mais recentes das contas da conexão"},"balance_observed_at":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}},"post":{"operationId":"createConnection","summary":"Conectar um banco ao titular","tags":["Conexões"],"description":"Inicia a conexão de um banco para o titular informado em x-holder-document e responde 201 com a conexão. O documento vem sempre do titular; enviar cnpj no corpo responde 400. Em seguida consulte GET /v1/connections/{id} a cada 2 segundos enquanto o estado for connecting. Em waiting_oauth, envie oauth_url ao titular para ele autorizar no banco. Erros: 409 connection_exists quando já há uma conexão viva com esse banco (o campo connection_id indica qual renovar com reconnect); 422 credentials_on_authorization_page quando o banco exige credenciais que só o titular informa (envie authorization_url a ele).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["institution_id"],"properties":{"institution_id":{"type":"integer","description":"id de GET /v1/institutions"},"cpf":{"type":"string","maxLength":20,"description":"CPF de quem autoriza no banco. Obrigatório quando o titular é um CNPJ (o representante que tem acesso ao banco); ignorado quando o titular é um CPF."},"return_url":{"type":"string","maxLength":2000,"description":"URL https para onde o titular volta depois de autorizar no banco. O domínio precisa estar cadastrado nos domínios de retorno da conta."},"reference":{"type":"string","maxLength":200,"description":"Referência livre da plataforma"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"holder_document":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"oauth_url":{"type":"string","nullable":true,"description":"Em waiting_oauth: o link que o titular abre para autorizar no banco"},"oauth_expires_at":{"type":"string","nullable":true},"parameter":{"type":"object","nullable":true,"description":"Em waiting_mfa: o campo que o banco pede","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"placeholder":{"type":"string","nullable":true},"validation":{"type":"string","nullable":true,"description":"Expressão regular que o valor precisa satisfazer"},"validation_message":{"type":"string","nullable":true},"assistive_text":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"optional":{"type":"boolean"},"expires_at":{"type":"string","nullable":true},"data":{"type":"string","nullable":true,"description":"Conteúdo auxiliar, como a imagem de um QR code"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}}}}}},"error":{"type":"object","nullable":true,"properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"accounts_count":{"type":"integer"},"balance":{"type":"number","nullable":true,"description":"Soma dos saldos mais recentes das contas da conexão"},"balance_observed_at":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"409":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"422":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/connections/{id}":{"get":{"operationId":"getConnection","summary":"Consultar uma conexão","tags":["Conexões"],"description":"Devolve o estado atual da conexão. Consulte a cada 2 segundos enquanto o estado for connecting; os outros estados pedem uma ação (waiting_oauth, waiting_mfa) ou são finais.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Identificador da conexão, devolvido em GET /v1/connections"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"holder_document":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"oauth_url":{"type":"string","nullable":true,"description":"Em waiting_oauth: o link que o titular abre para autorizar no banco"},"oauth_expires_at":{"type":"string","nullable":true},"parameter":{"type":"object","nullable":true,"description":"Em waiting_mfa: o campo que o banco pede","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"placeholder":{"type":"string","nullable":true},"validation":{"type":"string","nullable":true,"description":"Expressão regular que o valor precisa satisfazer"},"validation_message":{"type":"string","nullable":true},"assistive_text":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"optional":{"type":"boolean"},"expires_at":{"type":"string","nullable":true},"data":{"type":"string","nullable":true,"description":"Conteúdo auxiliar, como a imagem de um QR code"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}}}}}},"error":{"type":"object","nullable":true,"properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"accounts_count":{"type":"integer"},"balance":{"type":"number","nullable":true,"description":"Soma dos saldos mais recentes das contas da conexão"},"balance_observed_at":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}},"delete":{"operationId":"deleteConnection","summary":"Remover uma conexão","tags":["Conexões"],"description":"Encerra a conexão com o banco. As contas e transações dela deixam de aparecer nas leituras.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Identificador da conexão, devolvido em GET /v1/connections"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"204":{"description":"Sem corpo"},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/connections/{id}/mfa":{"post":{"operationId":"sendConnectionMfa","summary":"Responder ao pedido do banco (MFA)","tags":["Conexões"],"description":"Envia o valor que o banco pediu quando a conexão está em waiting_mfa (o campo está descrito em parameter). Depois volte a consultar GET /v1/connections/{id}.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["value"],"properties":{"value":{"type":"string","minLength":1,"maxLength":10000,"description":"Valor pedido pelo banco, como o código recebido por SMS"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Identificador da conexão, devolvido em GET /v1/connections"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"holder_document":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"oauth_url":{"type":"string","nullable":true,"description":"Em waiting_oauth: o link que o titular abre para autorizar no banco"},"oauth_expires_at":{"type":"string","nullable":true},"parameter":{"type":"object","nullable":true,"description":"Em waiting_mfa: o campo que o banco pede","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"placeholder":{"type":"string","nullable":true},"validation":{"type":"string","nullable":true,"description":"Expressão regular que o valor precisa satisfazer"},"validation_message":{"type":"string","nullable":true},"assistive_text":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"optional":{"type":"boolean"},"expires_at":{"type":"string","nullable":true},"data":{"type":"string","nullable":true,"description":"Conteúdo auxiliar, como a imagem de um QR code"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}}}}}},"error":{"type":"object","nullable":true,"properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"accounts_count":{"type":"integer"},"balance":{"type":"number","nullable":true,"description":"Soma dos saldos mais recentes das contas da conexão"},"balance_observed_at":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"409":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"422":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/connections/{id}/reconnect":{"post":{"operationId":"reconnectConnection","summary":"Renovar uma conexão","tags":["Conexões"],"description":"Renova uma conexão que falhou ou cuja autorização venceu, mantendo o mesmo id. Siga o mesmo fluxo da criação: consulte o estado e envie oauth_url ao titular quando ela aparecer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cpf":{"type":"string","maxLength":20,"description":"CPF de quem autoriza no banco. Obrigatório quando o titular é um CNPJ (o representante que tem acesso ao banco); ignorado quando o titular é um CPF."},"return_url":{"type":"string","maxLength":2000,"description":"URL https para onde o titular volta depois de autorizar no banco. O domínio precisa estar cadastrado nos domínios de retorno da conta."}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"Identificador da conexão, devolvido em GET /v1/connections"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"holder_document":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"state":{"type":"string","description":"Estado da conexão: connecting (em andamento, consulte de novo em 2 segundos), waiting_oauth (o titular precisa abrir oauth_url e autorizar no banco), waiting_mfa (o banco pede o valor descrito em parameter; envie em POST /v1/connections/{id}/mfa), succeeded (conectada, os dados já podem ser lidos), pending_approval (aguarda aprovação de outro representante no banco), document_mismatch (o banco autorizado não pertence ao documento do titular), failed (falhou; veja error e tente POST /v1/connections/{id}/reconnect)."},"oauth_url":{"type":"string","nullable":true,"description":"Em waiting_oauth: o link que o titular abre para autorizar no banco"},"oauth_expires_at":{"type":"string","nullable":true},"parameter":{"type":"object","nullable":true,"description":"Em waiting_mfa: o campo que o banco pede","properties":{"name":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"placeholder":{"type":"string","nullable":true},"validation":{"type":"string","nullable":true,"description":"Expressão regular que o valor precisa satisfazer"},"validation_message":{"type":"string","nullable":true},"assistive_text":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"optional":{"type":"boolean"},"expires_at":{"type":"string","nullable":true},"data":{"type":"string","nullable":true,"description":"Conteúdo auxiliar, como a imagem de um QR code"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}}}}}},"error":{"type":"object","nullable":true,"properties":{"code":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}}},"accounts_count":{"type":"integer"},"balance":{"type":"number","nullable":true,"description":"Soma dos saldos mais recentes das contas da conexão"},"balance_observed_at":{"type":"string","nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"409":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"422":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/accounts":{"get":{"operationId":"listAccounts","summary":"Listar contas do titular","tags":["Contas"],"description":"Lista as contas correntes, poupanças e cartões de crédito das conexões do titular, com o saldo mais recente de cada uma. balance_source diz se o saldo foi lido agora (realtime) ou na última coleta diária (snapshot).","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"type":{"type":"string","nullable":true,"description":"BANK ou CREDIT"},"subtype":{"type":"string","nullable":true,"description":"Por exemplo CHECKING_ACCOUNT, SAVINGS_ACCOUNT, CREDIT_CARD"},"name":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true},"balance_observed_at":{"type":"string","nullable":true,"description":"Momento em que o saldo foi lido no banco"},"balance_source":{"type":"string","nullable":true,"description":"realtime (lido agora) ou snapshot (última coleta diária)"},"credit_limit":{"type":"number","nullable":true},"available_credit_limit":{"type":"number","nullable":true},"closing_date":{"type":"string","nullable":true},"due_date":{"type":"string","nullable":true}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/balance":{"get":{"operationId":"getBalance","summary":"Saldo consolidado","tags":["Saldos"],"description":"Soma os saldos das contas do titular informado em x-holder-document. Com x-holder-document: all, soma todos os titulares da conta e detalha cada um em holders.","parameters":[{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders. Aceita all para somar todos os titulares da conta."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number","nullable":true},"currency":{"type":"string","nullable":true},"observed_at":{"type":"string","nullable":true},"holders":{"type":"array","items":{"type":"object","properties":{"document":{"type":"string"},"document_type":{"type":"string"},"name":{"type":"string","nullable":true},"total":{"type":"number","nullable":true},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer","description":"Identificador da instituição, o mesmo de GET /v1/institutions"},"name":{"type":"string"},"image_url":{"type":"string","nullable":true}}},"type":{"type":"string","nullable":true,"description":"BANK ou CREDIT"},"subtype":{"type":"string","nullable":true,"description":"Por exemplo CHECKING_ACCOUNT, SAVINGS_ACCOUNT, CREDIT_CARD"},"name":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true},"balance_observed_at":{"type":"string","nullable":true,"description":"Momento em que o saldo foi lido no banco"},"balance_source":{"type":"string","nullable":true,"description":"realtime (lido agora) ou snapshot (última coleta diária)"},"credit_limit":{"type":"number","nullable":true},"available_credit_limit":{"type":"number","nullable":true},"closing_date":{"type":"string","nullable":true},"due_date":{"type":"string","nullable":true}}}}}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/balance-history":{"get":{"operationId":"getBalanceHistory","summary":"Histórico de saldo por conta","tags":["Saldos"],"description":"Devolve a série diária de saldo de cada conta do titular no período. Não é paginada: cada item é uma conta com seus pontos.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":false,"description":"Data inicial, AAAA-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":false,"description":"Data final, AAAA-MM-DD"},{"schema":{"type":"string"},"in":"query","name":"account_id","required":false,"description":"Restringe a uma conta de GET /v1/accounts"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string"},"name":{"type":"string","nullable":true},"points":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"balance":{"type":"number","nullable":true}}}}}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/transactions":{"get":{"operationId":"listTransactions","summary":"Listar transações do titular","tags":["Transações"],"description":"Lista as transações das contas do titular, da mais recente para a mais antiga. amount vem em reais, negativo nas saídas e positivo nas entradas. payer e receiver trazem a contraparte, com CNAE quando ela é empresa.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":false,"description":"Data inicial, AAAA-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":false,"description":"Data final, AAAA-MM-DD"},{"schema":{"type":"string"},"in":"query","name":"account_id","required":false,"description":"Restringe a uma conta de GET /v1/accounts"},{"schema":{"type":"string"},"in":"query","name":"connection_id","required":false,"description":"Restringe a uma conexão de GET /v1/connections"},{"schema":{"type":"string","enum":["credit","debit"]},"in":"query","name":"type","required":false,"description":"credit para entradas, debit para saídas"},{"schema":{"type":"string","maxLength":200},"in":"query","name":"description","required":false,"description":"Trecho da descrição, sem diferenciar maiúsculas"},{"schema":{"type":"number"},"in":"query","name":"min_amount","required":false,"description":"Valor mínimo, em reais"},{"schema":{"type":"number"},"in":"query","name":"max_amount","required":false,"description":"Valor máximo, em reais"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string"},"description":{"type":"string","nullable":true},"amount":{"type":"number","description":"Em reais. Saída negativa, entrada positiva."},"type":{"type":"string","description":"credit ou debit"},"status":{"type":"string","nullable":true,"description":"POSTED ou PENDING"},"account":{"type":"object","nullable":true,"properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"number":{"type":"string","nullable":true}}},"connection_id":{"type":"string","nullable":true},"institution":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string","nullable":true}}},"payer":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"document_type":{"type":"string","nullable":true},"activity_code":{"type":"string","nullable":true,"description":"CNAE principal da contraparte, quando ela é uma empresa"},"activity_description":{"type":"string","nullable":true}}},"receiver":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true},"document":{"type":"string","nullable":true},"document_type":{"type":"string","nullable":true},"activity_code":{"type":"string","nullable":true,"description":"CNAE principal da contraparte, quando ela é uma empresa"},"activity_description":{"type":"string","nullable":true}}},"payment_method":{"type":"string","nullable":true,"description":"Por exemplo PIX, TED, BOLETO"},"is_internal_transfer":{"type":"boolean","description":"Transferência entre contas do mesmo titular"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/card-bills":{"get":{"operationId":"listCardBills","summary":"Listar faturas de cartão do titular","tags":["Faturas de cartão"],"description":"Lista as faturas dos cartões de crédito do titular, com vencimento, fechamento, total, pagamento mínimo e pagamentos feitos. O período filtra pelo vencimento.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"from","required":false,"description":"Vencimento inicial, AAAA-MM-DD"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"to","required":false,"description":"Vencimento final, AAAA-MM-DD"},{"schema":{"type":"string"},"in":"query","name":"account_id","required":false,"description":"Restringe a um cartão de GET /v1/accounts"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"account_id":{"type":"string","nullable":true},"due_date":{"type":"string","nullable":true},"close_date":{"type":"string","nullable":true},"total_amount":{"type":"number","nullable":true},"minimum_payment_amount":{"type":"number","nullable":true},"currency":{"type":"string","nullable":true},"payments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true}}}}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/investments":{"get":{"operationId":"listInvestments","summary":"Listar investimentos do titular","tags":["Investimentos"],"description":"Lista as posições de investimento das conexões do titular (renda fixa, fundos, ações e outros), com saldo atual, valor aplicado, emissor e taxa.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"subtype":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true,"description":"Saldo bruto atual"},"amount":{"type":"number","nullable":true,"description":"Valor aplicado"},"currency":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"issuer":{"type":"string","nullable":true},"rate":{"type":"number","nullable":true}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/loans":{"get":{"operationId":"listLoans","summary":"Listar empréstimos do titular","tags":["Empréstimos"],"description":"Lista os contratos de empréstimo e financiamento das conexões do titular, com valor contratado, saldo devedor, parcelas, vencimento e taxa de juros.","parameters":[{"schema":{"type":"integer","minimum":1,"default":1},"in":"query","name":"page","required":false,"description":"Página, a partir de 1"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"per_page","required":false,"description":"Itens por página, de 1 a 100"},{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"connection_id":{"type":"string","nullable":true},"product_name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"contract_amount":{"type":"number","nullable":true},"outstanding_balance":{"type":"number","nullable":true},"currency":{"type":"string","nullable":true},"installments":{"type":"integer","nullable":true,"description":"Número total de parcelas"},"due_date":{"type":"string","nullable":true},"interest_rate":{"type":"number","nullable":true}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer","description":"Total de itens em todas as páginas"},"total_pages":{"type":"integer"},"prev":{"type":"integer","nullable":true,"description":"Página anterior, ou null na primeira"},"next":{"type":"integer","nullable":true,"description":"Próxima página, ou null na última"}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}},"/v1/holder-profile":{"get":{"operationId":"getHolderProfile","summary":"Dados cadastrais do titular","tags":["Perfil do titular"],"description":"Devolve os dados cadastrais do titular. Para CNPJ: razão social, nome fantasia, atividade principal (CNAE), sócios e procuradores. Para CPF: documento e nome; os campos de empresa vêm nulos ou vazios.","parameters":[{"schema":{"type":"string"},"in":"header","name":"x-holder-document","required":true,"description":"CPF ou CNPJ do titular que a chamada consulta, com ou sem máscara. O CNPJ pode ser alfanumérico. Use um documento já cadastrado em GET /v1/holders."}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"document":{"type":"string"},"document_type":{"type":"string","enum":["cpf","cnpj"]},"name":{"type":"string","nullable":true},"trade_name":{"type":"string","nullable":true,"description":"Nome fantasia (só CNPJ)"},"main_activity":{"type":"object","nullable":true,"description":"Atividade principal (só CNPJ)","properties":{"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true}}},"partners":{"type":"array","description":"Sócios (só CNPJ)","items":{"type":"object","properties":{"name":{"type":"string","nullable":true}}}},"procurators":{"type":"array","description":"Procuradores (só CNPJ)","items":{"type":"object","properties":{"name":{"type":"string","nullable":true}}}}}}}}},"400":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"401":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"402":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"403":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"404":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"429":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"500":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}},"502":{"description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","content":{"application/json":{"schema":{"type":"object","description":"Envelope de erro. Use type para decidir o que fazer; message é texto em português para uma pessoa.","properties":{"error":{"type":"object","properties":{"code":{"type":"integer","description":"Status HTTP"},"type":{"type":"string","description":"Tipo estável do erro, por exemplo unauthorized, invalid_request, payment_required, holder_not_found, connection_exists, credentials_on_authorization_page, rate_limited"},"message":{"type":"string"},"reason":{"type":"string","description":"Motivo detalhado quando o tipo é genérico, por exemplo subscription_required ou trial_already_used em payment_required"},"connection_id":{"type":"string","description":"Em connection_exists: a conexão viva que deve ser renovada"},"authorization_url":{"type":"string","description":"Em credentials_on_authorization_page: a página onde o titular conclui a conexão"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}}}}},"servers":[{"url":"https://api.openfinancemcp.ai"}],"tags":[{"name":"Conta","description":"Dados da chave de API"},{"name":"Titulares","description":"CPFs e CNPJs da conta e os links para eles autorizarem bancos"},{"name":"Instituições","description":"Bancos disponíveis para conexão"},{"name":"Conexões","description":"Conectar um banco ao titular, acompanhar o estado e renovar"},{"name":"Contas","description":"Contas e cartões das conexões do titular"},{"name":"Saldos","description":"Saldo consolidado e histórico diário"},{"name":"Transações","description":"Transações bancárias do titular"},{"name":"Faturas de cartão","description":"Faturas dos cartões de crédito"},{"name":"Investimentos","description":"Posições de investimento"},{"name":"Empréstimos","description":"Contratos de empréstimo e financiamento"},{"name":"Perfil do titular","description":"Dados cadastrais do CPF ou CNPJ"}]}