Get membership status
curl --request POST \
--url https://partner-api.tryrima.com/v1/get-membership-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_system": "hhaexchange",
"external_id": "33333333-3333-4333-8333-333333333333"
}
'import requests
url = "https://partner-api.tryrima.com/v1/get-membership-status"
payload = {
"external_system": "hhaexchange",
"external_id": "33333333-3333-4333-8333-333333333333"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_system: 'hhaexchange',
external_id: '33333333-3333-4333-8333-333333333333'
})
};
fetch('https://partner-api.tryrima.com/v1/get-membership-status', 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://partner-api.tryrima.com/v1/get-membership-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_system' => 'hhaexchange',
'external_id' => '33333333-3333-4333-8333-333333333333'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://partner-api.tryrima.com/v1/get-membership-status"
payload := strings.NewReader("{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://partner-api.tryrima.com/v1/get-membership-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://partner-api.tryrima.com/v1/get-membership-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}"
response = http.request(request)
puts response.read_body{
"enrolled": true,
"registered": false,
"opted_out": false
}{
"error": "invalid_request"
}{
"error": "invalid_api_key"
}{
"error": "forbidden"
}{
"error": "ambiguous_identifier"
}{
"error": "payload_too_large"
}{
"error": "rate_limited"
}{
"error": "internal_error"
}Get membership status
For looking up app access by external ID.
POST
/
v1
/
get-membership-status
Get membership status
curl --request POST \
--url https://partner-api.tryrima.com/v1/get-membership-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_system": "hhaexchange",
"external_id": "33333333-3333-4333-8333-333333333333"
}
'import requests
url = "https://partner-api.tryrima.com/v1/get-membership-status"
payload = {
"external_system": "hhaexchange",
"external_id": "33333333-3333-4333-8333-333333333333"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_system: 'hhaexchange',
external_id: '33333333-3333-4333-8333-333333333333'
})
};
fetch('https://partner-api.tryrima.com/v1/get-membership-status', 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://partner-api.tryrima.com/v1/get-membership-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external_system' => 'hhaexchange',
'external_id' => '33333333-3333-4333-8333-333333333333'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://partner-api.tryrima.com/v1/get-membership-status"
payload := strings.NewReader("{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://partner-api.tryrima.com/v1/get-membership-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://partner-api.tryrima.com/v1/get-membership-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_system\": \"hhaexchange\",\n \"external_id\": \"33333333-3333-4333-8333-333333333333\"\n}"
response = http.request(request)
puts response.read_body{
"enrolled": true,
"registered": false,
"opted_out": false
}{
"error": "invalid_request"
}{
"error": "invalid_api_key"
}{
"error": "forbidden"
}{
"error": "ambiguous_identifier"
}{
"error": "payload_too_large"
}{
"error": "rate_limited"
}{
"error": "internal_error"
}The lookup accepts only
hhaexchange as external_system and requires a nonempty external_id. It accepts no other request properties and has no company or organization parameter. Invalid input returns 400 invalid_request; a body over 16 KiB returns 413 payload_too_large.
The response contains exactly three booleans, without an envelope or identifiers. enrolled requires effective Rima coverage plus a linked company membership or a pending, unexpired invitation for the covered employee. opted_out is true only when every applicable participation is effectively opted out.
No authorized identity match returns all three values as false. Multiple authorized matches return 409 ambiguous_identifier unless they share one non-null Person ID, including when linked and unlinked records match. Service failures return 500 internal_error rather than false booleans.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
JSON request body. Bodies over 16 KiB return 413 payload_too_large.
Response
App access result.
True when an employee has effective Rima coverage and either a linked company membership or a pending, unexpired invitation for that covered employee.
Existing app account, independent of enrollment.
True when every applicable participation is effectively opted out; false when none exists.