> For the complete documentation index, see [llms.txt](https://docs.toolkit.equs.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toolkit.equs.ai/api/web-wallet-api/credential-offer.md).

# Credential Offer

## Get Credential Offer

> Get Credential Offer by credential\_offer\_uri

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Web Custodial Wallet Documentation","version":"0.1.2"},"tags":[{"name":"Credential Offer","description":""}],"security":[{"user":[]},{"agent":[]},{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Holder user. `users` realm token with `principal_type=user`. Authorize one bearer scheme at a time."},"agent":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Holder's AI agent. `users` realm token with `principal_type=agent`. Authorize one bearer scheme at a time."}},"schemas":{"GetOfferResponse":{"type":"object","properties":{"refUrl":{"type":"string","description":"Reference URL under which the raw offer payload can be retrieved."},"overview":{"description":"Summary of the offer for display purposes.","allOf":[{"$ref":"#/components/schemas/GetOfferResponse.OfferOverview"}]},"offer":{"description":"Raw credential offer payload.","allOf":[{"$ref":"#/components/schemas/GetOfferResponseOffer"}]}},"required":["refUrl","overview","offer"]},"GetOfferResponse.OfferOverview":{"type":"object","properties":{"version":{"type":"string","description":"Version of the offer overview payload."},"assurance":{"type":"string","description":"Level of assurance associated with the credential being offered.","enum":["low","high"]},"txCodeFetchUrl":{"type":"object","description":"URL the holder can use to fetch the transaction code required to accept the offer."},"txCodeResendUrl":{"type":"object","description":"URL the holder can use to request the transaction code to be resent."},"deliveryMethod":{"type":"object","description":"Method used to deliver the transaction code to the holder."},"dedicatedDid":{"type":"object","description":"Dedicated DID type to be used to be subject in this credential, if any."},"issuanceDate":{"format":"date-time","type":"string","description":"Date and time the offer was issued."},"expireDate":{"format":"date-time","type":"string","description":"Date and time the offer expires."},"metadata":{"description":"Display metadata associated with the credential being offered.","allOf":[{"$ref":"#/components/schemas/GetOfferMetadata"}]}},"required":["version","assurance","issuanceDate","metadata"]},"GetOfferMetadata":{"type":"object","properties":{"issuer":{"description":"Metadata of the issuer that issued the credential.","allOf":[{"$ref":"#/components/schemas/IssuerMetadata"}]},"credDef":{"description":"Metadata describing the credential type/definition.","allOf":[{"$ref":"#/components/schemas/CredDefMetadata"}]}},"required":["issuer","credDef"]},"IssuerMetadata":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the issuer."},"logo":{"description":"Logo displayed for the issuer.","allOf":[{"$ref":"#/components/schemas/Logo"}]}}},"Logo":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"Publicly accessible URL of the logo image."},"altText":{"type":"string","description":"Alternative text describing the logo, used for accessibility."}},"required":["uri"]},"CredDefMetadata":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the credential type."},"logo":{"description":"Logo displayed for this credential type.","allOf":[{"$ref":"#/components/schemas/Logo"}]},"description":{"type":"string","description":"Human-readable description of the credential type."},"backgroundColor":{"type":"string","description":"Background color used to render the credential card, as a hex value."},"textColor":{"type":"string","description":"Text color used to render the credential card, as a hex value."}}},"GetOfferResponseOffer":{"type":"object","properties":{"grants":{"description":"Grants supported for redeeming this credential offer.","allOf":[{"$ref":"#/components/schemas/OfferGrants"}]},"credential_issuer":{"type":"string","description":"Base URL identifying the credential issuer."},"credential_configuration_ids":{"description":"Identifiers of the credential configurations offered.","type":"array","items":{"type":"string"}}},"required":["credential_issuer","credential_configuration_ids"]},"OfferGrants":{"type":"object","properties":{"authorization_code":{"description":"Authorization code grant details.","allOf":[{"$ref":"#/components/schemas/AuthorizationCodeGrant"}]},"urn:ietf:params:oauth:grant-type:pre-authorized_code":{"description":"Pre-authorized code grant details.","allOf":[{"$ref":"#/components/schemas/PreAuthorizationCodeGrant"}]}}},"AuthorizationCodeGrant":{"type":"object","properties":{"issuer_state":{"type":"string","description":"Issuer state to be passed as a query parameter in the authorization request."},"authorization_server":{"type":"string","description":"Identifier of the authorization server the wallet should use for this grant."}}},"PreAuthorizationCodeGrant":{"type":"object","properties":{"pre-authorized_code":{"type":"string","description":"Pre-authorized code the wallet exchanges for an access token."},"tx_code":{"description":"Transaction code requirements for the pre-authorized code grant.","allOf":[{"$ref":"#/components/schemas/TransactionCode"}]},"interval":{"type":"number","description":"Minimum amount of time in seconds the wallet should wait between polling requests."},"authorization_server":{"type":"string","description":"Identifier of the authorization server issuing the pre-authorized code grant."}},"required":["pre-authorized_code"]},"TransactionCode":{"type":"object","properties":{"length":{"type":"number","description":"Expected length of the transaction code."},"input_mode":{"type":"string","description":"Format expected for the user-entered transaction code."},"description":{"type":"string","description":"Human-readable guidance shown to the user for entering the transaction code."}}}}},"paths":{"/api/v1/offers":{"get":{"description":"Get Credential Offer by credential_offer_uri","operationId":"OfferController_getOffer_api/v1","parameters":[{"name":"credential_offer_uri","required":true,"in":"query","description":"URI of the credential offer to fetch.","schema":{"type":"string"}}],"responses":{"200":{"description":"When Offer is retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOfferResponse"}}}},"400":{"description":"- When there is no offer with such credential_offer_uri.\n- When one or more credential definition names could not be successfully parsed."}},"summary":"Get Credential Offer","tags":["Credential Offer"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.toolkit.equs.ai/api/web-wallet-api/credential-offer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.