curl --request GET \
--url https://api.osaconnection.com/v1/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.osaconnection.com/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.osaconnection.com/v1/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://api.osaconnection.com/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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://api.osaconnection.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))
}HttpResponse<String> response = Unirest.get("https://api.osaconnection.com/v1/me")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.osaconnection.com/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"key": {
"id": "k7Hq2Lm9",
"environment": "test"
},
"firm": {
"id": "5d0c8e2a-7b41-4f9e-a3c6-1e2f3a4b5c6d",
"name": "Bayside Claims Services"
},
"scopes": [
"claims:create",
"claims:read",
"claims:write",
"adjusters:read",
"adjusters:write"
]
}{
"type": "https://docs.osaconnection.com/errors#invalid_key",
"title": "Invalid API key",
"status": 401,
"detail": "The API key is missing, malformed, revoked or expired.",
"code": "invalid_key",
"request_id": "7f3e9a1c2b4d6e8f0a1b3c5d7e9f1a2b"
}{
"type": "https://docs.osaconnection.com/errors#validation_failed",
"title": "Validation failed",
"status": 422,
"detail": "The request has 1 invalid field.",
"code": "validation_failed",
"request_id": "8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
"errors": [
{
"parameter": "limit",
"detail": "must be <= 200"
}
]
}{
"type": "https://docs.osaconnection.com/errors#rate_limited",
"title": "Rate limited",
"status": 429,
"detail": "This key has exceeded 300 requests per minute.",
"code": "rate_limited",
"request_id": "9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"
}{
"type": "https://docs.osaconnection.com/errors#internal_error",
"title": "Internal error",
"status": 500,
"detail": "Something went wrong on our side. Retry later.",
"code": "internal_error",
"request_id": "2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f"
}Check your API key
Confirms that your key works and shows the firm it belongs to, whether it is a live or test key, and the permissions it currently carries. Permissions come from your firm’s plan and the key’s purpose, so they can change without a new key. Any valid key can call this endpoint.
Unknown query parameters are rejected with 422 validation_failed.
curl --request GET \
--url https://api.osaconnection.com/v1/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.osaconnection.com/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.osaconnection.com/v1/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://api.osaconnection.com/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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://api.osaconnection.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))
}HttpResponse<String> response = Unirest.get("https://api.osaconnection.com/v1/me")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.osaconnection.com/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"key": {
"id": "k7Hq2Lm9",
"environment": "test"
},
"firm": {
"id": "5d0c8e2a-7b41-4f9e-a3c6-1e2f3a4b5c6d",
"name": "Bayside Claims Services"
},
"scopes": [
"claims:create",
"claims:read",
"claims:write",
"adjusters:read",
"adjusters:write"
]
}{
"type": "https://docs.osaconnection.com/errors#invalid_key",
"title": "Invalid API key",
"status": 401,
"detail": "The API key is missing, malformed, revoked or expired.",
"code": "invalid_key",
"request_id": "7f3e9a1c2b4d6e8f0a1b3c5d7e9f1a2b"
}{
"type": "https://docs.osaconnection.com/errors#validation_failed",
"title": "Validation failed",
"status": 422,
"detail": "The request has 1 invalid field.",
"code": "validation_failed",
"request_id": "8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a",
"errors": [
{
"parameter": "limit",
"detail": "must be <= 200"
}
]
}{
"type": "https://docs.osaconnection.com/errors#rate_limited",
"title": "Rate limited",
"status": 429,
"detail": "This key has exceeded 300 requests per minute.",
"code": "rate_limited",
"request_id": "9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"
}{
"type": "https://docs.osaconnection.com/errors#internal_error",
"title": "Internal error",
"status": 500,
"detail": "Something went wrong on our side. Retry later.",
"code": "internal_error",
"request_id": "2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f"
}Authorizations
Send your API key as a bearer token: Authorization: Bearer osa_live_….
Keys are opaque; each belongs to exactly one firm and one purpose. Keys starting with
osa_test_ reach only test claims and test accounts. The scopes listed on each
operation are the permissions the key needs; GET /v1/me shows the ones your key has.
Response
The key's firm, environment and permissions.
The calling key, its firm and its current permissions.
The API key making the request.
Show child attributes
Show child attributes
The firm this key belongs to.
Show child attributes
Show child attributes
The permissions the key has now: claims:create, claims:read, claims:write,
adjusters:read, adjusters:write. More will be added as the API grows.