Accounts
Create an Account
- Documentation
- Let's Talk
- Contact Us
- 👋 Welcome to Koywe 🌳
- 👩💻 Credentials
- 👩⚖️ Compliance
- 🖥 SDK Documentation (BETA)
- 🪝 Webhooks, States, & Callbacks
- 🛠 Overview
- Basic API flow
- Testing API Limitations
- GraphQL API
RESTful API
- Overview
Accounts
Currency
Token
Payment Provider
Payout Provider
Authentication
Orders
Bank Queries
Quote Queries
Deals
Clients
Introduction
Documentation
API Documentation
Accounts
Create an Account
Create a new account.
POST
/
accounts
object
*
email
string
email
string
Add Example Value
document
object
*
document
Required
object
isCompany
boolean
*
isCompany
Required
boolean
documentNumber
string
*
documentNumber
Required
string
documentType
string
*
documentType
Required
string
country
string
*
country
Required
string
others
array
others
array
address
object
*
address
Required
object
addressCity
string
*
addressCity
Required
string
addressStreet
string
*
addressStreet
Required
string
addressZipCode
string
*
addressZipCode
Required
string
addressCountry
string
*
addressCountry
Required
string
addressState
string
*
addressState
Required
string
addressNeighborhood
string
addressNeighborhood
string
personalInfo
object
*
personalInfo
Required
object
names
string
*
names
Required
string
firstLastname
string
firstLastname
string
secondLastname
string
secondLastname
string
activity
string
*
activity
Required
string
dob
string
*
dob
Required
string
phoneNumber
string
*
phoneNumber
Required
string
nationality
string
nationality
string
gender
string
gender
string
curl --request POST \
--url https://api-test.koywe.com/rest/accounts \
--header 'Content-Type: application/json' \
--data '{
"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>"
}
}'
{
"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>"
}
}
Body
application/json
email
string
document
object
requireddocument.isCompany
boolean
requireddocument.documentNumber
string
requireddocument.documentType
string
requireddocument.country
string
requireddocument.others
object[]
document.others.documentNumber
string
requireddocument.others.documentType
string
requireddocument.others.country
string
requiredaddress
object
requiredaddress.addressCity
string
requiredaddress.addressStreet
string
requiredaddress.addressZipCode
string
requiredaddress.addressCountry
string
requiredaddress.addressState
string
requiredaddress.addressNeighborhood
string
personalInfo
object
requiredpersonalInfo.names
string
requiredpersonalInfo.firstLastname
string
personalInfo.secondLastname
string
personalInfo.activity
string
requiredpersonalInfo.dob
string
requiredpersonalInfo.phoneNumber
string
requiredpersonalInfo.nationality
string
personalInfo.gender
string
Response
201 - application/json
email
string
requireddocument
object
requireddocument.isCompany
boolean
requireddocument.documentNumber
string
requireddocument.documentType
string
requireddocument.country
string
requireddocument.others
object[]
document.others.documentNumber
string
requireddocument.others.documentType
string
requireddocument.others.country
string
requiredaddress
object
requiredaddress.addressCity
string
requiredaddress.addressStreet
string
requiredaddress.addressZipCode
string
requiredaddress.addressCountry
string
requiredaddress.addressState
string
requiredaddress.addressNeighborhood
string
personalInfo
object
requiredpersonalInfo.names
string
requiredpersonalInfo.firstLastname
string
personalInfo.secondLastname
string
personalInfo.activity
string
requiredpersonalInfo.dob
string
requiredpersonalInfo.phoneNumber
string
requiredpersonalInfo.nationality
string
personalInfo.gender
string
curl --request POST \
--url https://api-test.koywe.com/rest/accounts \
--header 'Content-Type: application/json' \
--data '{
"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>"
}
}'
{
"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>"
}
}