User Endpoints
Update User Personal Info
Onboard Connect APIs
- Introduction
- Authentication
- User Endpoints
- User Creation via API
- GETGet User by Auth Token
- PUTUpdate User Personal Info
- GETGenerate OTP for 2FA actions
- Trading Endpoints
- Business Profile Endpoints
User Endpoints
Update User Personal Info
PUT
/
users
/
me
/
update-profile
curl --request PUT \
--url https://onboard-external-dev.api.nestcoin.io/users/me/update-profile \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--data '{
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"hasBusinessBankAccount": true,
"displayName": "<string>",
"proofOfAddress": "<string>"
}'
{
"email": "<string>",
"userType": "CUSTOMER",
"profile": {
"status": "VERIFIED",
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"displayName": "<string>",
"proofOfAddress": "<string>",
"hasBusinessBankAccount": true,
"businessName": "<string>",
"certificateOfIncorporation": "<string>",
"hasShareHolderList": true,
"userInShareHolderList": true,
"noShareHolderListEvidence": "<string>",
"useOfBusinessAccountApprovedByShareholders": true,
"noOfLegalDirectors": 123,
"regulatoryIdsOfDirectors": [
"<string>"
],
"depositTimeout": 1200,
"approvalTimeout": 1200,
"tradeHistoryDetails": {
"hasPreviousTradeHistory": true,
"proofOfTrade": [
"<string>"
],
"referee": "<string>"
}
}
}
Enables the update of basic user details, including name, date of birth, and country information. Note that user profile information is distinct from a userโs KYC details, and is available for both KYCโd and non-KYCโd users.
Authorizations
Body
application/json
Response
200
application/json
Success
The response is of type object
.
curl --request PUT \
--url https://onboard-external-dev.api.nestcoin.io/users/me/update-profile \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--data '{
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"hasBusinessBankAccount": true,
"displayName": "<string>",
"proofOfAddress": "<string>"
}'
{
"email": "<string>",
"userType": "CUSTOMER",
"profile": {
"status": "VERIFIED",
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"displayName": "<string>",
"proofOfAddress": "<string>",
"hasBusinessBankAccount": true,
"businessName": "<string>",
"certificateOfIncorporation": "<string>",
"hasShareHolderList": true,
"userInShareHolderList": true,
"noShareHolderListEvidence": "<string>",
"useOfBusinessAccountApprovedByShareholders": true,
"noOfLegalDirectors": 123,
"regulatoryIdsOfDirectors": [
"<string>"
],
"depositTimeout": 1200,
"approvalTimeout": 1200,
"tradeHistoryDetails": {
"hasPreviousTradeHistory": true,
"proofOfTrade": [
"<string>"
],
"referee": "<string>"
}
}
}