> 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/oid4vci.md).

# Oid4Vci

## Accept Credential Offer

> Accept Credential Offer. Receive and store VC as a result

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Web Custodial Wallet Documentation","version":"0.1.2"},"tags":[{"name":"Oid4Vci","description":""}],"security":[{"user":[]},{"agent":[]}],"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":{"AcceptOfferRequest":{"type":"object","properties":{"offer":{"description":"Credential offer to be accepted.","allOf":[{"$ref":"#/components/schemas/ExtendedOffer"}]},"txCode":{"type":"string","description":"Transaction code required to accept the credential offer."}},"required":["offer","txCode"]},"ExtendedOffer":{"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"}},"extra":{"description":"Internal offer metadata not part of the OID4VCI spec.","allOf":[{"$ref":"#/components/schemas/OfferExtra"}]}},"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."}}},"OfferExtra":{"type":"object","properties":{"dedicatedDid":{"type":"object","description":"Dedicated DID type to bind the issued credential to."}}},"AcceptOfferResponse":{"type":"object","properties":{"id":{"type":"string","description":"Credential unique ID"},"payload":{"type":"string","description":"Raw payload of the issued credential."}},"required":["id","payload"]}}},"paths":{"/api/v1/oid4vci/offers":{"post":{"description":"Accept Credential Offer. Receive and store VC as a result","operationId":"Oid4VciController_acceptOffer_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptOfferRequest"}}}},"responses":{"201":{"description":"When Offer is accepted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptOfferResponse"}}}},"400":{"description":"- When VC issuance has failed\n- When one or more credential definition names could not be successfully parsed."}},"summary":"Accept Credential Offer","tags":["Oid4Vci"]}}}}
```

## Accept Credential Offer automatically

> Accept Credential Offer automatically. Receive and store VC as a result

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Web Custodial Wallet Documentation","version":"0.1.2"},"tags":[{"name":"Oid4Vci","description":""}],"security":[{"sp":[]},{"tenant":[]},{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."},"tenant":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Tenant. Token of a Tenant machine client or of a Tenant portal user, carrying the `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"AutoAcceptOfferRequest":{"type":"object","properties":{"userId":{"type":"string","description":"User unique ID"},"offerUri":{"type":"string","description":"URI of the credential offer to accept."},"txCode":{"type":"string","description":"Transaction code required to accept the credential offer."}},"required":["userId","offerUri","txCode"]},"AcceptOfferResponse":{"type":"object","properties":{"id":{"type":"string","description":"Credential unique ID"},"payload":{"type":"string","description":"Raw payload of the issued credential."}},"required":["id","payload"]}}},"paths":{"/api/v1/oid4vci/offers/auto-accept":{"post":{"description":"Accept Credential Offer automatically. Receive and store VC as a result","operationId":"Oid4VciController_acceptOfferAuto_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAcceptOfferRequest"}}}},"responses":{"201":{"description":"When Offer is accepted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptOfferResponse"}}}},"400":{"description":"- When VC issuance has failed\n- When one or more credential definition names could not be successfully parsed."}},"summary":"Accept Credential Offer automatically","tags":["Oid4Vci"]}}}}
```


---

# 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/oid4vci.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.
