---
title: "Consultar status de um fornecedor"
method: GET
path: "/companies/{payerTaxId}/payees/{payeeTaxId}"
tags: ["Company"]
---

# Consultar status de um fornecedor

`GET /companies/{payerTaxId}/payees/{payeeTaxId}`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/companies/{payerTaxId}/payees/{payeeTaxId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/scf/companies`, `empresas.btgpactual.com/scf/companies.readonly`

Consulta dos status de onboardings do fornecedor identificado por 'payeeTaxId'.

## Path parameters

- `payerTaxId` string, required: CNPJ/CPF
- `payeeTaxId` string, required: CNPJ/CPF

## Response `200`

Sucesso

- CompanyOnboardingsDto
  - `taxId` string: Documento do fornecedor
  - `status` string: Status do fornecedor

## Other responses

- `401`: Não autorizado
- `404`: Empresa com esse 'payeeTaxId' não encontrada.
- `default`: Erro

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
