> 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/standards/issuance/flow-3/auto-issuance/api.md).

# API

Trigger an auto-issuance Offer that carries no claim values at all

The same single call as [Flow 1](/standards/issuance/flow-1/auto-issuance/method-1-api.md), with the claim values taken out. The platform creates the Offer, and comes back to your Attribute Provider only when the Holder accepts.

{% hint style="warning" %}
**Work in progress.** The Issuance API for this flow is still being built. The EQUS Wallet side is ready. Check with us before building against it.
{% endhint %}

**Before you start** you need an [Issuer and VC Schema](/standards/issuance/configuration-issuer-and-vc-schema.md), your identity provider registered (see [Bring Your Own IdP](/standards/onboarding/bring-your-own-idp.md)), and an [Attribute Provider](/standards/issuance/configuration-attribute-provider.md) endpoint. The Holder has to be signed in to an EQUS Wallet as one of your users.

### Create the Offer

`POST /api/v1/oid4vci/offers` with a Schema version, an Issuer, your own user ID, and `autoIssuance` - and **no `claims`**.

{% hint style="info" icon="rectangle-api" %}
All calls mentioned on this page are on the [Integration API](https://docs.toolkit.equs.ai/standards/issuance/flow-3/auto-issuance/pages/MvAvsnLQU3ER2hOIIDU2#id-2.4.1-apis).
{% endhint %}

## Create Credential Offer

> Create Credential Offer with provided claims based on VC Schema Version and Issuer. Optionally, intended User ID can be provided

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Integration API 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":{"CreateCredentialOfferRequest":{"type":"object","properties":{"vcSchemaVersionId":{"type":"string","description":"VC schema version unique ID"},"claims":{"type":"object","description":"Claims to include in the issued credential."},"issuerId":{"type":"string","description":"Issuer unique ID"},"userId":{"type":"string","description":"User unique ID"},"autoIssuance":{"description":"When provided, the offer is automatically bound and issued to the given holder.","allOf":[{"$ref":"#/components/schemas/AutoIssuance"}]}},"required":["vcSchemaVersionId","claims","issuerId","userId"]},"AutoIssuance":{"type":"object","properties":{"email":{"type":"string","description":"Email address the offer notification is sent to when auto-issuance completes."}},"required":["email"]},"CreateCredentialOfferResponse":{"type":"object","properties":{"params":{"description":"OID4VCI credential offer parameters.","allOf":[{"$ref":"#/components/schemas/OfferParams"}]},"byValue":{"type":"string","description":"Credential offer deep link encoding the offer payload by value."},"byReference":{"type":"string","description":"Credential offer deep link referencing the offer by URI."},"txCode":{"type":"string","description":"Transaction code the holder must input to accept the offer."},"uriId":{"type":"string","description":"Credential offer URI unique ID"}},"required":["params","byValue","byReference","txCode","uriId"]},"OfferParams":{"type":"object","properties":{"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"}},"grants":{"description":"Grants supported for redeeming this credential offer.","allOf":[{"$ref":"#/components/schemas/OfferGrants"}]}},"required":["credential_issuer","credential_configuration_ids"]},"OfferGrants":{"type":"object","properties":{"urn:ietf:params:oauth:grant-type:pre-authorized_code":{"description":"Pre-authorized code grant details.","allOf":[{"$ref":"#/components/schemas/OfferGrantPreAuth"}]}}},"OfferGrantPreAuth":{"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/PreAuthTxCode"}]},"authorization_server":{"type":"string","description":"Identifier of the authorization server issuing the pre-authorized code grant."}},"required":["pre-authorized_code"]},"PreAuthTxCode":{"type":"object","properties":{"input_mode":{"type":"string","description":"Format expected for the user-entered transaction code."},"length":{"type":"number","description":"Expected length of the transaction code."},"description":{"type":"string","description":"Human-readable guidance shown to the user for entering the transaction code."}}}}},"paths":{"/api/v1/oid4vci/offers":{"post":{"description":"Create Credential Offer with provided claims based on VC Schema Version and Issuer. Optionally, intended User ID can be provided","operationId":"Oid4VciController_createCredentialOffer_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialOfferRequest"}}}},"responses":{"200":{"description":"When Offer is created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialOfferResponse"}}}},"400":{"description":"- When no VC Schema Version exists with such id.\n- When no Issuer exists with such id.\n- When the Credentials don't match the schema."}},"summary":"Create Credential Offer","tags":["Oid4Vci"]}}}}
```

As in Flow 1, `autoIssuance` settles delivery, so there is no second call and no link to share. The Offer appears in the Holder's Pending Offers, announced by email and a push notification.

### What the platform stores

The Offer and its `tx_code`, and nothing personal. The notification address is used and not kept. When the Holder accepts, your Attribute Provider is called, the claim values are used to sign the credential, and they are discarded within the request - see [Personal Data and Encryption](/standards/security-and-privacy/personal-data-and-encryption.md).

That is the whole point of this flow: Flow 1's trigger model and Holder experience, with none of Flow 1's bounded window of stored claim values.

### Track the result

See [Issuance Results](/standards/issuance/issuance-results.md).


---

# 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/standards/issuance/flow-3/auto-issuance/api.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.