Accounts
Update 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
Update an Account
Update data of an existing account.
PUT
/
accounts
object
email
string
email
string
Add Example Value
document
object
document
object
others
array
others
array
address
object
address
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
object
names
string
names
string
firstLastname
string
firstLastname
string
secondLastname
string
secondLastname
string
activity
string
activity
string
dob
string
dob
string
phoneNumber
string
phoneNumber
string
nationality
string
nationality
string
gender
string
gender
string
updateEmail
string
updateEmail
string
Add Example Value
updateDocumentNumber
string
updateDocumentNumber
string
Add Example Value
updateDocumentType
string
updateDocumentType
string
Add Example Value
curl --request PUT \
--url https://api-test.koywe.com/rest/accounts \
--header 'Content-Type: application/json' \
--data '{
"email": "example@mail.com",
"document": {
"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>"
},
"updateEmail": "example@mail.com",
"updateDocumentNumber": "11111111",
"updateDocumentType": "RUT"
}'
{
"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>"
},
"resultUpdateDocumentNumber": "Document number is pending validation"
}
Updating Email or Document:
If an updated email is present, the API validates whether it is a valid email and ensures that another account with that email does not already exist.
If an updated document number or type is present, the API validates that it has a valid format, does not exist on another account, has no executed orders, and initiates an asynchronous validation for mismatching personal data.
The results of the asynchronous validation will be sent to the configured callback. You can find more information in the webhooks section.
Body
application/json
email
string
document
object
document.others
object[]
document.others.documentNumber
string
requireddocument.others.documentType
string
requireddocument.others.country
string
requiredaddress
object
address.addressCity
string
requiredaddress.addressStreet
string
requiredaddress.addressZipCode
string
requiredaddress.addressCountry
string
requiredaddress.addressState
string
requiredaddress.addressNeighborhood
string
personalInfo
object
personalInfo.names
string
personalInfo.firstLastname
string
personalInfo.secondLastname
string
personalInfo.activity
string
personalInfo.dob
string
personalInfo.phoneNumber
string
personalInfo.nationality
string
personalInfo.gender
string
updateEmail
string
updateDocumentNumber
string
updateDocumentType
string
Response
200 - 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
resultUpdateDocumentNumber
string
curl --request PUT \
--url https://api-test.koywe.com/rest/accounts \
--header 'Content-Type: application/json' \
--data '{
"email": "example@mail.com",
"document": {
"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>"
},
"updateEmail": "example@mail.com",
"updateDocumentNumber": "11111111",
"updateDocumentType": "RUT"
}'
{
"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>"
},
"resultUpdateDocumentNumber": "Document number is pending validation"
}