Listar Estabelecimentos

GET

/establishments

Esse endpoint lista todos os estabelecimentos

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/establishments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
    "status": "success",
    "response": {
        "establishments": [
            {
                "document": "77445396000105",
                "trading_name": "Nome Fantasia",
                "phone_number": "11999999999",
                "status": "PENDING",
                "type": "BUSINESS",
                "address.zipcode": "04548020",
                "name": "Nome da Empresa LTDA",
                "email": "emailcliente@inovpay.com.br",
                "address.street": "Rua De Teste",
                "birthdate": "2020-05-05",
                "gateway.kyc": "https://validacao-inovpay.com.br/?id=1761185599331x873658216347088100",
                "company_name": "Nome da Empresa LTDA",
                "revenue": 10000,
                "gateway.status": "WAITING_KYC",
                "format": "LTDA",
                "address.city": "São Paulo",
                "address.country": "BR",
                "address.complement": "Sala 123",
                "address.neighborhood": "Bairro",
                "address.number": "300",
                "responsible.email": "emailcliente@inovpay.com.br",
                "responsible.first_name": "Joao da Silva",
                "responsible.id": 243,
                "responsible.phone": "11999999999",
                "responsible.birthdate": "1990-01-01",
                "responsible.document": "77470509097",
                "establishment_id": 155515,
                "banking.kyc": "https://validacao-inovpay.com.br/?id=1761185599331x873658216347088100",
                "banking.status": "WAITING_KYC",
                "address.state": "SP",
                "cnae": "6619302",
                "_id": "1761185599331x873658216347088100"
            },
            {
                "document": "98266829000135",
                "trading_name": "Nome Fantasia",
                "phone_number": "11999999999",
                "status": "PENDING",
                "type": "BUSINESS",
                "address.zipcode": "04548020",
                "name": "Nome da Empresa LTDA",
                "email": "emailcliente@inovpay.com.br",
                "address.street": "Rua De Teste",
                "birthdate": "2020-05-05",
                "gateway.kyc": "https://validacao-inovpay.com.br/?id=1761189356161x800119277217334000",
                "company_name": "Nome da Empresa LTDA",
                "revenue": 10000,
                "gateway.status": "WAITING_KYC",
                "format": "LTDA",
                "address.city": "São Paulo",
                "address.country": "BR",
                "address.complement": "Sala 123",
                "address.neighborhood": "Bairro",
                "address.number": "300",
                "responsible.email": "emailcliente@inovpay.com.br",
                "responsible.first_name": "Joao da Silva",
                "responsible.id": 243,
                "responsible.phone": "11999999999",
                "responsible.birthdate": "1990-01-01",
                "responsible.document": "77470509097",
                "establishment_id": 155516,
                "banking.kyc": "https://validacao-inovpay.com.br/?id=1761189356161x800119277217334000",
                "banking.status": "WAITING_KYC",
                "address.state": "SP",
                "cnae": "6619302",
                "_id": "1761189356161x800119277217334000"
            },
            {
                "document": "93599915000146",
                "trading_name": "Nome Fantasia",
                "phone_number": "11999999999",
                "status": "PENDING",
                "type": "BUSINESS",
                "address.zipcode": "04548020",
                "name": "Nome da Empresa LTDA",
                "email": "emailcliente@inovpay.com.br",
                "address.street": "Rua De Teste",
                "birthdate": "2020-05-05",
                "gateway.kyc": "https://validacao-inovpay.com.br/?id=1761189701505x559103447735999040",
                "company_name": "Nome da Empresa LTDA",
                "revenue": 10000,
                "gateway.status": "WAITING_KYC",
                "format": "LTDA",
                "address.city": "São Paulo",
                "address.country": "BR",
                "address.complement": "Sala 123",
                "address.neighborhood": "Bairro",
                "address.number": "300",
                "responsible.email": "emailcliente@inovpay.com.br",
                "responsible.first_name": "Joao da Silva",
                "responsible.id": 243,
                "responsible.phone": "11999999999",
                "responsible.birthdate": "1990-01-01",
                "responsible.document": "77470509097",
                "establishment_id": 155517,
                "banking.kyc": "https://validacao-inovpay.com.br/?id=1761189701505x559103447735999040",
                "banking.status": "WAITING_KYC",
                "address.state": "SP",
                "cnae": "6619302",
                "_id": "1761189701505x559103447735999040"
            }
        ]
    }
}

Modificado em 2025-10-23 02:22:58

Página anterior

Criar Estabelecimento

Próxima página

Detalhar Estabelecimento