Get guarantor identifiers

Returns identifiers that uniquely reference a guarantor in the upstream EHR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

hls-guarantor:read

Query Params
date

Guarantor date of birth used to filter identifiers.

string
length between 4 and 4
^\d{4}$

Last four digits of the guarantor SSN used to refine the lookup.

string
required

Guarantor identifier used to resolve the guarantor in the upstream EHR.

integer
1 to 2147483647
Defaults to 1

The page number to request. Starts at 1, defaults to 1 when not provided.

integer
1 to 50
Defaults to 25

The maximum number of items per page. Defaults to 25 when not provided.

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/json