GuidesAPI ReferenceSign-UpRecipes
API Reference

Retrieve a citizen's 'effective' permissions for the given arguments

get
https://api.consentric.io/v1/permissions

The request MUST provide either citizenId or externalRef or both.

If both citizenId and externalRef are provided, they must resolve to the same Citizen.

If the validity range (validStart to validEnd) is omitted, the server timestamp will be used for both.

If only validStart is provided, then the validity range will be from validStart until now.

If only validEnd is provided, then the validity range will be from now until validEnd.

Only permissions that are valid from the start and still valid at the end of the range will be returned. Permissions without a validUntil date will be considered valid from their start date until the end of time.

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

The ID associated with the target Application.

string

The ID associated with the target Citizen.

string

The unique reference associated with the Citizen.

string

The ID associated with the target Option.

string
Defaults to effective

Specifies how to behave when expired permissions exist. A value of 'effective' will result in expired permissions not being returned. A value of 'latest' will return a status of 'expired' for such permissions.

date-time

An ISO 8601 date (and time) specifying an inclusive permission valid start date for the results returned

date-time

An ISO 8601 date (and time) specifying an exclusive permission valid end date for the results returned

Responses

Updated 6 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago