# Recuperar status de impostos para um link

Recuperar informações sobre o status fiscal para um link fiscal específico.

Endpoint: POST /api/tax-status/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `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.

## Request fields (application/json):

  - `link` (string, required)
    O  para o qual você deseja recuperar informações.
    Example: "c81a1dea-6dd6-4999-8b9f-541ee8197058"

  - `attach_pdf` (boolean)
    Quando definido como , você receberá o PDF em formato binário na resposta.
    Example: true

  - `save_data` (boolean)
    Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como  e retornamos uma resposta 201 Created.

Quando definido como , os dados não serão persistidos e retornamos uma resposta 200 OK.
    Example: true

## Response 200 fields (application/json):

  - `id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `link` (string,null, required)
    O  ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `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"

  - `place_and_date_of_issuance` (string,null, required)
    O local e a data em que o status fiscal foi emitido.
    Example: "TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020"

  - `official_name` (string,null, required)
    O nome da pessoa ou empresa.
    Example: "John Doe"

  - `id_cif` (string,null, required)
    O  (CIF) ID do contribuinte.
    Example: "12345678901"

  - `tax_payer_information` (object,null, required)
    Detalhes sobre o contribuinte.

  - `tax_payer_information.rfc` (string,null, required)
    O número de identificação do contribuinte (para o México, este é o RFC).
    Example: "BEMP12345G58"

  - `tax_payer_information.curp` (string,null)
    O número  (CURP) do contribuinte.

  - `tax_payer_information.name` (string,null)
    O primeiro nome do contribuinte.
    Example: "JOHN"

  - `tax_payer_information.first_last_name` (string,null)
    O primeiro sobrenome do contribuinte.
    Example: "DOE"

  - `tax_payer_information.second_last_name` (string,null)
    O segundo sobrenome do contribuinte.
    Example: "SCHMOE"

  - `tax_payer_information.start_operations_date` (string,null, required)
    Data em que o contribuinte iniciou atividades comerciais tributáveis, no formato .

  - `tax_payer_information.status_padron` (string,null, required)
    Status do contribuinte no Registro Federal de Contribuintes (RFC). Pode ser  ou .

  - `tax_payer_information.last_status_change_date` (string,null, required)
    Data em que  foi atualizado mais recentemente, no formato .

  - `tax_payer_information.commercial_name` (string,null)
    O nome da empresa designado para consumidores e o público em geral.

: Aplicável apenas para empresas.
    Example: "Jar Jar Transport"

  - `tax_payer_information.social_name` (string,null)
    O nome único e exclusivo dentro do território nacional que as empresas recebem para fins legais ou administrativos.

: Aplicável apenas para empresas.
    Example: "John Doe SA DE CV"

  - `tax_payer_information.email` (string,null)
    Endereço de e-mail de contato do contribuinte.
    Example: "john_doe@gmail.com"

  - `tax_payer_information.phone` (string,null)
    Número de telefone de contato do contribuinte.
    Example: "1234567890"

  - `address` (object,null, required)
    Os detalhes do endereço do contribuinte.

  - `address.postal_code` (string,null, required)
    O código postal do endereço.
    Example: "21255"

  - `address.street_type` (string,null)
    O tipo .
    Example: "CALLE"

  - `address.street` (string,null)
    A rua dos contribuintes.
    Example: "LA MALINCHE"

  - `address.exterior_number` (string,null)
    O número da rua.
    Example: "432"

  - `address.interior_number` (string,null)
    Informações adicionais do endereço.
    Example: "PLANTA BAJA"

  - `address.suburb` (string,null)
    O subúrbio do contribuinte.
    Example: "BUENAVENTURA"

  - `address.locality` (string,null)
    A localidade do endereço.
    Example: "none"

  - `address.municipality` (string,null)
    O município do endereço.
    Example: "CDMX DC"

  - `address.state` (string,null)
    O estado em que o endereço está.
    Example: "Federal"

  - `address.between_street` (array,null)
    Informações adicionais sobre onde a  está localizada.

  - `address.between_street.street_one` (string,null)
    A primeira rua entre a qual  está localizada.
    Example: "CALLE PRINCIPE"

  - `address.between_street.street_two` (string,null)
    A segunda rua entre a qual  está localizada.
    Example: "CALLE NUEVA ROMA"

  - `economic_activity` (array,null, required)
    Uma lista de objetos de atividade econômica.

  - `economic_activity.economic_activity` (string,null)
    A descrição da atividade econômica.
    Example: "Asalariado"

  - `economic_activity.initial_date` (string,null)
    A data de início da atividade econômica, no formato .
    Example: "2020-12-06"

  - `economic_activity.end_date` (string,null)
    A data de término da atividade econômica, no formato .

  - `economic_activity.order` (string,null)
    A ordem da atividade econômica.
    Example: "2"

  - `economic_activity.percentage` (string,null)
    A porcentagem da atividade econômica.
    Example: "1"

  - `regimes` (array,null, required)
    Uma lista de objetos de regime.

  - `regimes.end_date` (string,null, required)
    A data de término do regime, no formato .

  - `regimes.initial_date` (string,null, required)
    A data de início do regime, no formato .
    Example: "2020-12-06"

  - `regimes.regimen` (string,null, required)
    A descrição do regime.
    Example: "Régimen de Ingresos por Dividendos (socios y accionistas)"

  - `obligations` (array,null, required)
    Detalhes sobre as obrigações de uma empresa.

ℹ️ Para contas não comerciais, este campo retornará vazio.

  - `obligations.obligation` (string,null)
    A descrição da obrigação.
    Example: "Declaración informativa de IVA con la anual de ISR"

  - `obligations.expiration` (string,null)
    O prazo para cumprir a obrigação, conforme imposto pela autoridade fiscal.
    Example: "Conjuntamente con la declaración anual del ejercicio."

  - `obligations.initial_date` (string,null)
    A data em que a obrigação começou, no formato .
    Example: "2020-12-06"

  - `obligations.end_date` (string,null)
    A data em que a obrigação terminou, no formato .

  - `digital_stamp` (string,null, required)
    O certificado de validação do documento.
    Example: "||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN\nFISCAL|2044441088666600000034||\n"

  - `digital_stamp_chain` (string,null, required)
    Uma cadeia de dados contendo a estrutura básica de um cheque fiscal digital. Para o México, este é o  (CFDI).
    Example: "EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=\n"

  - `pdf` (string,null, required)
    PDF de status fiscal como uma string binária.
    Example: "=PDF-STRING="

## Response 201 fields (application/json):

  - `id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `link` (string,null, required)
    O  ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `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"

  - `place_and_date_of_issuance` (string,null, required)
    O local e a data em que o status fiscal foi emitido.
    Example: "TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020"

  - `official_name` (string,null, required)
    O nome da pessoa ou empresa.
    Example: "John Doe"

  - `id_cif` (string,null, required)
    O  (CIF) ID do contribuinte.
    Example: "12345678901"

  - `tax_payer_information` (object,null, required)
    Detalhes sobre o contribuinte.

  - `tax_payer_information.rfc` (string,null, required)
    O número de identificação do contribuinte (para o México, este é o RFC).
    Example: "BEMP12345G58"

  - `tax_payer_information.curp` (string,null)
    O número  (CURP) do contribuinte.

  - `tax_payer_information.name` (string,null)
    O primeiro nome do contribuinte.
    Example: "JOHN"

  - `tax_payer_information.first_last_name` (string,null)
    O primeiro sobrenome do contribuinte.
    Example: "DOE"

  - `tax_payer_information.second_last_name` (string,null)
    O segundo sobrenome do contribuinte.
    Example: "SCHMOE"

  - `tax_payer_information.start_operations_date` (string,null, required)
    Data em que o contribuinte iniciou atividades comerciais tributáveis, no formato .

  - `tax_payer_information.status_padron` (string,null, required)
    Status do contribuinte no Registro Federal de Contribuintes (RFC). Pode ser  ou .

  - `tax_payer_information.last_status_change_date` (string,null, required)
    Data em que  foi atualizado mais recentemente, no formato .

  - `tax_payer_information.commercial_name` (string,null)
    O nome da empresa designado para consumidores e o público em geral.

: Aplicável apenas para empresas.
    Example: "Jar Jar Transport"

  - `tax_payer_information.social_name` (string,null)
    O nome único e exclusivo dentro do território nacional que as empresas recebem para fins legais ou administrativos.

: Aplicável apenas para empresas.
    Example: "John Doe SA DE CV"

  - `tax_payer_information.email` (string,null)
    Endereço de e-mail de contato do contribuinte.
    Example: "john_doe@gmail.com"

  - `tax_payer_information.phone` (string,null)
    Número de telefone de contato do contribuinte.
    Example: "1234567890"

  - `address` (object,null, required)
    Os detalhes do endereço do contribuinte.

  - `address.postal_code` (string,null, required)
    O código postal do endereço.
    Example: "21255"

  - `address.street_type` (string,null)
    O tipo .
    Example: "CALLE"

  - `address.street` (string,null)
    A rua dos contribuintes.
    Example: "LA MALINCHE"

  - `address.exterior_number` (string,null)
    O número da rua.
    Example: "432"

  - `address.interior_number` (string,null)
    Informações adicionais do endereço.
    Example: "PLANTA BAJA"

  - `address.suburb` (string,null)
    O subúrbio do contribuinte.
    Example: "BUENAVENTURA"

  - `address.locality` (string,null)
    A localidade do endereço.
    Example: "none"

  - `address.municipality` (string,null)
    O município do endereço.
    Example: "CDMX DC"

  - `address.state` (string,null)
    O estado em que o endereço está.
    Example: "Federal"

  - `address.between_street` (array,null)
    Informações adicionais sobre onde a  está localizada.

  - `address.between_street.street_one` (string,null)
    A primeira rua entre a qual  está localizada.
    Example: "CALLE PRINCIPE"

  - `address.between_street.street_two` (string,null)
    A segunda rua entre a qual  está localizada.
    Example: "CALLE NUEVA ROMA"

  - `economic_activity` (array,null, required)
    Uma lista de objetos de atividade econômica.

  - `economic_activity.economic_activity` (string,null)
    A descrição da atividade econômica.
    Example: "Asalariado"

  - `economic_activity.initial_date` (string,null)
    A data de início da atividade econômica, no formato .
    Example: "2020-12-06"

  - `economic_activity.end_date` (string,null)
    A data de término da atividade econômica, no formato .

  - `economic_activity.order` (string,null)
    A ordem da atividade econômica.
    Example: "2"

  - `economic_activity.percentage` (string,null)
    A porcentagem da atividade econômica.
    Example: "1"

  - `regimes` (array,null, required)
    Uma lista de objetos de regime.

  - `regimes.end_date` (string,null, required)
    A data de término do regime, no formato .

  - `regimes.initial_date` (string,null, required)
    A data de início do regime, no formato .
    Example: "2020-12-06"

  - `regimes.regimen` (string,null, required)
    A descrição do regime.
    Example: "Régimen de Ingresos por Dividendos (socios y accionistas)"

  - `obligations` (array,null, required)
    Detalhes sobre as obrigações de uma empresa.

ℹ️ Para contas não comerciais, este campo retornará vazio.

  - `obligations.obligation` (string,null)
    A descrição da obrigação.
    Example: "Declaración informativa de IVA con la anual de ISR"

  - `obligations.expiration` (string,null)
    O prazo para cumprir a obrigação, conforme imposto pela autoridade fiscal.
    Example: "Conjuntamente con la declaración anual del ejercicio."

  - `obligations.initial_date` (string,null)
    A data em que a obrigação começou, no formato .
    Example: "2020-12-06"

  - `obligations.end_date` (string,null)
    A data em que a obrigação terminou, no formato .

  - `digital_stamp` (string,null, required)
    O certificado de validação do documento.
    Example: "||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN\nFISCAL|2044441088666600000034||\n"

  - `digital_stamp_chain` (string,null, required)
    Uma cadeia de dados contendo a estrutura básica de um cheque fiscal digital. Para o México, este é o  (CFDI).
    Example: "EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=\n"

  - `pdf` (string,null, required)
    PDF de status fiscal como uma string binária.
    Example: "=PDF-STRING="

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único () 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 , a descrição é:

  - .
    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: ). 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 () que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

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

Para erros , a descrição é:

  -
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). 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 () 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 , a descrição é:

  - .
    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: ). 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 () 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 , a descrição é:

- .
    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: ). 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: ).
    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 , 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 () 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 , a descriçã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: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"