Records API: Credentials

Retrieves one specific credential

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

credentialstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/records/credentials/{credential}

HTTPcURLJavaScriptPython

GET /v2/e01/api/records/credentials/{credential} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific credential

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

credentialstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/records/credentials/{credential}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/records/credentials/{credential} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/credentials/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/credentials/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 104

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "AuthorityId": "123e4567-e89b-12d3-a456-426614174000",
    "CredentialId": "123e4567-e89b-12d3-a456-426614174000",
    "EmployerGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "AfterExpiryNotificationSent": true,
    "BeforeExpiryNotificationSent": true,
    "AuthorityLocation": "text",
    "AuthorityName": "text",
    "AuthorityReference": "text",
    "AuthorityType": "text",
    "CredentialDescription": "text",
    "CredentialGrantedDescription": "text",
    "CredentialNecessity": "text",
    "CredentialPriority": "text",
    "CredentialReminderType": "text",
    "CredentialRevokedReason": "text",
    "CredentialStatus": "text",
    "EmployerGroupStatus": "text",
    "ExpirationLifetimeUnit": "text",
    "ExpirationType": "text",
    "PublisherAddress": "text",
    "TransactionHash": "text",
    "ExpirationLifetimeQuantity": 1,
    "PublicationStatus": 1,
    "CredentialGrantedScore": 1,
    "CredentialHours": 1,
    "CredentialRevokedScore": 1,
    "CredentialAssigned": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationExpected": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderDelivered0": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderDelivered1": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderDelivered2": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderDelivered3": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderRequested0": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderRequested1": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderRequested2": "2026-05-09T02:51:41.627Z",
    "CredentialExpirationReminderRequested3": "2026-05-09T02:51:41.627Z",
    "CredentialExpired": "2026-05-09T02:51:41.627Z",
    "CredentialGranted": "2026-05-09T02:51:41.627Z",
    "CredentialRevoked": "2026-05-09T02:51:41.627Z",
    "ExpirationFixedDate": "2026-05-09T02:51:41.627Z"
  }
]

Counts the credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/credentials/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/credentials/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 104

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

Responses

200

OK

post

/api/records/credentials/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/credentials/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 104

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/credentials/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/credentials/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 104

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "CredentialId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "CredentialIssued": "2026-05-09T02:51:41.627Z",
    "CredentialStatus": "text",
    "CredentialNecessity": "text",
    "CredentialIsRequired": true
  }
]