Buyers

Search for a buyer by Tax_id

get/v1/buyers/search

Request

Base URL
https://api.edubank.com.br (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or API key in header authorization
TypeScript
https://skmtc.dev/edubank/apis/api-edubank/docs/v1/buyers/search/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

tax_idstring required

Buyer's tax id

Response

The record has been successfully getted

idstring

Buyer id

first_namestring required

Buyer's first name

last_namestring required

Buyer's last name

emailstring

Buyer's email

taxpayer_idstring required

Buyer's CPF/CNPJ

birthdatestring

Buyer's date of birth

phone_numberstring

Buyer's phone number

Example response

{
  "id": "39c784f7bf754698aa078a261cf42439",
  "first_name": "John",
  "last_name": "Zeisivig",
  "email": "teste@teste.com",
  "taxpayer_id": "76537741807",
  "birthdate": "1990-01-05",
  "phone_number": "21987440889",
  "address": {
    "city": "Rio de Janeiro",
    "number": "143",
    "state_code": "RJ",
    "street": "R. Marquês de Abrantes",
    "neighborhood": "Flamengo",
    "zip": "22230061",
    "country_code": "BR"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.