Skip to content
Authrim

Get a person's identity assurance.

GET
/api/admin/users/{id}/assurance
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/users/example/assurance \
  --header 'Authorization: Bearer <token>'

The IAL the person’s evidence supports now (IAL1 without evidence), and the evidence, newest first. Evidence counts while it is verified (at a time not in the future), not expired, not revoked and recorded under the NIST framework.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The person’s identity assurance.

Media type application/json
object
effective_ial
required
object
level
required
string
Allowed values: IAL1 IAL2 IAL3
evidence_id
required
string | null
verified_at
required
string | null format: date-time
key
additional properties
evidence
required
Array<object>
<= 100 items
object
evidence_id
required
string
evidence_type
required

Admin_attestation, document_check, in_person_check and remote_supervised_check from an administrator; scim and import from provisioning; tenant_policy for the tenant’s default IAL.

string
issuer_ref
required

Who recorded it (admin:, scim:, import:, tenant_policy).

string | null
assurance_framework
required
string | null
assurance_level
required
string | null
evidence_hash
required
string | null
evidence_storage_ref
required
string | null
verified_at
required
string | null format: date-time
expires_at
required
string | null format: date-time
revoked_at
required
string | null format: date-time
revoked_by
required

Who revoked it (admin:, or the provisioning source that replaced it).

string | null
created_at
required
string | null format: date-time
status
required

Active counts toward the IAL; pending does not yet (verified in the future, or recorded and awaiting its audit).

string
Allowed values: active pending expired revoked
key
additional properties
truncated
required
boolean
key
additional properties
Example 
{
  "effective_ial": {
    "level": "IAL1"
  },
  "evidence": [
    {
      "status": "active"
    }
  ]
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}