Atrium API
Read Institution Credentials
Use this endpoint to see which credentials will be needed to create a member for a specific institution.
info
Institution credentials are not the same as member credentials. Use institution credentials to create a new member and member credentials to update an existing member.
GET
/institutions/{institution_code}/credentials
Request Body
| Field | Required | Type |
|---|---|---|
display_order The order in which the credential should be displayed to the end user; lower numbers should be displayed first. | Optional | Integer |
field_name Name of the credential field for the institution (e.g. 'LOGIN') | Optional | String |
guid A unique identifier for the credential. Defined by MX. | Optional | String |
label A label for the credential, intended to be readable by the end user (e.g. 'Username') | Optional | String |
type A name for the type of field (e.g. 'PASSWORD') | Optional | String |
options See explanation that immediately follows. | Optional | Options[] |
Request sample
Language:sh
Response sample
Language:json