cURL
curl --request GET \
--url https://sandbox.onconsul.com/v1/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.onconsul.com/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.onconsul.com/v1/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import requests
url = "https://sandbox.onconsul.com/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"auth_type": "api_key",
"entity_id": "<string>",
"entity_type": "organization",
"scopes": [
"balance:read"
]
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}API Reference
Get the current caller
GET
/
me
cURL
curl --request GET \
--url https://sandbox.onconsul.com/v1/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox.onconsul.com/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.onconsul.com/v1/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import requests
url = "https://sandbox.onconsul.com/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"auth_type": "api_key",
"entity_id": "<string>",
"entity_type": "organization",
"scopes": [
"balance:read"
]
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Returns the authenticated caller’s self-view: the credential type,
the owning entity, and the scopes granted to the request. Useful as
a smoke test that your
Authorization header is wired correctly
and that the scopes attached to your API key cover the endpoints
you intend to call.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK
Available options:
api_key Available options:
organization, individual Available options:
balance:read, bank_accounts:read, bank_accounts:write, external_wallets:read, external_wallets:write, recipients:read, recipients:write, transactions:read, deposits:read, deposits:write, withdrawals:read, withdrawals:write, payouts:read, payouts:write, webhooks:read, webhooks:write 
