Skip to main content
Credential offers

Receive credential with transaction code

PUT/v4/config/ows/holder/credentials/{credentialId}/transaction-code

Sends the transaction code (tx_code) of a Pre-Authorized Code Flow and receives the credential. Use it for a record in credential_pending with requiresTransactionCode true. The issuer gives the code to the user out of band; txCode of the record tells its length and input mode. The wallet sends the code with the pre-authorised code to the Token Endpoint of the issuer, then asks for the credential.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:credentials:receive

Path parameters

Body

application/json

The transaction code.

  • transactionCodestringrequired

    Required. The transaction code as a JSON string (a JSON number is refused, because it loses the leading zeros). The wallet removes the spaces at the start and the end; the rest must have 4 to 12 characters.

    4 to 12 characters.

    Example:"3491"

Response

application/json

The credential records that the wallet received.

  • credentialobject or any[] | null

    One credential record, an array when the offer gives more than one record, or null when it gives none.