Get by ID

GET

/api/user/sellers/{id}

Este endpoint permite **consultar os dados completos ** específico, utilizando seu id como identificador.
Retorna informações como dados cadastrais, bancários e de contato.

✅ Requisitos da Requisição

Método HTTP: GET

Endpoint: /api/user/sellers/{id}

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

🔎 Parâmetros de URL

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	Identificador único do recebedor (UUID).

Request

Path Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/user/sellers/00000000000000' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0'

Response Example

200 - Success

{
  "message": "Empresa encontrada com sucesso.",
  "data": {
    "id": "XXX",
    "userId": "XXX",
    "legalName": "XXX",
    "blocked": false,
    "invoiceDescriptor": "XXX",
    "commercialName": "XXX",
    "createdAt": "2025-03-26T21:51:27.952Z",
    "uploadedDocuments": true,
    "user": {
      "id": "XXX",
      "email": "xxx@email.com",
      "phone": null,
      "name": "XXX",
      "isAdmin": false,
      "isMaster": false,
      "createdAt": "2025-02-13T18:40:19.352Z"
    },
    "document": {
      "number": "XX.XXX.XXX/XXXX-XX"
    },
    "permissions": {
      "id": "XXX",
      "companyId": "XXX",
      "isCreditCardAvailable": true,
      "isBoletoAvailable": true,
      "isPixAvailable": true,
      "transferEnabled": true,
      "transferPriceCents": 0,
      "anticipationEnabled": false,
      "anticipatableVolumePercentage": 0,
      "anticipationPricePercent": 0,
      "minAnticipatableDays": 0,
      "isCashoutAvailable": false,
      "cashoutPriceCents": 0,
      "cashoutPricePercent": 0
    },
    "details": {
      "id": "XXX",
      "averageRevenue": 500,
      "averageTicket": 50,
      "physicalProducts": true,
      "productsDescription": "XXX",
      "siteUrl": "xxx.com",
      "phone": "(00) 00000-0000",
      "email": "xxx@email.com",
      "createdAt": "2025-03-26T21:51:27.952Z"
    },
    "legalRepresentative": {
      "name": "XXX",
      "phone": "(00) 00000-0000",
      "motherName": "XXX",
      "birthdate": "1992-03-26T21:58:50.968Z",
      "createdAt": "2025-03-26T21:51:27.952Z",
      "document": {
        "number": "XXX.XXX.XXX-XX"
      }
    },
    "socialContract": "https://xxx.com/Contrato.jpg",
    "partnerDocument": "https://xxx.com/Documento.jpg",
    "address": {
      "street": "XXX",
      "streetNumber": "0",
      "complement": null,
      "zipCode": "00000-000",
      "neighborhood": "XXX",
      "city": "XXX",
      "state": "XX"
    },
    "revenue": {
      "totalAmount": 1207921.89,
      "totalCount": 1393,
      "cardAmount": 512126.53,
      "cardCount": 23,
      "pixAmount": 0,
      "pixCount": 0,
      "boletoAmount": 0,
      "boletoCount": 0,
      "chargebackAmount": 0,
      "chargebackCount": 0,
      "refundAmount": 0,
      "refundCount": 0,
      "createdAt": "2025-03-26T21:51:27.952Z"
    },
    "defaultRecipient": {
      "legalName": "XXX",
      "document": {
        "number": "XX.XXX.XXX/XXXX-XX"
      },
      "transferSettings": {
        "transferEnabled": true,
        "automaticAnticipationEnabled": false,
        "anticipatableVolumePercentage": 0
      },
      "balance": {
        "available": 10000,
        "updatedAt": "2025-03-26T21:51:28.247Z"
      }
    }
  },
  "status": 201,
  "error": null
}

Modified at 2025-07-23 19:02:40

Update documents

Update other info

Get by ID

✅ Requisitos da Requisição#

🧠 Header da requisição#

🔎 Parâmetros de URL#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

🔎 Parâmetros de URL