> For the complete documentation index, see [llms.txt](https://docs.empe.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.empe.io/develop/wallet-server/api-reference/models.md).

# Models

## The DidMethodDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"DidMethodDto":{"type":"object","properties":{"method":{"type":"string","description":"The DID method to resolve.","enum":["empe","empe-testnet","web"]}},"required":["method"]}}}}
```

## The GenerateDidRequestDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"GenerateDidRequestDto":{"type":"object","properties":{"methods":{"description":"DID method which will be used for generate DID documents","type":"array","items":{"type":"string"}}},"required":["methods"]}}}}
```

## The DocumentObjectDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"DocumentObjectDto":{"type":"object","properties":{"@context":{"type":"string","description":"JSON-LD context for the DID document"},"id":{"type":"string","description":"The DID"},"controller":{"type":"string","description":"The controller of the DID document"},"verificationMethod":{"type":"object","description":"The verification methods associated with the DID document"},"authentication":{"description":"Authentication methods for the DID document","type":"array","items":{"type":"string"}},"assertionMethod":{"description":"Assertion methods for the DID document","type":"array","items":{"type":"string"}},"capabilityInvocation":{"description":"Capability invocation methods","type":"array","items":{"type":"string"}},"capabilityDelegation":{"description":"Capability delegation methods","type":"array","items":{"type":"string"}},"keyAgreement":{"description":"Key agreement methods","type":"array","items":{"type":"string"}},"service":{"description":"Services associated with the DID document","type":"array","items":{"type":"string"}},"alsoKnownAs":{"description":"Alternative identifiers for the DID","type":"array","items":{"type":"string"}}},"required":["@context","id","controller","verificationMethod","authentication","assertionMethod","service"]}}}}
```

## The ImportDidRequestDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ImportDidRequestDto":{"type":"object","properties":{"methods":{"description":"DID method which will be used for generate DID documents","type":"array","items":{"type":"string"}},"mnemonics":{"type":"string","description":"Mnemonic phrase used to restore the DID(s)."}},"required":["methods","mnemonics"]}}}}
```

## The IssuerObjectDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"IssuerObjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Issuer DID"}},"required":["id"]}}}}
```

## The IssuerStringDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"IssuerStringDto":{"type":"object","properties":{"value":{"type":"string","description":"Issuer DID"}},"required":["value"]}}}}
```

## The CredentialSubjectDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"CredentialSubjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"_":{"type":"object","description":"Additional subject claims","additionalProperties":true}},"required":["_"]}}}}
```

## The ProofDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ProofDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]}}}}
```

## The CredentialSchemaDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"CredentialSchemaDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"]}}}}
```

## The CredentialStatusEntryDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"CredentialStatusEntryDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]}}}}
```

## The FreeFormObjectDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"FreeFormObjectDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]}}}}
```

## The VerifiableCredentialDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"VerifiableCredentialDto":{"type":"object","properties":{"@context":{"description":"JSON-LD @context","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"type":{"description":"Credential types","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Credential ID (URI)"},"issuer":{"description":"Issuer (DID or object with id)","oneOf":[{"$ref":"#/components/schemas/IssuerObjectDto"},{"$ref":"#/components/schemas/IssuerStringDto"}]},"issuanceDate":{"type":"string","description":"Issuance date"},"credentialSubject":{"description":"Credential subject(s)","oneOf":[{"$ref":"#/components/schemas/CredentialSubjectDto"},{"type":"array","items":{"$ref":"#/components/schemas/CredentialSubjectDto"}}]},"proof":{"description":"Proof","oneOf":[{"$ref":"#/components/schemas/ProofDto"}]},"expirationDate":{"type":"string","description":"Expiration date"},"credentialSchema":{"description":"Credential schema","oneOf":[{"$ref":"#/components/schemas/CredentialSchemaDto"}],"allOf":[{"$ref":"#/components/schemas/CredentialSchemaDto"}]},"credentialStatus":{"type":"array","description":"Credential status entries","items":{"$ref":"#/components/schemas/CredentialStatusEntryDto"}},"evidence":{"description":"Additional evidence","oneOf":[{"$ref":"#/components/schemas/FreeFormObjectDto"}]},"_ext":{"type":"object","additionalProperties":true}},"required":["@context","type","id","issuer","issuanceDate","credentialSubject"]},"IssuerObjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Issuer DID"}},"required":["id"]},"IssuerStringDto":{"type":"object","properties":{"value":{"type":"string","description":"Issuer DID"}},"required":["value"]},"CredentialSubjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"_":{"type":"object","description":"Additional subject claims","additionalProperties":true}},"required":["_"]},"ProofDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]},"CredentialSchemaDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"]},"CredentialStatusEntryDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]},"FreeFormObjectDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]}}}}
```

## The ImportCredentialDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ImportCredentialDto":{"type":"object","properties":{"credential":{"description":"Credential to import","oneOf":[{"$ref":"#/components/schemas/VerifiableCredentialDto"}],"allOf":[{"$ref":"#/components/schemas/VerifiableCredentialDto"}]},"allowForeignSubject":{"type":"boolean","description":"If allowForeignSubject is true allow any credential. If false (default) check if credential has subject Id, if it has it must match one of active DIDs of the wallet","default":false}},"required":["credential","allowForeignSubject"]},"VerifiableCredentialDto":{"type":"object","properties":{"@context":{"description":"JSON-LD @context","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"type":{"description":"Credential types","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Credential ID (URI)"},"issuer":{"description":"Issuer (DID or object with id)","oneOf":[{"$ref":"#/components/schemas/IssuerObjectDto"},{"$ref":"#/components/schemas/IssuerStringDto"}]},"issuanceDate":{"type":"string","description":"Issuance date"},"credentialSubject":{"description":"Credential subject(s)","oneOf":[{"$ref":"#/components/schemas/CredentialSubjectDto"},{"type":"array","items":{"$ref":"#/components/schemas/CredentialSubjectDto"}}]},"proof":{"description":"Proof","oneOf":[{"$ref":"#/components/schemas/ProofDto"}]},"expirationDate":{"type":"string","description":"Expiration date"},"credentialSchema":{"description":"Credential schema","oneOf":[{"$ref":"#/components/schemas/CredentialSchemaDto"}],"allOf":[{"$ref":"#/components/schemas/CredentialSchemaDto"}]},"credentialStatus":{"type":"array","description":"Credential status entries","items":{"$ref":"#/components/schemas/CredentialStatusEntryDto"}},"evidence":{"description":"Additional evidence","oneOf":[{"$ref":"#/components/schemas/FreeFormObjectDto"}]},"_ext":{"type":"object","additionalProperties":true}},"required":["@context","type","id","issuer","issuanceDate","credentialSubject"]},"IssuerObjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Issuer DID"}},"required":["id"]},"IssuerStringDto":{"type":"object","properties":{"value":{"type":"string","description":"Issuer DID"}},"required":["value"]},"CredentialSubjectDto":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"_":{"type":"object","description":"Additional subject claims","additionalProperties":true}},"required":["_"]},"ProofDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]},"CredentialSchemaDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"]},"CredentialStatusEntryDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]},"FreeFormObjectDto":{"type":"object","properties":{"_":{"type":"object","additionalProperties":true}},"required":["_"]}}}}
```

## The ImportCredentialResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ImportCredentialResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Credential identifier"}},"required":["id"]}}}}
```

## The GetCredentialsResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"GetCredentialsResponseDto":{"type":"object","properties":{"credentials":{"description":"Array of verifiable credentials","type":"array","items":{"type":"string"}}},"required":["credentials"]}}}}
```

## The GetCredentialResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"GetCredentialResponseDto":{"type":"object","properties":{"credential":{"type":"object","description":"Verifiable credential"}},"required":["credential"]}}}}
```

## The ProcessQrContentDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ProcessQrContentDto":{"type":"object","properties":{"qrContent":{"type":"string","description":"QR code content (URL) to process"},"did":{"type":"string","description":"Did of the holder"}},"required":["qrContent","did"]}}}}
```

## The CredentialSubjectExample object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]}}}}
```

## The OfferingExample object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"OfferingExample":{"type":"object","properties":{"credential_type":{"type":"string"},"credential_subject":{"$ref":"#/components/schemas/CredentialSubjectExample"}},"required":["credential_type","credential_subject"]},"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]}}}}
```

## The ClaimResponseData object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ClaimResponseData":{"type":"object","properties":{"processId":{"type":"object","description":"Unique identifier for the credential claim process","nullable":true},"status":{"type":"string","description":"Status of the claim process","enum":["initialized","confirmed","failed","expired"]},"offering":{"description":"Credential offering data","nullable":true,"allOf":[{"$ref":"#/components/schemas/OfferingExample"}]},"errorMessage":{"type":"string","description":"Error message - only available if status is failed"}},"required":["processId","status"]},"OfferingExample":{"type":"object","properties":{"credential_type":{"type":"string"},"credential_subject":{"$ref":"#/components/schemas/CredentialSubjectExample"}},"required":["credential_type","credential_subject"]},"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]}}}}
```

## The IssuerExample object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"IssuerExample":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}
```

## The VerifiableCredentialExample object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"VerifiableCredentialExample":{"type":"object","properties":{"@context":{"description":"Credential context","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Credential ID"},"type":{"description":"Credential types","type":"array","items":{"type":"string"}},"issuer":{"description":"Issuer information","allOf":[{"$ref":"#/components/schemas/IssuerExample"}]},"issuanceDate":{"type":"string","description":"Issuance date of the credential"},"credentialSubject":{"description":"Subject data of the credential","allOf":[{"$ref":"#/components/schemas/CredentialSubjectExample"}]}},"required":["@context","id","type","issuer","issuanceDate","credentialSubject"]},"IssuerExample":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]}}}}
```

## The PresentationResponseData object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"PresentationResponseData":{"type":"object","properties":{"processId":{"type":"object","description":"Unique identifier for the credential presentation process","nullable":true},"matchingCredentialIds":{"description":"Matching credential IDs - only available after the credential has been issued","type":"array","items":{"type":"string"}},"matchingCredentials":{"description":"Matching credentials - only available after the credential has been issued","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/VerifiableCredentialExample"}},"status":{"type":"string","description":"Status of the presentation process","enum":["initialized","confirmed","failed","expired"]},"errorMessage":{"type":"string","description":"Error message - only available if status is failed"}},"required":["processId","matchingCredentialIds","status"]},"VerifiableCredentialExample":{"type":"object","properties":{"@context":{"description":"Credential context","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Credential ID"},"type":{"description":"Credential types","type":"array","items":{"type":"string"}},"issuer":{"description":"Issuer information","allOf":[{"$ref":"#/components/schemas/IssuerExample"}]},"issuanceDate":{"type":"string","description":"Issuance date of the credential"},"credentialSubject":{"description":"Subject data of the credential","allOf":[{"$ref":"#/components/schemas/CredentialSubjectExample"}]}},"required":["@context","id","type","issuer","issuanceDate","credentialSubject"]},"IssuerExample":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]}}}}
```

## The ProcessQrContentResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ProcessQrContentResponseDto":{"type":"object","properties":{"flowType":{"type":"string","description":"Type of the flow (claim or presentation)","enum":["claim","presentation"]},"data":{"description":"Result of the process","oneOf":[{"$ref":"#/components/schemas/ClaimResponseData"},{"$ref":"#/components/schemas/PresentationResponseData"},{"type":"boolean"}]}},"required":["flowType","data"]},"ClaimResponseData":{"type":"object","properties":{"processId":{"type":"object","description":"Unique identifier for the credential claim process","nullable":true},"status":{"type":"string","description":"Status of the claim process","enum":["initialized","confirmed","failed","expired"]},"offering":{"description":"Credential offering data","nullable":true,"allOf":[{"$ref":"#/components/schemas/OfferingExample"}]},"errorMessage":{"type":"string","description":"Error message - only available if status is failed"}},"required":["processId","status"]},"OfferingExample":{"type":"object","properties":{"credential_type":{"type":"string"},"credential_subject":{"$ref":"#/components/schemas/CredentialSubjectExample"}},"required":["credential_type","credential_subject"]},"CredentialSubjectExample":{"type":"object","properties":{"ticket":{"type":"string"},"seat":{"type":"string"},"description":{"type":"string"}},"required":["ticket","seat","description"]},"PresentationResponseData":{"type":"object","properties":{"processId":{"type":"object","description":"Unique identifier for the credential presentation process","nullable":true},"matchingCredentialIds":{"description":"Matching credential IDs - only available after the credential has been issued","type":"array","items":{"type":"string"}},"matchingCredentials":{"description":"Matching credentials - only available after the credential has been issued","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/VerifiableCredentialExample"}},"status":{"type":"string","description":"Status of the presentation process","enum":["initialized","confirmed","failed","expired"]},"errorMessage":{"type":"string","description":"Error message - only available if status is failed"}},"required":["processId","matchingCredentialIds","status"]},"VerifiableCredentialExample":{"type":"object","properties":{"@context":{"description":"Credential context","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Credential ID"},"type":{"description":"Credential types","type":"array","items":{"type":"string"}},"issuer":{"description":"Issuer information","allOf":[{"$ref":"#/components/schemas/IssuerExample"}]},"issuanceDate":{"type":"string","description":"Issuance date of the credential"},"credentialSubject":{"description":"Subject data of the credential","allOf":[{"$ref":"#/components/schemas/CredentialSubjectExample"}]}},"required":["@context","id","type","issuer","issuanceDate","credentialSubject"]},"IssuerExample":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}
```

## The ConfirmProcessDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ConfirmProcessDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of flow (claim or presentation)","enum":["claim","presentation"]},"selectedCredential":{"type":"object","description":"Complete credential object for testing and validation"}},"required":["type","selectedCredential"]}}}}
```

## The VerifierErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"VerifierErrorResponse":{"type":"object","properties":{"name":{"type":"string","description":"Error type name"},"value":{"type":"string","description":"Error value or code"},"field":{"type":"string","description":"Field that caused the error, if applicable"},"message":{"type":"string","description":"Detailed error message"}},"required":["name","value","field","message"]}}}}
```

## The ConfirmProcessResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Wallet API","version":"1.0"},"components":{"schemas":{"ConfirmProcessResponseDto":{"type":"object","properties":{"status":{"type":"string","description":"Status of the confirmation","enum":["initialized","confirmed","failed","expired"]},"message":{"type":"string","description":"Message about the confirmation result"},"data":{"description":"Optional data field that contains additional information, such as detailed error data","allOf":[{"$ref":"#/components/schemas/VerifierErrorResponse"}]}},"required":["status","message"]},"VerifierErrorResponse":{"type":"object","properties":{"name":{"type":"string","description":"Error type name"},"value":{"type":"string","description":"Error value or code"},"field":{"type":"string","description":"Field that caused the error, if applicable"},"message":{"type":"string","description":"Detailed error message"}},"required":["name","value","field","message"]}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.empe.io/develop/wallet-server/api-reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.