Skip to content
Trustaige Docs
API reference

Customer credentials

Get a subject

get /o/{shortId}/api/credentials/subjects/{subject}

One customer and every credential issued to them.

Authentication

A client token (Authorization: Bearer …) from POST /oauth2/token with the scope issued:read .

Path parameters

  • shortId string required

    Your organization's short ID, as it appears in your issuer: https://id.trustaige.com/o/{shortId}.

  • subject string · uuid required

    The subject returned when you made the offer.

Responses

  • 200 The subject.
    Show response fields
    • subject string · uuid required

      The customer.

    • claimed boolean required

      Whether the customer has claimed a credential.

    • credentials array of object required

      Every credential issued to the customer.

      Show child attributes
      • id string required

        The issued credential.

      • credentialType string required

        The credential type's name.

      • status string required

        Where the credential stands.

        One of offered , issued , suspended , revoked

      • issuedAt string · date-time

        When the customer first held it, across renewals.

      • expiresAt string · date-time

        When it ends, if it has an end.

      • revokedAt string · date-time

        When it was revoked.

      • revokedReason string

        Why it was revoked.

      • revocable boolean required

        Whether it can be revoked or suspended at all. A pass simply ends when it expires.

      • holderId string required

        The customer it was issued to.

      • holderClaimedAt string · date-time

        When the customer claimed it.

      • holderApp string

        The app the customer claimed it through.

      • createdAt string · date-time required

        When it was created.

  • 404 Your app made no offer to this subject.

Errors

Errors come back as a code to branch on. What each means and what to do:

Status Code What to do
403 wrong_organization The token belongs to another organization's app.
404 unknown_subject No subject by that ID was minted by your app.