Accounts
Retrieve Account
Introduction
About Koywe
- 🌳 What is Koywe
- ✨ Use Cases
Documentation
API Documentation
- 🛠 Overview
- Basic API flow
- Testing API Limitations
- GraphQL API
- RESTful API
- Overview
- Authentication
- Accounts
- Currency
- Token
- Payment Provider
- Payout Provider
- Quotes
- Orders
- Banks
- Deals
- Clients
Accounts
Retrieve Account
Returns the registered information of the user.
GET
/
accounts
/
{email}
curl --request GET \
--url https://api-sandbox.koywe.com/rest/accounts/{email} \
--header 'Authorization: Bearer <token>'
{
"email": "example@mail.com",
"document": {
"isCompany": true,
"documentNumber": "<string>",
"documentType": "<string>",
"country": "<string>",
"others": [
{
"documentNumber": "<string>",
"documentType": "<string>",
"country": "<string>"
}
]
},
"address": {
"addressCity": "<string>",
"addressStreet": "<string>",
"addressZipCode": "<string>",
"addressCountry": "<string>",
"addressState": "<string>",
"addressNeighborhood": "<string>"
},
"personalInfo": {
"names": "<string>",
"firstLastname": "<string>",
"secondLastname": "<string>",
"activity": "<string>",
"dob": "<string>",
"phoneNumber": "<string>",
"nationality": "<string>",
"gender": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Email associated with the currency of choice.
Response
200
application/json
successful operation
Example:
"example@mail.com"
curl --request GET \
--url https://api-sandbox.koywe.com/rest/accounts/{email} \
--header 'Authorization: Bearer <token>'
{
"email": "example@mail.com",
"document": {
"isCompany": true,
"documentNumber": "<string>",
"documentType": "<string>",
"country": "<string>",
"others": [
{
"documentNumber": "<string>",
"documentType": "<string>",
"country": "<string>"
}
]
},
"address": {
"addressCity": "<string>",
"addressStreet": "<string>",
"addressZipCode": "<string>",
"addressCountry": "<string>",
"addressState": "<string>",
"addressNeighborhood": "<string>"
},
"personalInfo": {
"names": "<string>",
"firstLastname": "<string>",
"secondLastname": "<string>",
"activity": "<string>",
"dob": "<string>",
"phoneNumber": "<string>",
"nationality": "<string>",
"gender": "<string>"
}
}