Skip to main content
PUT
/
users
/
me
/
update-profile
Update partner's personal information
curl --request PUT \
  --url https://external.dev.onboardpay.co/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>",
  "profile": {
    "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

User's full name

​
country
string

User's country

Example:

"NG"

​
dob
string<date>

User's date of birth

Example:

"2024-04-18T00:00:00.000Z"

​
hasBusinessBankAccount
boolean

partner has a business account

​
displayName
string

User's display name

​
proofOfAddress
string

Proof of partner's address

Response

Success

​
email
string
​
userType
enum<string>

the type of the user

Available options:
CUSTOMER,
PARTNER
​
profile
object