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 '{
  "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>"
  }
}'
{
  "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

​
x-auth-token
string
header
required

Body

application/json
​
fullname
string
required

User's full name

​
status
enum<string>

user's verification status

Available options:
VERIFIED,
UNVERIFIED,
FAILED_VERIFICATION,
REVIEW_REQUIRED,
IN_PROGRESS,
REJECTED
​
country
string

User's country

​
dob
string

User's date of birth

​
displayName
string

User's display name

​
proofOfAddress
string

Proof of partner's address

​
hasBusinessBankAccount
boolean

partner has a business account

​
businessName
string
​
certificateOfIncorporation
string
​
hasShareHolderList
boolean
​
userInShareHolderList
boolean
​
noShareHolderListEvidence
string
​
useOfBusinessAccountApprovedByShareholders
boolean
​
noOfLegalDirectors
number
​
regulatoryIdsOfDirectors
string[]
​
depositTimeout
number
​
approvalTimeout
number
​
tradeHistoryDetails
object

Response

200
application/json
Success
​
email
string
​
userType
enum<string>

the type of the user

Available options:
CUSTOMER,
PARTNER
​
profile
object
Get User by Auth TokenGet Business Profile