Skip to main content
API docs by Redocly

identity API definition (1.0.0)

identity API definition

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "aggregation-requests"
required
object
required
Array of objects
Array
column
required
string <= 64 characters
individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/anonymous-accesses

/v1/anonymous-accesses/

Request Body schema: application/json
required
object
type
required
string
Value: "anonymous-accesses"
required
object
required
Array of objects non-empty
Array (non-empty)
path
required
string <= 255 characters
service
required
string <= 32 characters
method
string
Enum: "delete" "get" "patch" "post"
expired-at
required
string <datetime>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/anonymous-accesses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/anonymous-accesses/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "anonymous-accesses"
required
object
Array of objects non-empty
Array (non-empty)
path
required
string <= 255 characters
service
required
string <= 32 characters
method
string
Enum: "delete" "get" "patch" "post"
expired-at
string <datetime>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/anonymous-accesses/{id}/proxy/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
endpoint
required
string <= 255 characters
method
required
string
Enum: "delete" "get" "patch" "post"
json
object
params
object

Responses

Request samples

Content type
application/json
{
  • "endpoint": "string",
  • "json": { },
  • "method": "delete",
  • "params": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "json": { },
  • "status-code": 0
}

/v1/archive-requests

/v1/archive-requests/

query Parameters
filter[individual-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/archive-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "archive-requests"
required
object
individual-id
required
string <uuid>
password
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/archive-requests/{id}/answer/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
value
required
string <= 255 characters
individual-id
string <uuid>
interview-id
string <uuid>
question-id
string <uuid>
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "interview-id": "fdf25c2b-9dab-4bde-a8bc-93b36cba4f12",
  • "question-id": "9cee3ee1-310e-4b38-8ac2-6c264c88e6fc",
  • "value": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/auth-lookup

/v1/auth-lookup/

query Parameters
email
string <= 255 characters
Deprecated

Deprecated: use username instead

next
string <= 255 characters
username
string <= 255 characters

REQUIRED: The username (email address or E164 phone number) of the user

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/authenticate

/v1/authenticate/

Request Body schema: application/json
edge-request
boolean

Is the originating request an edge request?

Responses

Request samples

Content type
application/json
{
  • "edge-request": true
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/authz-get-accessible-resources

/v1/authz-get-accessible-resources/

Request Body schema: application/json
access-query
required
Array of strings (Authz3AccessQuery) non-empty [ items <= 256 characters ]

Multiple access queries are ANDed together for the authz3 check result. Authz3 Queries are colon-joined 3-tuples in the form of 'type:id:operation'. Example: individual:c5e7d664-bec7-4534-a22c-0ebccfb173b1:read type: Type of the entity for the ACL to check against. Acceptable values: group, individual, organization, system, or app.* (application-specific) id: Entity ID. Must be either empty opr a valid UUID, unless type is either system or app.*, in which case id may be any freetext not including the colon character. operation: Operation to be performed against the Entity. Acceptable values: read, write. For group types, operation may also be 'contain'.

user-id
required
string <uuid>
organization-id
string <uuid>
page[limit]
integer [ 0 .. 100000 ]
Default: 5000
page[offset]
integer >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "access-query": [
    ],
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "page[limit]": 5000,
  • "page[offset]": 0,
  • "user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "resource-ids": [
    ]
}

/v1/authz-individuals

/v1/authz-individuals/

query Parameters
operation
required
string
Enum: "read" "write"
user-id
required
string <uuid>
filter[account-type]
string <= 10 characters
filter[birth-date]
string <date>
filter[email-verified]
boolean
filter[email]
string <= 255 characters
filter[exclude-owner-ids]
Array of strings <uuid> non-empty [ items <uuid > ]
filter[first-name]
string <= 255 characters
filter[group-id]
string <uuid>
filter[group-members-with-leader-id]
string <uuid>
filter[last-name]
string <= 255 characters
filter[organization-id]
string <uuid>
filter[phone-verified]
boolean
filter[phone]
string <= 255 characters
filter[registered]
boolean
page[limit]
integer [ 0 .. 100000 ]
Default: 5000
page[offset]
integer >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "resource-ids": [
    ]
}

/v1/authz-resource-access

/v1/authz-resource-access/

Request Body schema: application/json
access-query
required
Array of strings (Authz3AccessQuery) non-empty [ items <= 256 characters ]

Multiple access queries are ANDed together for the authz3 check result. Authz3 Queries are colon-joined 3-tuples in the form of 'type:id:operation'. Example: individual:c5e7d664-bec7-4534-a22c-0ebccfb173b1:read type: Type of the entity for the ACL to check against. Acceptable values: group, individual, organization, system, or app.* (application-specific) id: Entity ID. Must be either empty opr a valid UUID, unless type is either system or app.*, in which case id may be any freetext not including the colon character. operation: Operation to be performed against the Entity. Acceptable values: read, write. For group types, operation may also be 'contain'.

user-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "access-query": [
    ],
  • "user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
}

Response samples

Content type
application/vnd.api+json
{
  • "allow": true
}

/v1/authz-resource-accessors

/v1/authz-resource-accessors/

query Parameters
operation
required
string
Enum: "read" "write"
resource-id
required
Array of strings <uuid> [ 1 .. 50 ] items [ items <uuid > ]
resource-type
required
string
Enum: "individual" "organization"
organization-id
string <uuid>

Returns users of this organization only

page[limit]
integer [ 0 .. 100000 ]
Default: 5000
page[offset]
integer >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/authz-user-status

/v1/authz-user-status/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/bulk-authz-resource-access

/v1/bulk-authz-resource-access/

Request Body schema: application/json
required
object
access-query
required
Array of strings (Authz3AccessQuery) non-empty [ items <= 256 characters ]

Multiple access queries are ANDed together for the authz3 check result. Authz3 Queries are colon-joined 3-tuples in the form of 'type:id:operation'. Example: individual:c5e7d664-bec7-4534-a22c-0ebccfb173b1:read type: Type of the entity for the ACL to check against. Acceptable values: group, individual, organization, system, or app.* (application-specific) id: Entity ID. Must be either empty opr a valid UUID, unless type is either system or app.*, in which case id may be any freetext not including the colon character. operation: Operation to be performed against the Entity. Acceptable values: read, write. For group types, operation may also be 'contain'.

user-ids
required
Array of strings <uuid> [ 1 .. 5000 ] items [ items <uuid > ]
individually
boolean
Default: false

If true, the user-ids will be checked individually for each access-query

Responses

Request samples

Content type
application/json
{
  • "multi-user-ids": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "access-queries": [
    ]
}

/v1/confirm-forgot-password

/v1/confirm-forgot-password/

Request Body schema: application/json
confirmation-code
required
string <= 20 characters
password
required
string <= 255 characters
username
required
string <= 255 characters
login
boolean
Default: false
source
string
Enum: "email" "sms"

Responses

Request samples

Content type
application/json
{
  • "confirmation-code": "string",
  • "login": false,
  • "password": "string",
  • "source": "email",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "login-error": {
    }
}

/v1/confirm-sign-up

/v1/confirm-sign-up/

Request Body schema: application/json
confirmation-code
required
string <= 20 characters
username
required
string <= 255 characters
login
boolean
Default: false
service-document-agreements
Array of strings <uuid> [ items <uuid > ]

List of service document IDs being agreed to

tz
string <timezone>

Responses

Request samples

Content type
application/json
{
  • "confirmation-code": "string",
  • "login": false,
  • "service-document-agreements": [
    ],
  • "tz": "string",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "account-type": "provider",
  • "login-error": {
    }
}

/v1/delete-sessions

/v1/delete-sessions/

Request Body schema: application/json
One of
user-email
required
string

Responses

Request samples

Content type
application/json
{
  • "user-id": "985e0971-72b1-44a2-96f2-064a853c99ad"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/deletion-requests

/v1/deletion-requests/

query Parameters
user-email
required
string <email>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/deletion-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "deletion-requests"
required
object or object or object or object
One of
archive
boolean
password
string
type
string
Deprecated
Enum: "indv" "user"
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/deletion-requests/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Update the status of a deletion job

Update the status of a deletion job

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reference-id
required
string <uuid>
state
required
any
Value: "done"
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "reference-id": "bb8be946-a40d-4307-861c-b2374738cff6",
  • "state": "done"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/email-logs

/v1/email-logs/

query Parameters
filter[destination]
string [ 1 .. 255 ] characters
filter[timestamp][gte]
string <datetime>
filter[timestamp][lte]
string <datetime>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/features

/v1/features/

query Parameters
filter[assignable]
boolean
filter[individual-id]
string <uuid>
filter[organization-id]
string <uuid>
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/features/

Request Body schema: application/json
required
object
type
required
string
Value: "features"
required
object
description
required
string <= 255 characters
id
required
string [ 3 .. 20 ] characters ^[a-z0-9-_]+$
assignable
boolean
Default: false
global-enabled
boolean
Default: false
stage
string
Default: "alpha"
Enum: "alpha" "beta" "released"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/features/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "features"
required
object
assignable
boolean
description
string <= 255 characters
global-enabled
boolean
stage
string
Enum: "alpha" "beta" "released"
id
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/features/{id}/add-users/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
force
boolean
Default: false
state
string
Default: "enabled"
Enum: "disabled" "dontcare" "enabled"

Responses

Request samples

Content type
application/json
{
  • "force": false,
  • "state": "disabled",
  • "user-emails": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/features/{id}/remove-users/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "user-emails": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/feedback-comments

/v1/feedback-comments/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/feedback-comments/

Request Body schema: application/json
required
object
type
required
string
Value: "feedback-comments"
required
object
comment
required
string <= 9999 characters
current-page
required
string <= 9999 characters
individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/feedback-comments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/forgot-password

/v1/forgot-password/

Request Body schema: application/json
username
required
string <= 255 characters
locale
string <= 8 characters

Responses

Request samples

Content type
application/json
{
  • "locale": "string",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/healthmap-companies

/v1/healthmap-companies/

query Parameters
organization-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/healthmap-companies/

Request Body schema: application/json
required
object
type
required
string
Value: "healthmap-companies"
required
object
company-id
required
string <= 255 characters

HMS DLH company identifier.

name
required
string <= 255 characters

Unique company name sourced from HMS practice_company.

organization-id
required
string <uuid>

Organization to link to this healthmap company.

p4p-eligible
boolean

Whether the company participates in P4P.

p4p-required-version
integer

Current P4P terms version required for the company.

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/healthmap-companies/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/healthmap-companies/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/healthmap-companies/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "healthmap-companies"
required
object
company-id
string <= 255 characters

HMS DLH company identifier.

name
string <= 255 characters

Unique company name sourced from HMS practice_company.

organization-id
string <uuid>

Reassign this healthmap company to a different organization.

p4p-eligible
boolean

Whether the company participates in P4P.

p4p-required-version
integer

Current P4P terms version required for the company.

id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/impersonation-requests

/v1/impersonation-requests/

query Parameters
filter[created-by]
string <uuid>
filter[user-email]
string <= 255 characters
filter[user-id]
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/impersonation-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "impersonation-requests"
required
object
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/impersonation-requests/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/impersonation-requests/{id}/impersonate/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
access-token-expiration-seconds
integer [ 0 .. 3600 ]
Default: 3600
refresh-token-expiration-seconds
integer [ 0 .. 10800 ]
Default: 10800

Responses

Request samples

Content type
application/json
{
  • "access-token-expiration-seconds": 3600,
  • "refresh-token-expiration-seconds": 10800
}

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string",
  • "email": "string",
  • "first-name": "string",
  • "id-token": "string",
  • "impersonated-by": {
    },
  • "individual": {
    },
  • "last-name": "string",
  • "locale": "en_US",
  • "locale-explicit": true,
  • "multi-organization": true,
  • "organizations": [
    ],
  • "refresh-token": "string",
  • "session-id": "string",
  • "tz": "string",
  • "tz-explicit": true,
  • "user-id": "string",
  • "username": "string"
}

/v1/individual-group-individuals

/v1/individual-group-individuals/

query Parameters
individual-group-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/individual-group-leaders

/v1/individual-group-leaders/

query Parameters
individual-group-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/individual-group-logs

/v1/individual-group-logs/

query Parameters
filter[individual-id]
string <uuid>
individual-group-id
string <uuid>
individual-id
string <uuid>
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/individual-group-tags

/v1/individual-group-tags/

query Parameters
organization-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/individual-group-tags/

Request Body schema: application/json
required
object
type
required
string
Value: "individual-group-tags"
required
object
name
required
string <= 127 characters
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-group-tags/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/individual-group-tags/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups

/v1/individual-groups/ Deprecated

query Parameters
exclude[individual-id]
string <uuid>
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[eligible-individual-id]
string <uuid>
filter[exclude-ids]
Array of strings <uuid> [ items <uuid > ]
filter[include-inactive]
boolean
Default: false
filter[individual-id]
string <uuid>
filter[leader-id]
string <uuid>
filter[node-type]
string
Enum: "division" "group"
filter[parent-group-id]
string <uuid>
filter[tags]
Array of strings[ items <= 127 characters ]
filter[text]
string <= 255 characters
filter[tree-node-type]
string
Enum: "leaf" "non-leaf"
ids
Array of strings <uuid> [ items <uuid > ]
name
string <= 255 characters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
type
Array of strings
Default: "regular&type=provider_only"
Items Enum: "all_participants" "provider_only" "regular" "unassigned"
with-individuals
boolean
Deprecated
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/individual-groups/

Request Body schema: application/json
required
object
type
required
string
Value: "individual-groups"
required
object or object
One of
name
required
string
organization-id
required
string <uuid>
individual-ids
Array of strings <uuid> [ items <uuid > ]
leader-ids
Array of strings <uuid> [ items <uuid > ]
node-type
string
Default: "group"
Enum: "division" "group"
tags
Array of strings[ items <= 127 characters ]
type
string
Default: "regular"
Enum: "provider_only" "regular"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "individual-groups"
required
object
leader-ids
Array of strings <uuid> [ items <uuid > ]
name
string <= 255 characters
tags
Array of strings[ items <= 127 characters ]
id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/add-individuals/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "remove-from-group": "b6e60b8a-a564-4615-9438-0aa9e2c657a7",
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/add-leaders/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove-from-group": "b6e60b8a-a564-4615-9438-0aa9e2c657a7",
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/add-members/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove-from-group": "b6e60b8a-a564-4615-9438-0aa9e2c657a7",
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/eligible-members/

path Parameters
id
required
string

Resource identifier

query Parameters
filter[registration-invite]
string
Enum: "accepted" "failed" "none" "sent"
filter[text]
string <= 255 characters
filter[verified]
boolean
for-children
boolean
member-type
string
Default: "leader"
Enum: "individual" "leader" "member"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/individual-groups/{id}/move-group/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
to-parent-group-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "to-parent-group-id": "8383c3af-2796-49c1-92f2-d01fced78807"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/individual-groups/{id}/remove-individuals/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/remove-leaders/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups/{id}/remove-members/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals

/v1/individuals/

Request Body schema: application/json
required
object
type
required
string
Value: "individuals"
required
object
individual-id
required
string <uuid>
owner-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/individuals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/login

/v1/login/

Request Body schema: application/json
Any of
password
required
string
username
required
string
access-token-expiration-seconds
integer [ 1 .. 3600 ]

Access token lifetime in seconds. Do not specify for longest allowable duration.

interactive
boolean
Default: true

Is this login due to immediate user presence

locale
string
mfa-ticket
string <= 512 characters

Encrypted proof token returned by the email MFA challenge respond endpoint

refresh-token-expiration-seconds
integer >= 1

Refresh token lifetime in seconds. Do not specify for longest allowable duration.

service-document-agreements
Array of strings <uuid> [ items <uuid > ]

List of service document IDs being agreed to during this login. These may be required to log in.

simulated-queue-delay
integer >= 1

(Developer feature) Simulate background job delay by number of milliseconds

sticky-access-token-expiration
boolean
totp-code
string

TOTP Code for Two Factor Authentication

Responses

Request samples

Content type
application/json
Example
{
  • "access-token-expiration-seconds": 1,
  • "interactive": true,
  • "locale": "string",
  • "mfa-ticket": "string",
  • "password": "string",
  • "refresh-token-expiration-seconds": 1,
  • "service-document-agreements": [
    ],
  • "simulated-queue-delay": 1,
  • "sticky-access-token-expiration": true,
  • "totp-code": "string",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "redirect-url": "string"
}

/v1/logout

/v1/logout/

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/mfa-email

Get a list of all email MFA configurations for a u

Get a list of all email MFA configurations for a user.

query Parameters
filter[user-id]
string <uuid>

The ID of the User to get configurations for. Defaults to the current user. The caller may only request their own configurations unless the caller is an administrator.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Begin enrollment of an email address for MFA. The

Begin enrollment of an email address for MFA. The configuration is created disabled and a verification code is emailed to the address. Re-posting the same address re-sends a code.

Request Body schema: application/json
email
required
string <= 255 characters

The email address to enroll

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Delete a specific email MFA configuration

You may only delete configurations that you own and that are not enabled. You must disable the configuration before deleting it.

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Disable (deactivate) an email MFA configuration wi

Disable (deactivate) an email MFA configuration without deleting it. This removes email as an MFA option during sign-in.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
password
required
string <= 255 characters

The current user's password

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Enable (activate) an email MFA configuration by su

Enable (activate) an email MFA configuration by supplying the emailed verification code and the current user's password. Once enabled, future sign-ins will offer email as an MFA option.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
code
required
string <= 6 characters

The verification code delivered by email

password
required
string <= 255 characters

The current user's password

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/mfa-email-challenges

Begin an email MFA challenge: validate the login M

Begin an email MFA challenge: validate the login MFA ticket, email a code to the address encoded in the ticket, and return the challenge.

Request Body schema: application/json
mfa-email-challenge-token
required
string <= 512 characters

The MFA ticket returned in the MfaRequired login response

Responses

Request samples

Content type
application/json
{
  • "mfa-email-challenge-token": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Respond to an email MFA challenge with the emailed

Respond to an email MFA challenge with the emailed code. Returns the challenge with an approval token to supply to the login API.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
code
required
string <= 6 characters

The code delivered by email

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/mfa-totp

Get a list of all TotpConfigurations for a user.

Get a list of all TotpConfigurations for a user.

query Parameters
filter[user-id]
string <uuid>

The ID of the User to get TotpConfiguration for. Defaults to the current user. The caller may only request their own configurations unless the caller is an administrator.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Initiate setup of TOTP MFA for the users account.

Initiate setup of TOTP MFA for the users account. After initialization, the configuration will still need to be enabled.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Delete a specific TotpConfiguration

You can only delete configurations that are both owned by you and not that are enabled. You must disable the configuration before deleting it.

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Disable (deactivates) a TotpConfiguration without

Disable (deactivates) a TotpConfiguration without deleting it. This will remove the requirement for a totp code to be entered during sign-in.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
password
required
string <= 255 characters

The current users password

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Enable (activate) a TotpConfiguration. This requir

Enable (activate) a TotpConfiguration. This requires providing two consecutive totp codes and the users password. Once enabled, future sign-ins will require a totp code as MFA in addition to the password.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
codes
required
Array of strings = 2 items [ items <= 255 characters ]

A list of valid TOTP Codes. We require two consecutive codes.

password
required
string <= 255 characters

The current users password

Responses

Request samples

Content type
application/json
{
  • "codes": [
    ],
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-client-settings

/v1/oauth2-client-settings/

query Parameters
organization-id
required
string <uuid>
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/oauth2-client-settings/

Request Body schema: application/json
required
object
type
required
string
Value: "oauth2-client-settings"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
redirect-uris
required
Array of strings <url> non-empty [ items <url > ]
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-client-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/oauth2-client-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-client-settings/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "oauth2-client-settings"
required
object
name
string <= 255 characters
redirect-uris
Array of strings <url> non-empty [ items <url > ]
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-client-settings/{id}/reset-secret/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-device-authorizations

/v1/oauth2-device-authorizations/

query Parameters
filter[user-code]
required
string [ 1 .. 255 ] characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

RFC 8628 ss 3.1 Endpoint

RFC 8628 ss 3.1 Endpoint

Request Body schema: application/json
client_id
required
string [ 1 .. 255 ] characters
scope
string
Enum: "" "general"
x-ui-host
string [ 1 .. 255 ] characters

Desired UI destination hostname

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "scope": "",
  • "x-ui-host": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "device_code": "string",
  • "expires_in": 0,
  • "interval": 0,
  • "user_code": "string",
  • "verification_uri": "string",
  • "verification_uri_complete": "string"
}

Approve the device authorization flow.

Approve the device authorization flow.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deny the device authorization flow.

Deny the device authorization flow.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-launcher

/v1/oauth2-launcher/

query Parameters
iss
required
string <= 1024 characters
launch
required
string <= 1024 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/oauth2-redirector

/v1/oauth2-redirector/

query Parameters
code
required
string <= 1024 characters
state
required
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/oauth2-token-consumptions

/v1/oauth2-token-consumptions/

Request Body schema: application/json
required
object
type
required
string
Value: "oauth2-token-consumptions"
required
object
code
required
string <= 2048 characters

RFC 6749 § 4.1.2 code value

idp-name
required
string <= 128 characters

Carium OAuth2 IdP name

state
string <= 2048 characters

RFC 6749 § 4.1.2 state value

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/oauth2-tokens

/v1/oauth2-tokens/

Request Body schema: application/json
One of
client_id
required
string <= 100 characters
client_secret
required
string <= 255 characters
code
required
string <= 255 characters
grant_type
required
string
Value: "authorization_code"
redirect_uri
string <= 255 characters

Responses

Request samples

Content type
application/json
Example
{
  • "client_id": "string",
  • "client_secret": "string",
  • "code": "string",
  • "grant_type": "authorization_code",
  • "redirect_uri": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/onboarding-info

/v1/onboarding-info/

Request Body schema: application/json
required
object
type
required
string
Value: "onboarding-info"
required
object
code
required
string <= 20 characters
email
string <= 255 characters
phone-number
string <phonenumberE164>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/onboarding-requests

/v1/onboarding-requests/

query Parameters
organization
required
string <uuid>
email
string <= 255 characters
Deprecated

Email of onboarding user

filter[email]
string <email> <= 255 characters
filter[phone]
string <phonenumberE164_us>
onboard-type
string
Default: "patient"
Enum: "patient" "provider"

Restrict to Onboardings of certain type

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
patient-ids
Array of strings <uuid> <= 100 items [ items <uuid > ]
with-invite
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/onboarding-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "onboarding-requests"
required
object or object
One of
organization
required
string <uuid>

Organization ID

patient
required
string <uuid>

The existing individual id that will be assigned to the user upon registration

auto-confirm
boolean
Deprecated
Default: false
auto-sign-up
boolean
Default: false
object
email
object
mobile
object
sms
object
voice
object
web
object
email-user-now
boolean
Deprecated
Default: false

Whether an onboarding email should be sent to the user immediately upon creation. Use notifications for notification function.

individual-group-id
string <uuid>
individual-group-ids
Array of strings <uuid> <= 20 items [ items <uuid > ]
locale
string
Default: "en_US"
Enum: "en_US" "es_US"
notifications
Array of strings
Items Enum: "email" "sms"
onboard-type
string
Default: "patient"
Value: "patient"

Type of Onboarding to create

password
string
patient-email
string <= 255 characters

Email of onboarding user

phone-number
string <phonenumberE164_us>
username
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Delete an onboarding request

Delete an onboarding request

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": { }
}

/v1/onboarding-requests/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-code
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/onboarding-requests/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "onboarding-requests"
required
object
email
string <= 255 characters

Email of onboarding user

id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/onboarding-requests/{id}/register/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

Resend notifications. It will send email and sms-t

Resend notifications. It will send email and sms-text whenever possible.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "onboarding-requests-email"
attributes
required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/onboarding-texts

/v1/onboarding-texts/{id}/update-status/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
attributes
required
object
id
required
string <uuid>
type
required
string <= 32 characters

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/org-agreeable-documents

/v1/org-agreeable-documents/

query Parameters
organization-id
required
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/org-agreeable-documents/{id}/agree/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
organization-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54"
}

Response samples

Content type
application/vnd.api+json
null

/v1/organization-code-info

/v1/organization-code-info/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-codes

/v1/organization-codes/

query Parameters
organization-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-codes/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-codes"
required
object
id
required
string [ 3 .. 20 ] characters
organization-id
required
string <uuid>
enrollment-schema
object
expires-at
string <datetime>
individual-group-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-codes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-codes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-codes/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-codes"
required
object
enrollment-schema
object
expires-at
string <datetime>
individual-group-id
string <uuid>
id
string <= 20 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-codes/{id}/users/

path Parameters
id
required
string

Resource identifier

query Parameters
email
string <= 255 characters
email-verified
boolean
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
state
string
Enum: "archived" "confirmed" "disabled" "force_reset_password" "init" "registered" "registered_disabled"
text
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-email-templates

/v1/organization-email-templates/

query Parameters
filter[format]
string
Enum: "html" "txt"
filter[locale]
string
Enum: "en_US" "es_US"
filter[type]
string
Enum: "forgot-password" "messaging-patient" "messaging-provider" "onboarding" "onboarding-code" "onboarding-provider" "reverify-email" "verify-email"
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
theme-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-email-templates/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-email-templates"
required
object or object
Any of
format
required
string
Enum: "html" "txt"
locale
required
string
Enum: "en_US" "es_US"
organization-id
required
string <uuid>
template
required
string <= 999999 characters
type
required
string
Enum: "forgot-password" "messaging-patient" "messaging-provider" "onboarding" "onboarding-code" "onboarding-provider" "reverify-email" "verify-email"
subject
string <= 255 characters
support-email
string <= 254 characters
support-email-title
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-email-templates/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-email-templates/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-email-templates/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-email-templates"
required
object
format
string
Enum: "html" "txt"
locale
string
Enum: "en_US" "es_US"
subject
string <= 255 characters
support-email
string <= 254 characters
support-email-title
string <= 255 characters
template
string <= 999999 characters
type
string
Enum: "forgot-password" "messaging-patient" "messaging-provider" "onboarding" "onboarding-code" "onboarding-provider" "reverify-email" "verify-email"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-features

/v1/organization-features/

query Parameters
filter[feature-name]
string <= 255 characters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-features/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-features"
required
object
feature-name
required
string <= 255 characters
organization-id
required
string <uuid>
force
boolean
Default: false
state
string
Default: "enabled"
Enum: "disabled" "dontcare" "enabled"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-features/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-features"
required
object
force
boolean
state
string
Enum: "disabled" "dontcare" "enabled"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/organization-general-messages

/v1/organization-general-messages/

query Parameters
organization-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-general-messages/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-general-messages"
required
object
locale
required
string
Enum: "en_US" "es_US"
message
required
string <= 255 characters
name
required
string
Value: "contact"
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-general-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-general-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-general-messages/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-general-messages"
required
object
message
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-sms-templates

/v1/organization-sms-templates/

query Parameters
filter[locale]
string
Enum: "en_US" "es_US"
filter[type]
string
Enum: "onboarding" "onboarding-code" "onboarding-provider" "reset-password" "verify"
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
theme-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-sms-templates/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-sms-templates"
required
object or object
Any of
locale
required
string
Enum: "en_US" "es_US"
organization-id
required
string <uuid>
template
required
string <= 999999 characters
type
required
string
Enum: "onboarding" "onboarding-code" "onboarding-provider" "reset-password" "verify"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-sms-templates/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-sms-templates/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-sms-templates/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-sms-templates"
required
object
locale
string
Enum: "en_US" "es_US"
template
string <= 999999 characters
type
string
Enum: "onboarding" "onboarding-code" "onboarding-provider" "reset-password" "verify"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-themes

/v1/organization-themes/

query Parameters
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.

filter[domain]
string <= 255 characters
filter[include-inactive]
boolean
Default: false
filter[support-email]
string <email>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organization-themes/

Request Body schema: application/json
required
object
type
required
string
Value: "organization-themes"
required
object
domain
required
string <= 255 characters
support-email-name
required
string <= 255 characters
support-email
string <email>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-themes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organization-themes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-themes/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organization-themes"
required
object
domain
string <= 255 characters
support-email
string <email>
support-email-name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organizations

/v1/organizations/

query Parameters
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.

filter[include-inactive]
boolean
Default: false
filter[name]
string <= 255 characters
filter[name][contains]
string <= 255 characters
page[limit]
integer
Default: 25
page[offset]
integer
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organizations/

Request Body schema: application/json
required
object
type
required
string
Value: "organizations"
required
object
name
required
string <= 40 characters

Organization 'name' field is an internal, non-human-displayed field that must consist of onlylower-case alphanumeric characters and dashes, have no consecutive dashes, and must be shorter than 40 characters.

classification
string
Default: "customer"
Enum: "carium" "carium-test" "customer" "customer-test" "former-customer" "hms" "hms-client" "hms-provider"

Internal classification of the Organization. Affects analytic categorization. Only configurable by Carium Administrators.

display-name
string <= 255 characters

Human-displayed organization name

provider-type
string
Default: "provider"
Enum: "coach" "provider"
require-provider-mfa
boolean
Default: false

When set, providers must complete MFA to log in. Carium admins only.

timezone
string <timezone>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organizations/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organizations"
required
object
authorization-type
string
Enum: "open" "regular"
classification
string
Enum: "carium" "carium-test" "customer" "customer-test" "former-customer" "hms" "hms-client" "hms-provider"
display-name
string <= 255 characters

Human-displayed organization name

name
string <= 40 characters
provider-type
string
Enum: "coach" "provider"
require-provider-mfa
boolean

When set, providers must complete MFA to log in. Carium admins only.

null or string
Any of
null
timezone
string <timezone>
id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organizations/{id}/add-user/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organizations"
required
object
email
string <email>
role-id
string <uuid>
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/organizations/{id}/delete-logo/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/organizations/{id}/get-logo-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/organizations/{id}/process-logo-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organizations/{id}/remove-user/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "organizations"
required
object
email
string <email>
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/organizations/{id}/upload-logo/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
content-type
required
string <= 255 characters
filename
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "content-type": "string",
  • "filename": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/password-strength

/v1/password-strength/

Request Body schema: application/json
password
required
string [ 1 .. 255 ] characters

The password for which to calculate strength.

check-pwned
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "check-pwned": false,
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "pwned": {
    },
  • "strength": {
    },
  • "suggestions": [
    ]
}

/v1/password-validation-rules

/v1/password-validation-rules/

Responses

Response samples

Content type
application/vnd.api+json
[
  • {
    }
]

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "test_data" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/refresh-token

/v1/refresh-token/

Request Body schema: application/json
refresh-token
required
string <= 2048 characters
interactive
boolean
Default: false

Is this refresh due to immediate user presence? Defaults to false. If true, refresh may be rejected and user interaction required (eg Service Document agreements required).

Responses

Request samples

Content type
application/json
{
  • "interactive": false,
  • "refresh-token": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string",
  • "email": "string",
  • "first-name": "string",
  • "id-token": "string",
  • "impersonated-by": {
    },
  • "individual": {
    },
  • "last-name": "string",
  • "locale": "en_US",
  • "locale-explicit": true,
  • "multi-organization": true,
  • "organizations": [
    ],
  • "session-id": "string",
  • "tz": "string",
  • "tz-explicit": true,
  • "user-id": "string",
  • "username": "string"
}

/v1/registration-invitations

/v1/registration-invitations/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/registration-invitations/

Request Body schema: application/json
required
object
type
required
string
Value: "registration-invitations"
required
object
invited-email
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/registration-invitations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/registration-invitations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/resend-invitation

/v1/resend-invitation/

Request Body schema: application/json
email
string <email>
Deprecated
new-email
string <email>
notifications
Array of strings
Items Enum: "email" "sms"

By default, will use the notification methods as specified in the onboarding-request. If empty, will default to email

username
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "new-email": "user@example.com",
  • "notifications": [
    ],
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "signup-request-id": "string",
  • "signup-request-type": "onboard"
}

/v1/resend-verify-contact

/v1/resend-verify-contact/

Request Body schema: application/json
Any of
username
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/resend-verify-email

/v1/resend-verify-email/

Request Body schema: application/json
Any of
username
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/role-users

/v1/role-users/

query Parameters
role-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/role-users/

Request Body schema: application/json
required
object
type
required
string
Value: "role-users"
required
object
role-id
required
string <uuid>
email
string <email>
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/role-users/{id}/

path Parameters
id
required
integer

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/roles

/v1/roles/

query Parameters
filter[name]
string <= 255 characters
organization-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/roles/{id}/add-user/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "roles"
required
object
email
string <email>
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/roles/{id}/remove-user/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "roles"
required
object
email
string <email>
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/saml-acs

/v1/saml-acs/{id}/acs/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
SAMLResponse
required
string <= 99999 characters
RelayState
string <= 99999 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "RelayState": "string",
  • "SAMLResponse": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/saml-acs/{id}/certificate/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/saml-acs/{id}/logout/

path Parameters
id
required
string

Resource identifier

query Parameters
SAMLRequest
required
string <= 99999 characters
RelayState
string <= 99999 characters
SigAlg
string <= 99999 characters
Signature
string <= 99999 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/saml-acs/{id}/metadata/

path Parameters
id
required
string

Resource identifier

Responses

/v1/saml-login

/v1/saml-login/

query Parameters
domain
required
string <= 255 characters
email-address
string <= 255 characters

A specific email address to login to

next
string <= 255 characters

The URI to redirect to after login

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/saml-user-claims

/v1/saml-user-claims/

query Parameters
organization-id
required
string <uuid>

Organization whose active SAML credentials will be used to scope claim results.

filter[user-ids]
Array of strings <uuid> <= 10 items [ items <uuid > ]

Optional list of user IDs to restrict results.

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/service-documents

/v1/service-documents/

query Parameters
latest
required
boolean
organization-code
string <= 20 characters

Optional Organization Code for additional Organization Documents

organizations
Array of strings <uuid> <= 10 items [ items <uuid > ]
referral-code
string <= 20 characters

Optional referral code (onboarding code) for additional Organization Documents

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/service-documents/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
html
boolean
locale
string <= 16 characters
reflow
boolean

Inject reflow CSS into html content

Responses

Response samples

Content type
{
  • "data": {
    },
  • "meta": { }
}

/v1/sessions

Get a session by id.

Get a session by id.

path Parameters
id
required
string

Resource identifier

query Parameters
include-login-info
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/shared-individuals

/v1/shared-individuals/

query Parameters
individual-id
string <uuid>
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/shared-individuals/

Request Body schema: application/json
required
object
type
required
string
Value: "shared-individuals"
required
object or object or object
One of
individual-id
required
string <uuid>
shared-with-id
required
string <uuid>
shared-type
string
Default: "read_write"
Value: "read_write"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/shared-individuals/{id}/

path Parameters
id
required
integer

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/shared-individuals/{id}/

path Parameters
id
required
integer

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sign-up

/v1/sign-up/

Request Body schema: application/json
One of
first-name
required
string
last-name
required
string
organization-code
required
string
username
required
string
auto-confirm
boolean
Deprecated
Default: false
auto-sign-up
boolean
Default: false
birth-date
string <date>
contact-phone-mobile
string
email
string
enrollment-data
object
gender
string
Enum: "female" "male" "other" "pnta" "unknown"
locale
string
Enum: "en_US" "es_US"
notifications
Array of strings
Items Enum: "email" "sms"
password
string

Password for the user -- required unless account is sso-only

preferred-name
string
service-document-agreements
Array of strings

List of service document IDs being agreed to

set-username
string
Enum: "email" "phone"
source
string
Enum: "email" "sms"
tz
string <timezone>

Responses

Request samples

Content type
application/json
{
  • "auto-confirm": false,
  • "birth-date": "2019-08-24",
  • "last-name": "string",
  • "locale": "en_US",
  • "password": "string",
  • "referral-code": "string",
  • "service-document-agreements": [
    ],
  • "set-username": "email",
  • "source": "email",
  • "tz": "string",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "account-type": "provider"
}

/v1/sign-up-stats

/v1/sign-up-stats/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/synthetic-user-tokens

/v1/synthetic-user-tokens/

Request Body schema: application/json
required
object
user-id
required
string <uuid>
Array of objects <= 10 items

Additional claims to add to the access token. Keys must start with c-

Array (<= 10 items)
claim
required
string <= 16 characters ^c-[a-z]+(-[a-z]+)*$
required
string or number
expiration-secs
integer
Default: 1800
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/systems

/v1/systems/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/url-shorteners

/v1/url-shorteners/

query Parameters
code
string <= 8 characters
organization-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/url-shorteners/

Request Body schema: application/json
required
object
type
required
string
Value: "url-shorteners"
required
object
full-path
required
string [ 1 .. 2048 ] characters
expires-at
string <datetime>
netloc
string [ 1 .. 255 ] characters
organization-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/url-shorteners/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/url-shorteners/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/url-shorteners/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "url-shorteners"
required
object
expires-at
string <datetime>
full-path
string [ 1 .. 2048 ] characters
netloc
string [ 1 .. 255 ] characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/url-shorteners-redirect

/v1/url-shorteners-redirect/

query Parameters
code
required
string <= 9 characters

Responses

/v1/user-activities

/v1/user-activities/

query Parameters
filter[cmp-timestamp]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against timestamp. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[event-types]
Array of strings non-empty
Items Enum: "login" "refr" "sreg"
filter[exclude-carium-activity]
boolean
Default: true
filter[user-id]
string <uuid>
page[limit]
integer
Default: 500
page[offset]
integer
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-carium-eligibilities

/v1/user-carium-eligibilities/

query Parameters
organization-id
required
string <uuid>
user-id
required
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-carium-eligibilities/

Request Body schema: application/json
required
object
type
required
string
Value: "user-carium-eligibilities"
required
object
is-eligible
required
boolean
organization-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-carium-eligibilities/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-carium-eligibilities/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "user-carium-eligibilities"
required
object
is-eligible
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-checkins

/v1/user-checkins/

query Parameters
individual-id
required
string <uuid>
filter[source]
string
Enum: "android" "ios" "web"
page[limit]
integer
Default: 500
page[offset]
integer
Default: 0
summary
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-checkins/

Request Body schema: application/json
required
object
type
required
string
Value: "user-checkins"
required
object
source
required
string
Enum: "android" "ios" "web"
app-version
string <= 32 characters
model
string <= 32 characters
os-version
string <= 32 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-features

/v1/user-features/

query Parameters
filter[feature-name]
string <= 255 characters
filter[organization-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
user-email
string <email>
user-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-features/

Request Body schema: application/json
required
object
type
required
string
Value: "user-features"
required
object or object
One of
feature-name
required
string <= 255 characters
user-id
required
string <uuid>
force
boolean
Default: false
organization-id
string <uuid>
state
string
Default: "enabled"
Enum: "disabled" "dontcare" "enabled"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-features/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-features/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "user-features"
required
object
force
boolean
state
string
Enum: "disabled" "dontcare" "enabled"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/user-match-invitations

/v1/user-match-invitations/

Request Body schema: application/json
required
object
type
required
string
Value: "user-match-invitations"
required
object
birth-date
required
string <date>
organization-id
required
string <uuid>
referral-code
required
string <= 255 characters
coverage-member-id
string <= 255 characters
email
string <email>
first-name
string <= 255 characters
khm-consent
boolean
Default: false
last-name
string <= 255 characters
phone
string <phonenumberE164>
signup-template-type
string
Value: "onboarding-code"
signup-with-email
boolean
Default: false
signup-with-sms
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-organizations

/v1/user-organizations/

query Parameters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
user-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-organizations/

Request Body schema: application/json
required
object
type
required
string
Value: "user-organizations"
required
object
organization-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-replications

/v1/user-replications/

query Parameters
user-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-replications/

Request Body schema: application/json
required
object
type
required
string
Value: "user-replications"
required
object
service
string <= 24 characters
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users

/v1/users/

query Parameters
email
string <= 255 characters
filter[classification]
string
Enum: "carium" "customer" "customer_test"
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.

filter[email-verified]
boolean
filter[enabled]
boolean
filter[include-inactive]
boolean
Default: false
filter[include-participants]
boolean
Default: false
filter[include-tester]
boolean
filter[include-unverified]
boolean
Default: false
filter[organization-admin]
boolean
Value: true

Find only org.admin users (False not supported)

filter[phone-number]
string <phonenumberE164> <= 30 characters
filter[primary-individual-ids]
Array of strings <uuid> [ items <uuid > ]
filter[registration-invite]
Array of strings
Items Enum: "accepted" "failed" "none" "sent"
filter[username]
string <= 255 characters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
shared-with-id
string <uuid>

filter users shared with organization id or user id

sort-by
Array of strings = 1 items
Items Enum: "-email" "-first-name" "-id" "-last-name" "email" "first-name" "id" "last-name"
text
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/users/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
organization-id
string <uuid>
with-roles
boolean
Default: false
with-signups
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "users"
required
object
classification
string
Enum: "carium" "customer" "customer_test"
object
email
object
mobile
object
sms
object
voice
object
web
object
default-organization-id
string <uuid>
display-name
string <= 255 characters
email
string <= 255 characters
first-name
string <= 255 characters
last-name
string <= 255 characters
locale
string <= 8 characters
string or null
One of
string <npi>
string or string
One of
<= 30 characters
string <phonenumber> <= 30 characters
tz
string <timezone>
username
string
Enum: "email" "phone"
id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/auto-sign-up/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/change-email/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
email
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/change-password/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
new-password
required
string <= 255 characters
old-password
required
string <= 255 characters
maintain-active-sessions
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "context": "carium-support",
  • "maintain-active-sessions": true,
  • "new-password": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/clear-password-reset-required/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/confirm-phone/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
phone-number
required
string <phonenumberE164_us>

Responses

Request samples

Content type
application/json
{
  • "phone-number": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/deidentify/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

Delete all service document agreements for your us

Delete all service document agreements for your user. Limited to Carium employees.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/disable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/enable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/set-password-reset-required/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/users/{id}/switch-organization/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
organization-id
required
string <uuid>
set-default
required
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "set-default": false
}

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string",
  • "id-token": "string",
  • "refresh-token": "string"
}

/v1/validate-email

/v1/validate-email/

Request Body schema: application/json
email
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "suggestions": [
    ],
  • "valid": true
}

/v2/individual-groups

/v2/individual-groups/

query Parameters
exclude[individual-id]
string <uuid>
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[eligible-individual-id]
string <uuid>
filter[exclude-ids]
Array of strings <uuid> [ items <uuid > ]
filter[include-inactive]
boolean
Default: false
filter[individual-id]
string <uuid>
filter[leader-id]
string <uuid>
filter[node-type]
string
Enum: "division" "group"
filter[parent-group-id]
string <uuid>
filter[tags]
Array of strings[ items <= 127 characters ]
filter[text]
string <= 255 characters
filter[tree-node-type]
string
Enum: "leaf" "non-leaf"
ids
Array of strings <uuid> [ items <uuid > ]
name
string <= 255 characters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
type
Array of strings
Default: "regular&type=provider_only"
Items Enum: "all_participants" "provider_only" "regular" "unassigned"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v2/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
filter[include-inactive]
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/individual-groups/{id}/add-individuals/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "remove-from-group": "b6e60b8a-a564-4615-9438-0aa9e2c657a7",
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/individual-groups/{id}/remove-individuals/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> [ 1 .. 1000 ] items [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/internal-auth

/v2/internal-auth/

Request Body schema: application/json
required
object
type
required
string
Value: "internal-auths"
required
object
token
required
string <= 9999 characters

Infra Token to exchange for a Carium IAM Token

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}