Get credential details
Returns details for a specific credential
/api/3/people/{person_id}/credentials/{id}
Authentication
This endpoint requires authentication:
Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.
Header Format:
Authorization: Bearer YOUR_ACCESS_TOKEN
Required Scopes:
account.person.readonly
Parameters
Path Parameters
person_id
integer
Person ID
id
string
Credential ID (hashid) or HID invitation ID (format 99xxxxxxxx)
Query Parameters
callback
string
Webhook callback ID for acknowledgment
ack_token
string
Webhook acknowledgment token
Responses
Credential details retrieved successfully
Response Fields
id
string
required
Unique hashid identifier for the credential
eg. abc123xyz
credential_type_id
integer
required
ID of the credential type
eg. 5
label
string
required
Human-readable label for the credential type
eg. Card Number
person_id
integer
required
ID of the person this credential belongs to
eg. 12345
value
string | null
Credential value (only present for value-assignable credential types like cards, PINs, etc. Not present for mobile credentials)
eg. 1234567890
status
string | null
Status for mobile credentials (HID Mobile Access)
eg. active
url
string | null
PassFlow credential URL (only for PassFlow credentials in invited state)
wallet_type
string | null
Wallet type for PassFlow credentials that have been added to wallet
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
eg. forbidden
error_description
string
eg. You are not authorized to access this resource
Not Found - Resource does not exist or is not an admission request event
Response Fields
error
string
eg. not_found
error_description
string
eg. The requested resource was not found
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred