> 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-1/trigger-by-user-for-any-wallet-email-tx_code-delivery/method-1-api.md).

# Method 1: API

Create the Offer, have the code emailed to the Holder, and share the link yourself

This is the journey that reaches everyone. The Holder needs no account with you and no particular wallet - the `tx_code` travels out of band and they type it in.

**Before you start** you need an [Issuer and VC Schema](/standards/issuance/configuration-issuer-and-vc-schema.md). Nothing else: no IdP registration, no endpoint to host.

### 1. Create the Offer

`POST /api/v1/oid4vci/offers`, as in every pre-authorized journey.

{% 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-1/trigger-by-user-for-any-wallet-email-tx_code-delivery/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"]}}}}
```

Keep `uriId` for step 2 and `byReference` for step 3.

### 2. Get the code to the Holder

On this flow you have a choice, and it decides whether the platform ever sees a contact detail.

{% tabs %}
{% tab title="The platform emails it" %}
`POST /api/v1/oid4vci/offers/{uriId}/delivery` with the Holder's address:

```json
{ "delivery": { "method": "email", "email": "holder@example.com" } }
```

The platform sends the code and returns `txCodeResendUrl` and `txCodeResendCooldown`, so you can offer a resend. The address is stored encrypted and pruned along with the claim values.
{% endtab %}

{% tab title="You deliver it" %}
The Offer response already contains `txCode`. Send it through whatever channel you own - email, SMS, in-app message, a letter - and make no delivery call at all.

Nothing about the Holder's contact details reaches the platform this way.
{% endtab %}
{% endtabs %}

The code lasts three minutes and can be regenerated.

### 3. Share the Offer

Render `byReference` as a QR code for a mobile wallet, or open it directly for a web wallet. The Offer does **not** appear in Pending Offers on this journey - the link is the only way in.

### 4. 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-1/trigger-by-user-for-any-wallet-email-tx_code-delivery/method-1-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.
