# Listar proprietários

## ▶️ Uso

Com o método List Owners, você pode:

1. Listar proprietários relacionados a um link.id específico (usando o parâmetro de consulta link).
2. Obter os detalhes de um owners.id específico (usando o parâmetro de consulta id).
3. [Não Recomendado] Listar todos os proprietários relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar nas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, consulte nosso artigo Filtrando respostas.

## 🚨 Campos Obsoletos

Este recurso pode retornar campos obsoletos. Na documentação de resposta, você pode ver que um campo foi marcado como obsoleto. Isso significa que este campo não é mais mantido pela equipe da Belvo. Você ainda pode receber dados para este campo dependendo da instituição, no entanto, não deve confiar neste campo.

Endpoint: GET /api/owners/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `link` (string)
    O link.id pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.
    Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4"

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

  - `link__in` (array)
    Retorne resultados apenas para esses link.ids.
    Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"]

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `email` (string)
    Retorna proprietários cujo endereço de e-mail corresponde à sua consulta.
    Example: "lopes.d@gmail.com"

  - `display_name__icontains` (string)
    Retorne proprietários cujo nome completo de exibição corresponda parcialmente à sua consulta. Por exemplo, mar retornará resultados para Mark, Maria, Neymar, Remarque, e assim por diante.
    Example: "Daniela"

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array) — one of:
    Uma matriz de:

  - objetos Owner Individual (OFDA Brazil)
  - objetos Owner Business (OFDA Brazil)
  - objetos Owner Standard (Multi-Region)
  
  > 🚧 Um tipo de esquema por resposta
  >
  > A resposta conterá uma matriz de um dos tipos de esquema descritos acima. Em outras palavras, não haverá uma mistura de tipos de esquema na resposta.
    - Proprietário Individual (OFDA Brasil):
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `link` (string,null, required)
        O link.id ao qual os dados pertencem.
        Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"
      - `internal_identification` (string,null, required)
        O identificador interno da instituição para o proprietário.
        Example: "7e5838e4"
      - `collected_at` (string, required)
        O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
        Example: "2022-02-09T08:45:50.406032Z"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `display_name` (string, required)
        O nome completo do indivíduo, conforme fornecido pela instituição.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Jack Oswald White"
      - `social_name` (string,null, required)
        O nome social do indivíduo, conforme geralmente aceito pelo país.
        Example: "O Piadista"
      - `birth_date` (string, required)
        A data de nascimento do indivíduo, no formato YYYY-MM-DD.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "1988-07-15"
      - `marital_status` (string,null, required)
        O estado civil do indivíduo. Retornamos um dos seguintes valores:

  - SINGLE
  - MARRIED
  - WIDOWED
  - SEPARATED
  - DIVORCED
  - CIVIL_UNION
  - OTHER
        Enum: "SINGLE", "MARRIED", "WIDOWED", "SEPARATED", "DIVORCED", "CIVIL_UNION", "OTHER"
      - `marital_status_additional_info` (string,null, required)
        Informações adicionais sobre o estado civil do indivíduo.
        Example: "It's complicated"
      - `gender` (string,null, required)
        O gênero do indivíduo. Retornamos um dos seguintes valores:

  - FEMALE
  - MALE
  - OTHER
        Enum: "FEMALE", "MALE", "OTHER"
      - `companies_id` (array, required)
        As instituições responsáveis pela criação e verificação do proprietário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: ["01773247000103"]
      - `is_local_resident` (boolean, required)
        Boolean para indicar se o indivíduo é residente local do país.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `document_id` (object, required)
        Informações sobre o documento de identificação que o proprietário forneceu ao banco.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `document_id.document_type` (string, required)
        O tipo de documento que o proprietário forneceu à instituição para abrir a conta. Tipos comuns de documentos são:

🇧🇷 Brasil
- CPF (Cadastro de Pessoas Físicas)
- CNPJ (Cadastro Nacional de Pessoas Jurídicas)

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "CPF"
      - `document_id.document_number` (string, required)
        O número de identificação do documento.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "235578435-S"
      - `additional_documents` (array, required)
        Informações detalhadas sobre documentos adicionais fornecidos para comprovar a identidade dos indivíduos.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `additional_documents.type` (string,null, required)
        O tipo de documento de identificação. Retornamos um dos seguintes valores:

  - DRIVERS_LICENSE
  - PASSPORT
  - ID_CARD
  - FISCAL_ID
  - FOREIGNER_REGISTRATION_CARD
  - OTHER
  - null
        Enum: "DRIVERS_LICENSE", "PASSPORT", "ID_CARD", "FISCAL_ID", "FOREIGNER_REGISTRATION_CARD", "OTHER", null
      - `additional_documents.type_additional_info` (string,null, required)
        Informações adicionais sobre o tipo de documento.

> Nota: Para documentos de ID Empresarial, este campo deve retornar um valor da rede de open finance do Brasil.
        Example: "Learner's licence"
      - `additional_documents.number` (string, required)
        O número do documento de identidade.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "DL-7896829-7"
      - `additional_documents.check_digit` (string, required)
        O dígito verificador do documento de identidade.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "7"
      - `additional_documents.issue_date` (string,null, required)
        A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `additional_documents.expiration_date` (string,null, required)
        A data de expiração do documento de identidade, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `additional_documents.country_of_issuance` (string,null, required)
        O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).

Este campo deve ser retornado quando o type for PASSPORT.
        Example: "CAN"
      - `additional_documents.additional_info` (string,null, required)
        Informações adicionais sobre o documento de identificação.
        Example: "The document has water damage"
      - `nationalities` (array,null, required)
        Informações detalhadas sobre as nacionalidades do indivíduo.

Só é necessário retornar quando is_local_resident estiver definido como false.
      - `nationalities.info` (string,null, required)
        A nacionalidade do indivíduo.
        Example: "CAN"
      - `nationalities.documents` (array, required)
      - `nationalities.documents.type` (string,null, required)
        O tipo de documento de identificação. Retornamos um dos seguintes valores:

  - DRIVERS_LICENSE
  - PASSPORT
  - ID_CARD
  - FISCAL_ID
  - FOREIGNER_REGISTRATION_CARD
  - OTHER
  - null
        Enum: same as `additional_documents.type` in "Proprietário Individual (OFDA Brasil)" (7 values)
      - `nationalities.documents.number` (string, required)
        O número do documento de identidade.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "DL-7896829-7"
      - `nationalities.documents.issue_date` (string,null, required)
        A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `nationalities.documents.expiration_date` (string,null, required)
        A data de expiração do documento de identidade, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `nationalities.documents.country_of_issuance` (string,null, required)
        O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).

Este campo deve ser retornado quando o type for PASSPORT.
        Example: "CAN"
      - `nationalities.documents.additional_info` (string,null, required)
        Informações adicionais sobre o documento de identificação.
        Example: "The document has water damage"
      - `email` (string,null, required)
        O endereço de e-mail registrado do proprietário da conta.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "johndoe@belvo.com"
      - `emails` (array, required)
        Lista adicional de e-mails fornecida pelo proprietário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `emails.is_main` (boolean, required)
        Boolean para indicar se este é o endereço de e-mail principal do usuário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `emails.email` (string, required)
        O endereço de e-mail do usuário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "homen_morcego@gmail.com"
      - `address` (string,null, required)
        O endereço registrado do proprietário da conta.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Carrer de la Llacuna, 162, 08018 Barcelona"
      - `addresses` (array, required)
        Informações detalhadas sobre os endereços do proprietário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `addresses.is_main` (boolean, required)
        Boolean para indicar se este é o endereço principal do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `addresses.address` (string, required)
        O endereço do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Av Naburo Ykesaki, 1270"
      - `addresses.additional_info` (string,null, required)
        Informações adicionais sobre o endereço do usuário.
        Example: "In between two palm trees"
      - `addresses.district_name` (string,null, required)
        O distrito do endereço.
        Example: "CENTRO"
      - `addresses.town` (string, required)
        A cidade do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Brasilia"
      - `addresses.town_code` (string,null, required)
        O código de sete dígitos para a cidade, se aplicável.

Para o Brasil, este é o código do município do IBGE.
        Example: "3550308"
      - `addresses.state` (string,null, required)
        O estado em que o endereço está localizado.
        Example: "SP"
      - `addresses.postcode` (string, required)
        O código postal do endereço.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "17500001"
      - `addresses.country_name` (string, required)
        O nome do país.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Brasil"
      - `addresses.country_code` (string,null, required)
        O código de país de três letras (conforme ISO-3166 Alpha 3).
        Example: "BRA"
      - `addresses.latitude` (string,null, required)
        A coordenada de latitude geográfica.
        Example: "-23.5475000"
      - `addresses.longitude` (string,null, required)
        A coordenada de longitude geográfica.
        Example: "-46.6361100"
      - `phone_number` (string,null, required)
        O número de telefone registrado do proprietário da conta.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "+52-XXX-XXX-XXXX"
      - `phone_numbers` (array, required)
        Informações detalhadas sobre os números de telefone do proprietário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `phone_numbers.is_main` (boolean, required)
        Boolean para indicar se este é o número de telefone principal do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `phone_numbers.type` (string,null, required)
        O tipo de número de telefone. Retornamos um dos seguintes valores:

  - LANDLINE
  - MOBILE
  - OTHER
  - null
        Enum: "LANDLINE", "MOBILE", "OTHER", null
      - `phone_numbers.additional_info` (string,null, required)
        Informações adicionais sobre o número de telefone.
        Example: "This is their work mobile number."
      - `phone_numbers.number` (string, required)
        O número de telefone (não incluindo o código do país, área ou ramal).

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "29875132"
      - `phone_numbers.country_code` (string,null, required)
        O código de discagem do país. Por exemplo: 351 (sem +).
        Example: "351"
      - `phone_numbers.area_code` (string,null, required)
        O código de discagem da área.
        Example: "21"
      - `phone_numbers.extension` (string,null, required)
        O código da extensão.
        Example: "932"
      - `filiations` (array, required)
        Informações sobre quaisquer relações familiares do indivíduo.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `filiations.type` (string,null, required)
        A relação familiar. Retornamos um dos seguintes valores:

  - MOTHER
  - FATHER
  - null
        Enum: "MOTHER", "FATHER", null
      - `filiations.civil_name` (string, required)
        O nome completo da pessoa.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Bruce Wayne"
      - `filiations.social_name` (string,null, required)
        O nome social da pessoa.
        Example: "The Dark Knight"
      - `financial_profile` (object,null, required)
        Informações sobre o perfil financeiro do indivíduo.
      - `financial_profile.company_id` (string,null, required)
        O identificador da empresa onde o indivíduo está empregado.
        Example: "50685362000135"
      - `financial_profile.occupation_code` (string,null, required)
        A área de emprego do indivíduo. Retornamos um dos seguintes valores:

  - BRAZIL_PUBLIC_OFFICE
  - BRAZIL_OCCUPATION_CODE
  - OTHER
  - null
        Enum: "BRAZIL_PUBLIC_OFFICE", "BRAZIL_OCCUPATION_CODE", "OTHER", null
      - `financial_profile.occupation_description` (string,null, required)
        Informações sobre a ocupação do indivíduo.
        Example: "01"
      - `financial_profile.informed_income` (object, required)
        Informações sobre a renda declarada do indivíduo.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `financial_profile.informed_income.frequency` (string,null, required)
        Indica com que frequência o indivíduo recebe seu salário. Retornamos um dos seguintes valores:

  - DAILY
  - WEEKLY
  - FORTNIGHTLY
  - MONTHLY
  - BIMONTHLY
  - QUARTERLY
  - BIANNUALLY
  - ANNUALLY
  - OTHERS
        Enum: "DAILY", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "BIANNUALLY", "ANNUALLY", "OTHERS"
      - `financial_profile.informed_income.amount` (number, required)
        A renda declarada que o indivíduo recebe.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: 45391.89
      - `financial_profile.informed_income.currency` (string, required)
        O código de moeda de três letras (ISO-4217).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "BRL"
      - `financial_profile.informed_income.date` (string, required)
        Data em que o indivíduo recebeu seu salário pela última vez.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "2020-03-19"
      - `financial_profile.patrimony` (object,null, required)
        Informações sobre os ativos relatados do indivíduo (se disponíveis).
      - `financial_profile.patrimony.amount` (number, required)
        Os ativos relatados do indivíduo.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil quando o objeto patrimony estiver disponível.
        Example: 45391.89
      - `financial_profile.patrimony.currency` (string, required)
        O código de moeda de três letras (ISO-4217).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o objeto patrimony estiver disponível.
        Example: "BRL"
      - `financial_profile.patrimony.year` (integer, required)
        O ano ao qual os ativos reportados se aplicam.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil quando o objeto patrimony estiver disponível.
        Example: 2020
      - `financial_relation` (object,null, required)
        Detalhes sobre qualquer relacionamento adicional que o indivíduo tenha com a instituição (por exemplo, outras contas ou produtos que ele possua com a instituição).
      - `financial_relation.start_date` (string, required)
        O carimbo de data/hora ISO-8601 quando o relacionamento financeiro entre o indivíduo e a instituição começou.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "2021-05-21T08:30:00Z"
      - `financial_relation.product_services` (array, required)
        Uma lista de produtos que o indivíduo possui com a instituição.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: ["CONTA_DEPOSITO_A_VISTA"]
      - `financial_relation.product_services_additional_info` (string,null, required)
        Informações adicionais sobre os produtos que o indivíduo possui.
        Example: "Joint account with Robin"
      - `financial_relation.procurators` (array, required)
        Informações sobre quaisquer indivíduos ou empresas que possam agir em nome do proprietário.
      - `financial_relation.procurators.type` (string,null, required)
        O tipo de representante que pode acessar e fazer alterações na conta. Retornamos um dos seguintes valores:

  - LEGAL_REPRESENTATIVE
  - ATTORNEY
  - null
        Enum: "LEGAL_REPRESENTATIVE", "ATTORNEY", null
      - `financial_relation.procurators.civil_name` (string, required)
        O nome completo dos representantes.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.
        Example: "Alfred Thaddeus Pennyworth"
      - `financial_relation.procurators.social_name` (string,null, required)
        O nome social da pessoa.
        Example: "Alfred Pennyworth"
      - `financial_relation.procurators.document_number` (string, required)
        O número do documento do representante.

Nota: Para indivíduos, este é o número do CPF do Brasil. Para empresas, este é o número do CNPJ do Brasil.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.
        Example: "73677831148"
      - `financial_relation.products` (array, required)
        Detalhes sobre quaisquer produtos adicionais que o indivíduo possua com a instituição.
      - `financial_relation.products.type` (string,null, required)
        Os produtos adicionais que o indivíduo possui na instituição. Retornamos um dos seguintes valores:

  - SAVINGS_ACCOUNT
  - CHECKING_ACCOUNT
  - null
        Enum: "SAVINGS_ACCOUNT", "CHECKING_ACCOUNT", null
      - `financial_relation.products.subtype` (string,null, required)
        O subtipo do produto que o indivíduo possui na instituição.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "CONJUNTA_SIMPLES"
      - `financial_relation.products.agency` (string,null, required)
        O código da agência onde o produto foi aberto.
        Example: "6272"
      - `financial_relation.products.clearing_code` (string, required)
        O código de compensação bancária para o produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "001"
      - `financial_relation.products.number` (string, required)
        O número da conta do produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.
        Example: "24550245"
      - `financial_relation.products.check_digit` (string, required)
        O dígito verificador do número do produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "7"
      - `financial_relation.salary_portability_requests` (array)
        Detalhes sobre quaisquer solicitações de portabilidade de salário que o indivíduo tenha feito com a instituição.

Uma portabilidade de salário é uma solicitação para transferir o salário do indivíduo da conta bancária de 'folha de pagamento' do empregador para outra conta bancária.

> 📘 
>
> Por favor, note que a conta bancária receptora não pode encerrar uma portabilidade de salário (ou ser informada de que ela foi encerrada). Apenas o banco da folha de pagamento do empregador pode fornecer essa informação. Assim, as portabilidades listadas aqui podem não estar atualizadas.
      - `financial_relation.salary_portability_requests.employer_name` (string)
        O nome do empregador.
        Example: "ACME Inc."
      - `financial_relation.salary_portability_requests.employer_id_number` (string)
        O CPF ou CNPJ do empregador.
        Example: 12345678901
      - `financial_relation.salary_portability_requests.employer_bank_id_number` (string)
        O CNPJ do banco do empregador.
        Example: 12345678901234
      - `financial_relation.salary_portability_requests.employer_bank_code` (string)
        O código ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco do empregador.
        Example: 12345678
      - `financial_relation.salary_portability_requests.portability_approval_date` (string)
        A data em que a solicitação de portabilidade foi aprovada, no formato YYYY-MM-DD.
        Example: "2024-04-01"
      - `financial_relation.payroll_accounts` (array)
        Detalhes sobre quaisquer contas bancárias de folha de pagamento associadas ao indivíduo. Ou seja, cada vez que o indivíduo tiver um novo empregador do qual recebe salário, isso deve ser listado aqui.

> 📘
>
> Empregadores anteriores podem não fechar a conta de folha de pagamento do indivíduo. Assim, as contas de folha de pagamento listadas aqui podem não estar atualizadas.
      - `financial_relation.payroll_accounts.employer_name` (string)
        O nome do empregador.
        Example: "ACME Inc."
      - `financial_relation.payroll_accounts.employer_id_number` (string)
        O CPF ou CNPJ do empregador.
        Example: 12345678901
      - `financial_relation.payroll_accounts.employer_bank_id_number` (string)
        O CNPJ do banco do empregador.
        Example: 12345678901234
      - `financial_relation.payroll_accounts.employer_bank_code` (string)
        O código ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco do empregador.
        Example: 12345678
      - `financial_relation.payroll_accounts.account_opening_date` (string)
        A data em que a conta bancária de salário foi aberta, no formato YYYY-MM-DD.
        Example: "2024-04-01"
    - Proprietário de Negócios (OFDA Brasil):
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `link` (string,null, required)
        O link.id ao qual os dados pertencem.
        Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"
      - `internal_identification` (string,null, required)
        O identificador interno da instituição para o proprietário.
        Example: "7e5838e4"
      - `collected_at` (string, required)
        O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
        Example: "2022-02-09T08:45:50.406032Z"
      - `created_at` (string, required)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `company_name` (string, required)
        O nome completo (oficial) do negócio, conforme fornecido pela instituição.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Wayne Enterprises"
      - `trade_name` (string,null, required)
        O nome comercial da empresa.
        Example: "WayneCorp"
      - `incorporation_date` (string, required)
        A data em que a empresa foi constituída, no formato YYYY-MM-DD.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "1988-07-15"
      - `companies_id` (array, required)
        As instituições responsáveis pela criação e verificação do proprietário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: ["01773247000103"]
      - `document_id` (object, required)
        Informações sobre o documento de identificação que o proprietário forneceu ao banco.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `document_id.document_type` (string, required)
        O tipo de documento que o proprietário forneceu à instituição para abrir a conta. Tipos comuns de documentos são:

🇧🇷 Brasil
- CPF (Cadastro de Pessoas Físicas)
- CNPJ (Cadastro Nacional de Pessoas Jurídicas)

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "CPF"
      - `document_id.document_number` (string, required)
        O número de identificação do documento.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "235578435-S"
      - `additional_documents` (array, required)
        Informações detalhadas sobre documentos adicionais fornecidos para comprovar a identidade da empresa.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `additional_documents.type` (string,null, required)
        O tipo de documento de identificação. Retornamos um dos seguintes valores:

  - DRIVERS_LICENSE
  - PASSPORT
  - ID_CARD
  - FISCAL_ID
  - FOREIGNER_REGISTRATION_CARD
  - OTHER
  - null
        Enum: same as `additional_documents.type` in "Proprietário Individual (OFDA Brasil)" (7 values)
      - `additional_documents.type_additional_info` (string,null, required)
        Informações adicionais sobre o tipo de documento.

> Nota: Para documentos de ID Empresarial, este campo deve retornar um valor da rede de open finance do Brasil.
        Example: "EIN"
      - `additional_documents.number` (string, required)
        O número do documento de identidade.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "DL-7896829-7"
      - `additional_documents.check_digit` (string, required)
        O dígito verificador do documento de identidade.

> Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.
      - `additional_documents.issue_date` (string,null, required)
        A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.

> Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.
      - `additional_documents.expiration_date` (string,null, required)
        A data de expiração do documento de identidade, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `additional_documents.country_of_issuance` (string,null, required)
        O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "CAN"
      - `additional_documents.additional_info` (string,null, required)
        Informações adicionais sobre o documento de identificação.

> Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.
      - `email` (string,null, required)
        O endereço de e-mail registrado do proprietário da conta.
        Example: "johndoe@belvo.com"
      - `emails` (array, required)
        Lista adicional de e-mails fornecida pelo proprietário.
      - `emails.is_main` (boolean, required)
        Boolean para indicar se este é o endereço de e-mail principal do usuário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `emails.email` (string, required)
        O endereço de e-mail do usuário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "homen_morcego@gmail.com"
      - `address` (string,null, required)
        O endereço registrado do proprietário das contas.
        Example: "Carrer de la Llacuna, 162, 08018 Barcelona"
      - `addresses` (array, required)
        Informações detalhadas sobre os endereços do proprietário.
      - `addresses.is_main` (boolean, required)
        Boolean para indicar se este é o endereço principal do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `addresses.address` (string, required)
        O endereço do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Av Naburo Ykesaki, 1270"
      - `addresses.additional_info` (string,null, required)
        Informações adicionais sobre o endereço do usuário.
        Example: "In between two palm trees"
      - `addresses.district_name` (string,null, required)
        O distrito do endereço.
        Example: "CENTRO"
      - `addresses.town` (string, required)
        A cidade do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Brasilia"
      - `addresses.town_code` (string,null, required)
        O código de sete dígitos para a cidade, se aplicável.

Para o Brasil, este é o código do município do IBGE.
        Example: "3550308"
      - `addresses.state` (string,null, required)
        O estado em que o endereço está localizado.
        Example: "SP"
      - `addresses.postcode` (string, required)
        O código postal do endereço.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "17500001"
      - `addresses.country_name` (string, required)
        O nome do país.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "Brasil"
      - `addresses.country_code` (string,null, required)
        O código de país de três letras (conforme ISO-3166 Alpha 3).
        Example: "BRA"
      - `addresses.latitude` (string,null, required)
        A coordenada de latitude geográfica.
        Example: "-23.5475000"
      - `addresses.longitude` (string,null, required)
        A coordenada de longitude geográfica.
        Example: "-46.6361100"
      - `phone_number` (string,null, required)
        O número de telefone registrado do proprietário da conta.
        Example: "+52-XXX-XXX-XXXX"
      - `phone_numbers` (array, required)
        Informações detalhadas sobre os phone_numbers do proprietário.
      - `phone_numbers.is_main` (boolean, required)
        Boolean para indicar se este é o número de telefone principal do usuário.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: true
      - `phone_numbers.type` (string,null, required)
        O tipo de número de telefone. Retornamos um dos seguintes valores:

  - LANDLINE
  - MOBILE
  - OTHER
  - null
        Enum: same as `phone_numbers.type` in "Proprietário Individual (OFDA Brasil)" (4 values)
      - `phone_numbers.additional_info` (string,null, required)
        Informações adicionais sobre o número de telefone.
        Example: "This is their work mobile number."
      - `phone_numbers.number` (string, required)
        O número de telefone (não incluindo o código do país, área ou ramal).

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "29875132"
      - `phone_numbers.country_code` (string,null, required)
        O código de discagem do país. Por exemplo: 351 (sem +).
        Example: "351"
      - `phone_numbers.area_code` (string,null, required)
        O código de discagem da área.
        Example: "21"
      - `phone_numbers.extension` (string,null, required)
        O código da extensão.
        Example: "932"
      - `parties` (array, required)
        Informações detalhadas sobre as partes autorizadas a agir em nome do proprietário.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
      - `parties.person_type` (string,null, required)
        O tipo de pessoa que é parte proprietária da conta. Retornamos um dos seguintes valores:

  - INDIVIDUAL
  - COMPANY
        Enum: "INDIVIDUAL", "COMPANY"
      - `parties.type` (string,null, required)
        O tipo de acesso que o person_type tem à conta. Retornamos um dos seguintes valores:

- MEMBER indica que o person_type tem acesso de leitura à conta.
- ADMINISTRATOR indica que o person_type pode realizar todas as ações para a conta (incluindo transferências).
        Enum: "MEMBER", "ADMINISTRATOR"
      - `parties.display_name` (string,null, required)
        O nome completo do indivíduo, conforme fornecido pela instituição. Aplicável apenas se o person_type for INDIVIDUAL.
        Example: "Jack Oswald White"
      - `parties.social_name` (string,null, required)
        O nome social do indivíduo, conforme geralmente aceito pelo país. Aplicável apenas se o person_type for INDIVIDUAL.
        Example: "O Piadista"
      - `parties.company_name` (string,null)
        O nome completo (oficial) da empresa. Aplicável apenas se o person_type for COMPANY.
        Example: "Wayne Enterprises"
      - `parties.trade_name` (string,null, required)
        O nome comercial da empresa. Aplicável apenas se o person_type for COMPANY.
        Example: "WayneCorp"
      - `parties.start_date` (string,null, required)
        A data em que a parte foi adicionada à conta, no formato YYYY-MM-DD.
        Example: "2021-07-15"
      - `parties.percentage_type` (number,null, required)
        A participação acionária da parte.
        Example: 0.51
      - `parties.document_type` (string,null, required)
        O tipo de documento de identificação que a parte forneceu ao ser adicionada à conta. Retornamos um dos seguintes valores:

  - CPF
  - CNPJ
  - OTHER_TRAVEL_DOCUMENT
  - PASSPORT
        Enum: "CPF", "CNPJ", "OTHER_TRAVEL_DOCUMENT", "PASSPORT"
      - `parties.document_number` (string, required)
        O número do documento de identidade.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "DL-7896829-7"
      - `parties.document_issue_date` (string,null, required)
        A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `parties.document_expiration_date` (string,null, required)
        A data de expiração do documento de identidade, no formato YYYY-MM-DD.
        Example: "2019-01-01"
      - `parties.document_country` (string,null, required)
        O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).
        Example: "CAN"
      - `parties.document_additional_info` (string,null, required)
        Informações adicionais sobre o documento.
        Example: "Confirmed CPF with their driver's licence."
      - `financial_profile` (object,null, required)
        Informações sobre o perfil financeiro do indivíduo.
      - `financial_profile.economic_activities` (array, required)
        Detalhes sobre as atividades econômicas relatadas da empresa.
      - `financial_profile.economic_activities.is_main` (boolean, required)
        Boolean para indicar se esta é a principal atividade econômica do negócio.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo economic_activities estiver disponível.
        Example: true
      - `financial_profile.economic_activities.code` (string, required)
        O código da atividade econômica, conforme fornecido pelo país.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo economic_activities estiver disponível.
        Example: "8599604"
      - `financial_profile.informed_revenue` (object,null, required)
        Informações sobre a receita reportada do negócio.
      - `financial_profile.informed_revenue.frequency` (string,null, required)
        Indica com que frequência a empresa declara sua receita. Retornamos um dos seguintes valores:

- DAILY
- WEEKLY
- FORTNIGHTLY
- MONTHLY
- BIMONTHLY
- QUARTERLY
- BIANNUALLY
- ANNUALLY
- OTHERS
- null
        Enum: "DAILY", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "BIANNUALLY", "ANNUALLY", "OTHERS", null
      - `financial_profile.informed_revenue.frequency_additional_info` (string,null, required)
        Informações adicionais sobre a frequência.
        Example: "Recently switched from weekly to monthly."
      - `financial_profile.informed_revenue.amount` (number, required)
        A receita reportada do negócio.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.
        Example: 45391.89
      - `financial_profile.informed_revenue.currency` (string, required)
        O código de moeda de três letras (ISO-4217).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.
        Example: "BRL"
      - `financial_profile.informed_revenue.year` (integer, required)
        O ano em que a receita foi declarada pela última vez.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.
        Example: 2022
      - `financial_profile.patrimony` (object,null, required)
        Informações sobre os ativos relatados do indivíduo.
      - `financial_profile.patrimony.amount` (number, required)
        Os ativos relatados do negócio.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.
        Example: 45391.89
      - `financial_profile.patrimony.currency` (string, required)
        O código de moeda de três letras (ISO-4217).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.
        Example: "BRL"
      - `financial_profile.patrimony.date` (string, required)
        A data em que os ativos relatados foram aplicados, no formato YYYY-MM-DD.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.
        Example: "2022-12-12"
      - `financial_relation` (object,null, required)
        Detalhes sobre qualquer relacionamento adicional que a empresa tenha com a instituição (por exemplo, outras contas ou produtos que ela possua com a instituição).
      - `financial_relation.start_date` (string, required)
        O carimbo de data/hora ISO-8601 quando o relacionamento financeiro entre a empresa e a instituição começou.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: "2021-05-21T08:30:00Z"
      - `financial_relation.product_services` (array, required)
        Uma lista de produtos que a empresa possui com a instituição.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
        Example: ["CONTA_DEPOSITO_A_VISTA"]
      - `financial_relation.procurators` (array, required)
        Informações sobre quaisquer indivíduos ou empresas que possam agir em nome do proprietário.
      - `financial_relation.procurators.type` (string,null, required)
        O tipo de representante que pode acessar e fazer alterações na conta. Retornamos um dos seguintes valores:

  - LEGAL_REPRESENTATIVE
  - ATTORNEY
  - null
        Enum: same as `financial_relation.procurators.type` in "Proprietário Individual (OFDA Brasil)" (3 values)
      - `financial_relation.procurators.civil_name` (string, required)
        O nome completo dos representantes.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.
        Example: "Alfred Thaddeus Pennyworth"
      - `financial_relation.procurators.social_name` (string,null, required)
        O nome social da pessoa.
        Example: "Alfred Pennyworth"
      - `financial_relation.procurators.document_number` (string, required)
        O número do documento do representante.

Nota: Para indivíduos, este é o número do CPF do Brasil. Para empresas, este é o número do CNPJ do Brasil.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.
        Example: "73677831148"
      - `financial_relation.products` (array, required)
        Detalhes sobre quaisquer produtos adicionais que a empresa tenha com a instituição.
      - `financial_relation.products.type` (string,null, required)
        Os produtos adicionais que a empresa possui na instituição. Retornamos um dos seguintes valores:

  - SAVINGS_ACCOUNT
  - CHECKING_ACCOUNT
  - null
        Enum: same as `financial_relation.products.type` in "Proprietário Individual (OFDA Brasil)" (3 values)
      - `financial_relation.products.subtype` (string, required)
        O subtipo do produto que a empresa possui na instituição.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "CONJUNTA_SIMPLES"
      - `financial_relation.products.agency` (string,null, required)
        O código da agência onde o produto foi aberto.
        Example: "6272"
      - `financial_relation.products.clearing_code` (string, required)
        O código de compensação bancária para o produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "001"
      - `financial_relation.products.number` (string, required)
        O número da conta do produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "24550245"
      - `financial_relation.products.check_digit` (string, required)
        O dígito verificador do número do produto.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.
        Example: "7"
    - Proprietário Padrão (Multi-Região):
      - `id` (string, required)
        Identificador único da Belvo para o item atual.
        Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
      - `link` (string,null, required)
        O link.id ao qual os dados pertencem.
        Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"
      - `internal_identification` (string,null, required)
        O identificador interno da instituição para o proprietário.
        Example: "7e5838e4"
      - `collected_at` (string, required)
        O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
        Example: "2022-02-09T08:45:50.406032Z"
      - `created_at` (string)
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
        Example: "2022-02-09T08:45:50.406032Z"
      - `display_name` (string,null, required)
        O nome completo do proprietário, conforme fornecido pelo banco.
        Example: "John Doe"
      - `email` (string,null, required)
        O endereço de e-mail registrado do proprietário da conta.
        Example: "johndoe@belvo.com"
      - `phone_number` (string,null, required)
        O número de telefone registrado do proprietário da conta.
        Example: "+52-XXX-XXX-XXXX"
      - `address` (string,null, required)
        O endereço registrado do proprietário das contas.
        Example: "Carrer de la Llacuna, 162, 08018 Barcelona"
      - `document_id` (object,null)
        Informações sobre o documento de identificação que o proprietário forneceu ao banco.
      - `document_id.document_type` (string,null, required)
        O tipo de documento que o proprietário forneceu à instituição para abrir a conta. Tipos comuns de documentos são:

🇧🇷 Brasil
- CPF (Cadastro de Pessoas Físicas)
- CNPJ (Cadastro Nacional de Pessoas Jurídicas)

🇨🇴 Colômbia
- CC (Cédula de Ciudadanía)
- NIT (Número de Identificación Tributaria)

🇲🇽 México
- CURP (Clave Única de Registro de Población)
- NSS (Número de Seguridad Social)
- RFC (Registro Federal de Contribuyentes)
        Example: "CPF"
      - `document_id.document_number` (string,null, required)
        O número de identificação do documento.
        Example: "235578435-S"
      - `business_name` (string,null)
        Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O nome do negócio.
      - `first_name` (string,null)
        Este campo foi descontinuado. Para mais informações sobre Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O primeiro nome do titular da conta.
      - `last_name` (string,null)
        Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O sobrenome do titular da conta.
      - `second_last_name` (string,null)
        Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O segundo sobrenome do titular da conta.

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Um código de erro único (token_required) que permite classificar e lidar com o erro programaticamente.
ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 428 token_required.
    Example: "token_required"

  - `message` (string)
    Uma breve descrição do erro. Para erros token_required, a descrição é:

- A instituição requer um token MFA para fazer login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Um ID único de 32 caracteres da sessão de login (correspondente a um padrão regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tempo de duração da sessão em segundos.
    Example: 9600

  - `link` (string)
    Identificador único criado pela Belvo, usado para referenciar o Link atual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalhes sobre como gerar o token.

  - `token_generation_data.instructions` (string)
    Instruções para geração de token.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de dados para gerar o token (QR code, desafio numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a ser usado para gerar o token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica se o usuário precisa fornecer entrada para concluir a autenticação. Quando definido como false, seu usuário pode precisar:
- confirmar o login em outro dispositivo
- escanear um código QR
Você ainda precisará fazer uma chamada PATCH para concluir a solicitação.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"