Skip to content
Registry StackDocsv0.46.0
Search

Exchange one claimed token and plural proofs for plural credentials

POST
/credential
curl --request POST \
  --url https://example.com/credential \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "credential_configuration_id": "example", "proofs": { "jwt": [ "example" ] } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
credential_configuration_id
required
string
proofs
required
object
jwt
required
Array<string>
>= 1 items <= 16 items

Example generated

{
  "credential_configuration_id": "example",
  "proofs": {
    "jwt": [
      "example"
    ]
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Evidence credentials, byte-for-byte

Media typeapplication/json
object
credentials
required
Array<object>
>= 1 items <= 16 items
object
credential
required
string

Example generated

{
  "credentials": [
    {
      "credential": "example"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache

400

Section titled “400”

The configuration, nonce, proof, or post-claim credential request was terminally refused

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string
error
required
Allowed values: invalid_credential_request invalid_proof invalid_nonce credential_request_denied

Examples

ExamplepostClaimCredentialRequestDenied

A claimed authorization cannot be retried

{
  "error": "credential_request_denied",
  "error_description": "this credential request cannot be completed"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache

401

Section titled “401”

The access token is missing, unknown, expired, or already claimed

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string

Example 

{
  "error": "invalid_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache
WWW-Authenticate
string
Allowed value: Bearer

408

Section titled “408”

The configured request deadline elapsed

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string

Example 

{
  "error": "invalid_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache

413

Section titled “413”

The request body exceeds the configured byte limit

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string

Example 

{
  "error": "invalid_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache

429

Section titled “429”

The request budget is spent; retry after the interval in Retry-After

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string

Example 

{
  "error": "invalid_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache
Retry-After
integer
>= 1

503

Section titled “503”

Bounded state is unavailable before the access token can be claimed

Media typeapplication/json
object
error
required
Allowed values: invalid_request invalid_token unsupported_grant_type invalid_grant invalid_credential_request invalid_proof invalid_nonce credential_request_denied temporarily_unavailable server_error
error_description
required
string

Example 

{
  "error": "invalid_request"
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store
Pragma
string
Allowed value: no-cache