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>"
}
'import requests
url = "https://external.dev.onboardpay.co/users/me/update-profile"
payload = {
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"hasBusinessBankAccount": True,
"displayName": "<string>",
"proofOfAddress": "<string>"
}
headers = {
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fullname: '<string>',
country: 'NG',
dob: '2024-04-18T00:00:00.000Z',
hasBusinessBankAccount: true,
displayName: '<string>',
proofOfAddress: '<string>'
})
};
fetch('https://external.dev.onboardpay.co/users/me/update-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://external.dev.onboardpay.co/users/me/update-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'fullname' => '<string>',
'country' => 'NG',
'dob' => '2024-04-18T00:00:00.000Z',
'hasBusinessBankAccount' => true,
'displayName' => '<string>',
'proofOfAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://external.dev.onboardpay.co/users/me/update-profile"
payload := strings.NewReader("{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://external.dev.onboardpay.co/users/me/update-profile")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/users/me/update-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}User Endpoints
Update User Personal Info
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>"
}
'import requests
url = "https://external.dev.onboardpay.co/users/me/update-profile"
payload = {
"fullname": "<string>",
"country": "NG",
"dob": "2024-04-18T00:00:00.000Z",
"hasBusinessBankAccount": True,
"displayName": "<string>",
"proofOfAddress": "<string>"
}
headers = {
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fullname: '<string>',
country: 'NG',
dob: '2024-04-18T00:00:00.000Z',
hasBusinessBankAccount: true,
displayName: '<string>',
proofOfAddress: '<string>'
})
};
fetch('https://external.dev.onboardpay.co/users/me/update-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://external.dev.onboardpay.co/users/me/update-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'fullname' => '<string>',
'country' => 'NG',
'dob' => '2024-04-18T00:00:00.000Z',
'hasBusinessBankAccount' => true,
'displayName' => '<string>',
'proofOfAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://external.dev.onboardpay.co/users/me/update-profile"
payload := strings.NewReader("{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://external.dev.onboardpay.co/users/me/update-profile")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/users/me/update-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fullname\": \"<string>\",\n \"country\": \"NG\",\n \"dob\": \"2024-04-18T00:00:00.000Z\",\n \"hasBusinessBankAccount\": true,\n \"displayName\": \"<string>\",\n \"proofOfAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}{
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}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
โI