Get a single user by their authorization token
curl --request GET \
--url https://external.dev.onboardpay.co/users/me \
--header 'x-auth-token: <api-key>'import requests
url = "https://external.dev.onboardpay.co/users/me"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://external.dev.onboardpay.co/users/me', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://external.dev.onboardpay.co/users/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://external.dev.onboardpay.co/users/me")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/users/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"userId": "<string>",
"email": "<string>",
"name": "<string>",
"phoneNumber": "2348100000000",
"phoneNumberVerified": true,
"fullName": "<string>",
"referralLink": "<string>",
"referralCode": "<string>",
"userType": "CUSTOMER",
"roles": [
"CUSTOMER"
],
"isCustomer": true,
"isMerchant": true,
"isOnboardWalletUser": true,
"isOpnMerchant": true,
"isMerchantNetwork": true,
"kycStatus": "VERIFIED",
"kycRetryCount": 123,
"kycRetryLimit": 123,
"kycNameHistory": [
{
"reason": "<string>",
"actor": "<string>",
"previousName": "<string>",
"currentName": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"evidenceUrl": "<string>"
}
],
"comments": [
{
"comment": "<string>",
"addedBy": "<string>"
}
],
"includes": {},
"supportedCurrencies": [
"<string>"
],
"language": "en, en-US, fr-FR, pt-BR",
"availability": true,
"active": true,
"country": "<string>",
"verifiedAddress": "0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b",
"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>"
}
},
"transactionLimit": {
"dailyTransactionLimit": 123,
"maxSingleTransactionLimit": 123,
"minSingleTransactionLimit": 123,
"maxLifetimeLimit": 123
},
"authSource": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"isTotpSetup": true,
"totpSetupAt": "2023-11-07T05:31:56Z",
"verifiedPhoneNumberLastUpdatedAt": "2023-11-07T05:31:56Z"
}{
"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
Get User by Auth Token
GET
/
users
/
me
Get a single user by their authorization token
curl --request GET \
--url https://external.dev.onboardpay.co/users/me \
--header 'x-auth-token: <api-key>'import requests
url = "https://external.dev.onboardpay.co/users/me"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://external.dev.onboardpay.co/users/me', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://external.dev.onboardpay.co/users/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://external.dev.onboardpay.co/users/me")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/users/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"userId": "<string>",
"email": "<string>",
"name": "<string>",
"phoneNumber": "2348100000000",
"phoneNumberVerified": true,
"fullName": "<string>",
"referralLink": "<string>",
"referralCode": "<string>",
"userType": "CUSTOMER",
"roles": [
"CUSTOMER"
],
"isCustomer": true,
"isMerchant": true,
"isOnboardWalletUser": true,
"isOpnMerchant": true,
"isMerchantNetwork": true,
"kycStatus": "VERIFIED",
"kycRetryCount": 123,
"kycRetryLimit": 123,
"kycNameHistory": [
{
"reason": "<string>",
"actor": "<string>",
"previousName": "<string>",
"currentName": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"evidenceUrl": "<string>"
}
],
"comments": [
{
"comment": "<string>",
"addedBy": "<string>"
}
],
"includes": {},
"supportedCurrencies": [
"<string>"
],
"language": "en, en-US, fr-FR, pt-BR",
"availability": true,
"active": true,
"country": "<string>",
"verifiedAddress": "0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b",
"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>"
}
},
"transactionLimit": {
"dailyTransactionLimit": 123,
"maxSingleTransactionLimit": 123,
"minSingleTransactionLimit": 123,
"maxLifetimeLimit": 123
},
"authSource": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"isTotpSetup": true,
"totpSetupAt": "2023-11-07T05:31:56Z",
"verifiedPhoneNumberLastUpdatedAt": "2023-11-07T05:31:56Z"
}{
"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": {}
}Fetches the profile of the currently authenticated user, including their account details and KYC status.
Authorizations
Response
Success
the user ID
User's email
Name of customer
User phone number
Example:
"2348100000000"
flag indicating if user has verified their phone number
user's kyc fullname
referral link
referral code generated for this user. Also known as onboard pass
the type of the user
Available options:
CUSTOMER, PARTNER the roles a user can possess on Onboard
Available options:
CUSTOMER, MERCHANT, MERCHANT_NETWORK flag indicating if user is an Onboard wallet user or not. i.e user has made use of/sign in using Onboard wallet before.
Indicates if the merchant has been provisioned for OPN
Available options:
VERIFIED, UNVERIFIED, IN_PROGRESS, AWAITING_INPUT, FAILED_VERIFICATION, REVIEW_REQUIRED, VERIFICATION_TIMEOUT The number of kyc retries
kyc retry limit
History of name change
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Language preference (preferred or detected). Can be just language (en) or locale (en-GB). See samples
Example:
"en, en-US, fr-FR, pt-BR"
Wallet Address connected to user's account.
Example:
"0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
specifies the user's wallet source
Timestamp field.
Timestamp field.
Timestamp field.
Timestamp field.