194:T42b,JWT generated by the Client Attester (Backend) attesting to a validated Client Instance and bound to a key managed by the Client Instance, ensuring proof of possession. Client Attestation support is currently offered as a **tech preview**. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice. **When to use:** - When client attestation is configured for this client_id **Header:** - `alg`: Must be `ES256` - `typ`: Must be `oauth-client-attestation+jwt` - `x5c`: Must be an array of base64 encoded X509 End-Entity certificates bound to the configured client attestation root certificate. **Payload:** - `sub`: OAuth client_id matching the request - `client_instance_id`: Optional identifier to represent the client/app instance. - `iat`: Unix timestamp when the token was created - `exp`: Unix timestamp when the token will expire - `cnf.jwk`: JWK public key from the client instance that the authorization server uses to verify the signature of subsequent DPoP or PoP proofs. 195:T5e3,Issues a credential to a holder upon presentation of a valid access token, as per [OID4VCI](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint). Supports [encrypted](/docs/issuance/credential-issuance/e2e-encryption) and non-encrypted credential issuance. Encrypted credential issuance is currently in technical preview and must be enabled on a per-tenant basis. If you would like to enable this feature for your tenant, please [contact us](mailto:dev-support@mattr.global). For non-encrypted credential issuance the valid access token must be provided in one of the following header formats: **Bearer** - Authorization: `Bearer `. - Content-Type: `application/json` - Body: `` OR **DPoP** Only required when using DPoP-bound access tokens. - Authorization: `DPoP `. - DPoP: `` - Content-Type: `application/json` - Body: `` For encrypted credential issuance, [contact us](mailto:dev-support@mattr.global) to configure how your MATTR VII enforces request and/or response encryption, and then: - For **request** encryption, `Content-Type` must be set to `application/jwt` and the payload must be JWE formatted. - For **response** encryption, include the [`credential_response_encryption`](/docs/issuance/credential-issuance/e2e-encryption#encryption-key-provisioning) property in the raw request payload to specify encryption details.196:T405,Generate a new [OID4VCI Pre-Authorized Code](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-4.1) credential offer. This offer can only be used once. Once the offer is successfully claimed and the credential is issued, the pre-authorized code is consumed and the offer becomes invalid. The offer cannot be claimed again, even if the same user attempts to claim it. This is a security measure to prevent unauthorized credential duplication. If you need to issue another credential to the same user, you must generate a new credential offer. The Pre-authorized Code flow is only supported for the mDocs credential format. The total size of the request cannot exceed 500KB, including any claims. This is mostly relevant when including large claims such as images. When holders present credentials over Bluetooth Low Energy (BLE), keep payloads as small as practical, as large claims can degrade the transfer experience. Reserve larger payloads for remote presentation flows.197:T4d8,Configure the Interaction Hook for the OID4VCI protocol on your tenant. Many credential issuance journeys require the issuer to perform custom interactions with the user. This could be gathering more information, performing additional authentication steps (E.g, 2FA, MFA or biometric checks) or communicating the terms of service. To facilitate this requirement, you can configure MATTR VII to invoke an interaction hook which will redirect the user to a custom component during the credential issuance journey. This redirect happens **after** the user is authenticated with your configured identity provider but **before** the credential is issued to the user. Upon successful completion of the interaction hook, your custom component will redirect the user back to their digital wallet to complete the credential issuance flow. Your interaction hook component can be either a web or native application.  We recommend using a web interface because it's more compatible with most scenarios. You can only configure one interaction hook on your MATTR VII tenant. If you require several custom interactions as part of the credential issuance workflow, they should all be linked into a single interaction hook component. 198:T49a,Define the key types that will be generated for the created DID: - Supported `keyType` for `did:key` are `Ed25519` and `Bls12381G2`. - If `keyType` is omitted, the default keyType is `Ed25519`. This keytype can be used as a Verifier DID. - If `keyType` is set to `Bls12381G2` the created DID supports BBS+ signatures for creating selective-disclosure enabled credentials. - As `did:key` only support `Ed25519` or `Bls12381G2` key types, you can only use it to create JSON credentials. If you wish to create CWT credentials, create a DID using a keyType of `P-256`, such as `did:web`. - The `Bls12381G2` key type cannot be used as a Verifier DID as it does not support symmetric key signing required to verify messages. Note that keyType is only required for `did:key`, as `did:web`s are automatically created with multiple key types by default: - P-256: This is the default option for signing CWT credentials. - Bls12381G2Key2020: This is the default option for signing JSON credentials. It supports selective-disclosure and key rotation. - Ed25519: Recommended when the `web:did` is used as a Verifier DID, as it supports symmetric key signing required for verifying messages.199:T559,This is where you specify how to map claims (user attributes) into issued credentials. Each field in the object corresponds to a claim in the issued credential, and contains one or more from the following attributes: - `mapFrom`: References the path in the user object where the claim is available. - When using a URL as a claims namespace identifier, use bracket notation to access the claim value (e.g. `mapFrom: "claims['https://example.com/claim-name']"`). - `mapFrom` is optional when `defaultValue` is provided, as the latter will be used for all issued credentials. This is referred to as a **static claim**. - `defaultValue`: Indicates what value is used if required is set to `false` (field is optional) and no value is provided by the claims source. When `defaultValue` is provided, `mapFrom` is optional. - `required`: Indicates whether the claim is required (default: `false`). When a required claim cannot be retrieved and no `defaultValue` is available, credential issuance will fail. **Example `claims` object inside the `user` object** ```json { "claims": { "given_name": "Jamie", "family_name": "Doe", "address": { "formatted": "116-118 Quay Street, Auckland CBD, Auckland 1010" } }, "authenticationProvider": { "subjectId": "6d3aab7d-73af-5f61-b47c-109ef6f7558c", "url": "https://accounts.google.com" } } ``` 19a:T4ec,Used to determine when issued credentials will expire, relative to issuance date: - Ignored if a valid `validUntil` date/time is provided. - Cannot be before the `validFrom` date/time. - If `expiresIn` is used to determine the credential's expiry date and `validFrom` is provided, the expiration date will still be calculated based on the issuance date, not the `validFrom` value. - Can include any combination of years, months, weeks, days, hours, minutes and seconds. - If `type` is set to `org.iso.18013.5.*.mDL` (for issuing an mDL), the maximum validity is 427 days. - For any other `type`, the maximum validity is 3620 days. Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to [IACA selection](/docs/issuance/certificates/overview#certificate-selection) for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the `expiresIn` value exceeds the validity of all currently active IACAs at the time of issuance.19b:T40a,Specifies an explicit date and time from which the credential becomes valid. - Must be mapped from the provided user claims. - Must be formatted as a valid ISO 8601 date/time string. - If not provided, defaults to using the issuance date as the starting point for the credential's validity. - Cannot be after the credential's expiration date/time. - Cannot be before the credential's issuance date/time. Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to [IACA selection](/docs/issuance/certificates/overview#certificate-selection) for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the `validFrom` value exceeds the validity of all currently active IACAs at the time of issuance.19c:T478,Specifies an explicit date and time at which the credential expires. - Must be mapped from the provided user claims. - Must be formatted as a valid ISO 8601 date/time string. - If not provided, the expiration date will be determined based on the `expiresIn` value provided in the credential configuration. - Cannot be before the `validFrom` date/time. - If `type` is set to `org.iso.18013.5.*.mDL` (for issuing an mDL), the maximum validity is 427 days. - For any other `type`, the maximum validity is 3620 days. Credential expiry can never exceed the validity period of the IACA used as the root certificate when signing the credential. However, all validity checks (including those for IACA and credential validity periods) only occur when an individual credential is being signed, not when the generic credential configuration template is created (Refer to [IACA selection](/docs/issuance/certificates/overview#certificate-selection) for more information on how an IACA is selected when signing an mDoc). As a result, issuance will fail if the `validUntil` value exceeds the validity of all currently active IACAs at the time of issuance.19d:T481,Determines whether Key Attestation is required during registration and token renewal. - When `true`, the holder application instance must provide a valid attestation during registration and token renewal, and MATTR VII will verify the attestation to ensure the legitimacy of the request. The attestation must be present, parseable, and trusted (a trusted root with each certificate in the chain signed by the one above it) for registration to succeed. - When `false`, the holder application instance can register and renew tokens using just an authentication assertion without attestation. Note: validation does not check whether the certificates in the attestation chain have expired. Some Android devices, including relatively recent models, generate attestations where part or all of the certificate chain is already past its validity period. To avoid blocking these devices, an otherwise valid attestation with expired certificates is still treated as a successful attestation, even when `required` is `true`. This behavior may be tightened in a future release, so we recommend not relying on certificate expiry as part of your own trust decision. 19e:T4c4,DPoP proof JWT. A signed JWT that demonstrates proof-of-possession of a private key. DPoP is offered as a **closed beta preview** feature and is not generally available yet. If you are interested in trying this feature, please [contact us](mailto:dev-support@mattr.global) **When to use:** - Token endpoint: Required when `dpop_jkt` was provided in the authorization request - Credential endpoint: Required when using DPoP-bound access tokens (Authorization header must use format: `Authorization: DPoP `) The DPoP proof must be a signed JWT with the following structure: **Header:** - `alg`: Must be `ES256` - `typ`: Must be `dpop+jwt` - `jwk`: Public key (JWK format) **Payload:** - `htu`: HTTP URI of the target endpoint - `htm`: HTTP method (e.g., `POST`) - `jti`: Unique identifier for this DPoP proof - `iat`: Unix timestamp when the DPoP proof was created - `ath`: Optional base64url-encoded SHA-256 hash of the `access_token`. Required when authenticating with the resource server. - `htcd`: Optional base64-encoded SHA-256 hash (content digest) of the HTTP request payload used to validate integrity. Each DPoP proof must be unique and cannot be reused across requests. 19f:T486,OAuth-Client-Attestation-PoP proof JWT that demonstrates: - Proof-of-possession of a private key from a wallet instance - Binding to OAuth-Client-Attestation JWT OAuth-Client-Attestation-PoP and client attestation in general are offered as **closed beta preview** features and are not generally available yet. If you are interested in trying this feature, please [contact us](mailto:dev-support@mattr.global) **When to use:** - Token endpoint: When OAuth Client has client attestation enabled with `dpopRequired` set to false. The `OAuth-Client-Attestation-PoP` proof MUST be signed with a wallet instance's private key that corresponds to the `cnf.jwk` claim from the provided `OAuth-Client-Attestation` and must use the following structure: **Header:** - `alg`: Must be `ES256` - `typ`: Must be `oauth-client-attestation-pop+jwt` **Payload:** - `aud`: HTTP Host of the target endpoint - `jti`: Unique identifier for this OAuth-Client-Attestation-PoP proof - `iat`: Unix timestamp when the OAuth-Client-Attestation-PoP proof was created Each OAuth-Client-Attestation-PoP proof must be unique and cannot be reused across requests. 186:["$","$L18f",null,{"full":true,"tableOfContent":{"style":"clerk"},"toc":[],"children":[["$","$L190",null,{"children":"Retrieve an inbox"}],["$","$L191",null,{"children":["$","$L192",null,{"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"MATTR VII Platform API","version":"v12.2.0","description":"$193","contact":{"email":"dev-support@mattr.global"}},"servers":[{"url":"https://{tenantName}.vii.{region}.mattr.global","variables":{"tenantName":{"default":"example","description":"The tenant subdomain assigned when the tenant was established."},"region":{"default":"au01","description":"The tenant region assigned when the tenant was established.","enum":["au01","ca01","eu01","us01"]}}}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Analytics","description":"Specifies paths and operations for retrieving platform analytics data.","kind":"nav"},{"name":"Messaging","description":"Specifies paths and operations for signing, encrypting, decrypting and sending messages.","kind":"nav"},{"name":"Security","description":"Specifies paths and operations for accessing protected endpoints.","kind":"nav"},{"name":"Custom Domain","description":"Specifies paths and operations for managing custom domains.","x-displayName":"Custom domain","kind":"nav"},{"name":"DIDs","description":"Specifies paths and operations for managing DIDs.","kind":"nav"},{"name":"Inboxes","description":"Specifies paths and operations for managing inboxes.","kind":"nav"},{"name":"Webhooks","description":"Specifies paths and operations for managing Webhooks.","kind":"nav"},{"name":"Ecosystems","description":"Specifies paths and operations for managing ecosystems.","kind":"nav"},{"name":"Ecosystem Configuration","description":"Operations for managing Ecosystem configurations for a tenant.","kind":"nav"},{"name":"Participants","description":"Specifies paths and operations for managing ecosystem participants.","kind":"nav"},{"name":"Participants assignment","description":"Operations related to assigning credential types to Participants within an Ecosystem.","kind":"nav"},{"name":"Participants contacts","description":"Operations related to managing contacts for Participants within an Ecosystem.","kind":"nav"},{"name":"Participants evidence","description":"Operations related to managing evidence for Participants within an Ecosystem.","kind":"nav"},{"name":"Participants validation","description":"Operations related to validating Participants within an Ecosystem.","kind":"nav"},{"name":"Participants issuer certificates","description":"Operations related to managing issuer certificates for Participants within an Ecosystem.","kind":"nav"},{"name":"Participants verifier certificates","description":"Operations related to managing verifier certificates for Participants within an Ecosystem.","kind":"nav"},{"name":"Credential types","description":"Specifies paths and operations for managing ecosystem credential types.","kind":"nav"},{"name":"Policy","description":"Specifies paths and operations for publishing and retrieving an ecosystem policy.","kind":"nav"},{"name":"Issuer Policy","description":"Operations related to Ecosystem Issuer Policies.","kind":"nav"},{"name":"Verifier Policy","description":"Operations related to Ecosystem Verifier Policies.","kind":"nav"},{"name":"Issuer assignment","description":"Specifies paths and operations for assigning credential types to issuers."},{"name":"Verifier assignment","description":"Specifies paths and operations for assigning credential types to verifiers."},{"name":"VICAL Configuration","description":"Specifies paths and operations for managing VICAL configuration.","x-displayName":"Configuration","kind":"nav"},{"name":"VICAL","description":"Specifies paths and operations for publishing and retrieving an ecosystem policy as a VICAL.","x-displayName":"General","kind":"nav"},{"name":"CWT credentials issuance","description":"Specifies paths and operations for issuing CWT credentials.","x-displayName":"CWT credentials","kind":"nav"},{"name":"Semantic CWT credentials issuance","description":"Specifies paths and operations for issuing Semantic CWT credentials.","x-displayName":"Semantic CWT credentials","kind":"nav"},{"name":"JSON credentials issuance","description":"Specifies paths and operations for issuing JSON credentials.","x-displayName":"JSON credentials","kind":"nav"},{"name":"mDocs issuance","description":"Specifies paths and operations for issuing mDocs credentials.","x-displayName":"mDocs"},{"name":"CWT credentials management","description":"Specifies paths and operations for managing CWT credentials.","x-displayName":"CWT credentials","kind":"nav"},{"name":"Semantic CWT credentials management","description":"Specifies paths and operations for managing Semantic CWT credentials.","x-displayName":"Semantic CWT credentials","kind":"nav"},{"name":"JSON credentials management","description":"Specifies paths and operations for managing JSON credentials.","x-displayName":"JSON credentials","kind":"nav"},{"name":"mDocs management","description":"Specifies paths and operations for managing mDocs credentials.","x-displayName":"mDocs metadata","kind":"nav"},{"name":"CWT credentials verification","description":"Specifies paths and operations for verifying CWT credentials.","x-displayName":"CWT credentials","kind":"nav"},{"name":"Semantic CWT credentials verification","description":"Specifies paths and operations for verifying Semantic CWT credentials.","x-displayName":"Semantic CWT credentials","kind":"nav"},{"name":"JSON credentials verification","description":"Specifies paths and operations for verifying JSON credentials.","x-displayName":"JSON credentials","kind":"nav"},{"name":"mDocs verification","description":"Specifies paths and operations for verifying mDocs credentials.","x-displayName":"mDocs verification"},{"name":"CWT credentials configuration","description":"Specifies paths and operations for creating CWT credentials configuration.","x-displayName":"CWT credentials","kind":"nav"},{"name":"CWT credentials PDF templates","description":"Specifies paths and operations for managing CWT credentials PDF templates.","x-displayName":"PDF","kind":"nav"},{"name":"CWT credentials Apple Pass templates","description":"Specifies paths and operations for managing CWT credentials Apple Pass templates.","x-displayName":"Apple Pass","kind":"nav"},{"name":"CWT credentials Google Pass templates","description":"Specifies paths and operations for managing CWT credentials Google Pass templates.","x-displayName":"Google Pass","kind":"nav"},{"name":"Semantic CWT credentials configuration","description":"Specifies paths and operations for creating Semantic CWT credentials configuration.","x-displayName":"Semantic CWT credentials","kind":"nav"},{"name":"Semantic CWT credentials PDF templates","description":"Specifies paths and operations for managing Semantic CWT credentials PDF templates.","x-displayName":"PDF","kind":"nav"},{"name":"Semantic CWT credentials Apple Pass templates","description":"Specifies paths and operations for managing Semantic CWT credentials Apple Pass templates.","x-displayName":"Apple Pass","kind":"nav"},{"name":"Semantic CWT credentials Google Pass templates","description":"Specifies paths and operations for managing Semantic CWT credentials Google Pass templates.","x-displayName":"Google Pass","kind":"nav"},{"name":"JSON credentials configuration","description":"Specifies paths and operations for managing JSON credentials configuration.","x-displayName":"JSON credentials","kind":"nav"},{"name":"mDoc credentials configuration","description":"Specifies paths and operations for managing mDocs credentials configuration.","x-displayName":"mDocs","kind":"nav"},{"name":"IACA","description":"Specifies paths and operations for managing IACAs.","kind":"nav"},{"name":"Document Signers","description":"Specifies paths and operations for managing Document Signers.","x-displayName":"Document signers","kind":"nav"},{"name":"Authentication Provider","description":"Specifies paths and operations for managing Authentication providers for OID4VCI workflows.","x-displayName":"Authentication provider","kind":"nav"},{"name":"Interaction Hook","description":"Specifies paths and operations for managing Interaction hooks for OID4VCI workflows.","x-displayName":"Interaction hook","kind":"nav"},{"name":"Claims Source","description":"Specifies paths and operations for managing Claim sources for OID4VCI workflows.","x-displayName":"Claims source","kind":"nav"},{"name":"Credential offers","description":"Specifies paths and operations for creating and managing credential offers as part of an OID4VCI workflow.","kind":"nav"},{"name":"Credential issuance","description":"Specifies paths and operations for issuing credentials as part of an OID4VCI workflow.","x-displayName":"Issuance","kind":"nav"},{"name":"Issuer metadata","description":"Specifies paths and operations for retrieving issuer metadata for OID4VCI workflows.","kind":"nav"},{"name":"Users","description":"Specifies paths and operations for managing users as part of OID4VCI workflows.","kind":"nav"},{"name":"Document signers","description":"Specifies paths and operations for managing document signers."},{"name":"Status list signers","description":"Specifies paths and operations for managing status list signers.","kind":"nav"},{"name":"Status list configuration","description":"Specifies paths and operations for managing status list configuration.","kind":"nav"},{"name":"Status list retrieval","description":"Specifies paths and operations for retrieving status lists.","kind":"nav"},{"name":"Identifier list retrieval","description":"Specifies paths and operations for retrieving identifier lists.","kind":"nav"},{"name":"mDocs status","description":"Specifies paths and operations for managing mDocs status.","kind":"nav"},{"name":"Trusted issuers","description":"Specifies paths and operations for managing trusted issuers for mDocs verification.","kind":"nav"},{"name":"Holder applications","description":"Specifies paths and operations for managing Holder applications.","kind":"nav"},{"name":"Verifier root CA certificates","description":"Specifies paths and operations for managing Verifier root CA certificates for mDocs verification.","kind":"nav"},{"name":"Verifier applications","description":"Specifies paths and operations for managing Verifier applications for mDocs verification.","kind":"nav"},{"name":"Wallet providers","description":"Specifies paths and operations for managing Wallet providers for mDocs verification.","kind":"nav"},{"name":"Apple Identity Access certificates","description":"Specifies paths and operations for managing Apple Identity Access certificates for mDocs verification.","kind":"nav"},{"name":"mDocs presentation sessions","description":"Specifies paths and operations for managing mDocs presentation sessions.","x-displayName":"Presentation sessions","kind":"nav"},{"name":"DTS root CA certificates","description":"Specifies paths and operations for managing DTS root CA certificates.","x-displayName":"Certificates","kind":"nav"},{"name":"DTS intermediate CA certificates","description":"Specifies paths and operations for managing DTS intermediate CA certificates. These are only relevant when using the 3-tier certificate model. For an explanation of the 2-tier and 3-tier models, refer to the [DTS certificates overview](https://learn.mattr.global/docs/digital-trust-service/certificates-overview#certificate-models-2-tier-and-3-tier).","x-displayName":"Intermediate certificates","kind":"nav"},{"name":"VICAL signers","description":"Specifies paths and operations for managing VICAL signers.","x-displayName":"Signers","kind":"nav"},{"name":"RICAL","description":"Specifies paths and operations for publishing and retrieving a trusted list of verifiers (a RICAL) derived from an ecosystem policy.","x-displayName":"General","kind":"nav"},{"name":"RICAL Configuration","description":"Specifies paths and operations for managing RICAL configuration.","x-displayName":"Configuration","kind":"nav"},{"name":"RICAL signers","description":"Specifies paths and operations for managing RICAL signers.","x-displayName":"Signers","kind":"nav"},{"name":"Verification request signers","description":"Specifies paths and operations for managing Verification request signers.","kind":"nav"},{"name":"Holder root CA certificates","description":"Specifies paths and operations for managing holder root CA certificates used to issue wallet attestation signers.","kind":"nav"},{"name":"Wallet attestation signers","description":"Specifies paths and operations for managing wallet attestation signer certificates used to sign wallet attestation JWTs.","kind":"nav"}],"paths":{"/v1/config/domain":{"post":{"operationId":"createCustomDomain","tags":["Custom Domain"],"summary":"Configure custom domain","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Creates a custom domain configuration on your tenant. You can configure a custom domain for a specific MATTR VII tenant to represent your brand and instil trust with your end-users. Any MATTR VII tenant can only have one custom domain. Refer to our [docs](https://learn.mattr.global/docs/platform-management/custom-domain-overview) for more information.","requestBody":{"description":"The custom domain payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomDomain"},"examples":{"Create a Custom Domain":{"value":{"name":"Example Corp","logoUrl":"https://cdn.example.com/logo.jpg","domain":"example.com"}}}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreateCustomDomain"},"examples":{}}}},"responses":{"201":{"description":"Custom domain created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomainResponse"},"examples":{"Created":{"value":{"name":"Example Corp","logoUrl":"https://cdn.example.com/logo.jpg","domain":"example.com","verificationToken":"8c6f36c1-91ff-439d-a518-48cf7ef421ef","isVerified":false}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CONFIG_CUSTOM_DOMAIN_CREATE_START","CONFIG_CUSTOM_DOMAIN_CREATE_SUCCESS","CONFIG_CUSTOM_DOMAIN_CREATE_FAIL"]},"get":{"operationId":"retrieveCustomDomain","tags":["Custom Domain"],"summary":"Retrieve custom domain","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Returns your tenant's custom domain configuration and its verification status.","responses":{"200":{"description":"Custom domain returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomainResponse"},"examples":{"Retrieve Domain":{"value":{"name":"Example Corp","logoUrl":"https://cdn.example.com/logo.icon","domain":"example.com","verificationToken":"8c6f36c1-91ff-439d-a518-48cf7ef421ef","isVerified":true,"verifiedAt":"2024-01-31T20:31:48.340Z"}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CONFIG_CUSTOM_DOMAIN_RETRIEVE_START","CONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESS","CONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL"]},"delete":{"operationId":"removeCustomDomain","tags":["Custom Domain"],"summary":"Delete custom domain","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Deletes the custom domain configuration on your tenant.\n\n\nDeleting your custom domain configuration breaks the linkage with any credentials issued under the custom domain. These credentials will no longer be valid.\n","responses":{"204":{"description":"Custom domain deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CONFIG_CUSTOM_DOMAIN_DELETE_START","CONFIG_CUSTOM_DOMAIN_DELETE_SUCCESS","CONFIG_CUSTOM_DOMAIN_DELETE_FAIL"]},"put":{"summary":"Update custom domain","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"operationId":"updateCustomDomain","tags":["Custom Domain"],"responses":{"200":{"description":"Custom Domain updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomainResponse"},"examples":{"Updated":{"value":{"name":"Example Corp","logoUrl":"https://cdn.example.com/logo.icon","domain":"example.com","verificationToken":"8c6f36c1-91ff-439d-a518-48cf7ef421ef","isVerified":true,"verifiedAt":"2021-04-15T07:37:25.008Z"}}}}}},"404":{"$ref":"#/components/responses/404"}},"description":"Updates the custom domain configuration.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomDomain"},"examples":{"Update a Custom Domain":{"value":{"name":"Example Corp","logoUrl":"https://cdn.example.com/logo.jpg","domain":"example.com"}}}}},"description":""},"x-analytic-events":["CONFIG_CUSTOM_DOMAIN_UPDATE_START","CONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESS","CONFIG_CUSTOM_DOMAIN_UPDATE_FAIL"]},"parameters":[]},"/v1/config/domain/verify":{"post":{"operationId":"verifyCustomDomain","tags":["Custom Domain"],"summary":"Verify custom domain","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Verifies that you have control of the configured custom domain by examining its TXT record.\n\n\nYour custom domain will not be active until you verify it. Refer to [Verify domain ownership](https://learn.mattr.global/docs/platform-management/custom-domain-overview#verify-domain-ownership) for more information.\n","responses":{"204":{"description":"Custom domain verified"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CONFIG_CUSTOM_DOMAIN_VERIFY_START","CONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESS","CONFIG_CUSTOM_DOMAIN_VERIFY_FAIL"]},"parameters":[]},"/.well-known/did-configuration":{"get":{"security":[],"tags":["DIDs"],"summary":"Well known DID configuration","description":"Returns a list of Decentralized Identifier (DID) Configuration entries from the tenant. These are automatically created for **all** DIDS created on a tenant so that they can be used by any party aiming to establish and verify the domain-DID linkage by exposing cryptographic proofs. Thus, this endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party. Refer to [Well Known DID Configuration](https://identity.foundation/.well-known/resources/did-configuration) on the Decentralized Identity Foundation website for more information.\n","responses":{"200":{"description":"List of DID Configuration entries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDidConfigJsonldResponse"},"examples":{"Example":{"value":{"entries":[{"@context":["https://www.w3.org/2018/credentials/v1","https://identity.foundation/.well-known/contexts/did-configuration-v0.2.jsonld"],"type":["VerifiableCredential","DomainLinkageCredential"],"issuer":"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df","issuanceDate":"2023-07-19T00:46:39.327Z","credentialSubject":{"id":"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df","origin":"tenant.vii.mattr.global"},"proof":{"type":"Ed25519Signature2018","created":"2023-07-19T00:46:39Z","verificationMethod":"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df#z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df","proofPurpose":"assertionMethod","jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..jx6VQ_iB80R2GVcqy-hBGHp0A-u-i9ynye7ipb0p4z-4I2ww8tgcut3JadipHUgTS9Qs2YwY2abUsj3045ywDA"}},{"@context":["https://www.w3.org/2018/credentials/v1","https://identity.foundation/.well-known/contexts/did-configuration-v0.2.jsonld"],"type":["VerifiableCredential","DomainLinkageCredential"],"issuer":"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K","issuanceDate":"2023-07-19T00:46:39.328Z","credentialSubject":{"id":"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K","origin":"product-team.platform.staging.mattrlabs.io"},"proof":{"type":"BbsSignature2022","verificationMethod":"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K#zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K","proofPurpose":"assertionMethod","proofValue":"x8AFZpr/CUbwC4qony2g8BpW7hdF+KhM363b0jQ6MI+FFsKzwug92JDdeSXaFaZyCvfhkJrIdDGMAzyLSp9kJqH4B2cqPw2AcEsoNrTqxOEw9ZK7D1LXAkvElUhfmIZLKAmGpA8RNVPUG8Q+a2p49w=="}}]}}}}}}},"operationId":"wellKnownDidConfig"}},"/v1/dids":{"post":{"tags":["DIDs"],"summary":"Create a DID","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Takes a supported [DID method](https://learn.mattr.global/docs/concepts/dids#methods) and returns a new DID with its generated keys and required information. This endpoint also registers the DID Document when applicable.\n\nMATTR VII currently supports creating DIDs of the following methods:\n- **did:key**: The most basic type of DID. The public key forms the DID and has no further data associated with it.\n- **did:web**: This type of DID requires hosting the DID document on a publicly accessible domain in order to make the document and its contents available.","requestBody":{"description":"Options for creating the decentralized identifier","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDidDocument"},"examples":{"Create did:web":{"value":{"method":"web","options":{"url":"learn.vii.au01.mattr.global"}}},"Create did:key":{"value":{"method":"key","options":{"keyType":"Ed25519"}}}}}}},"responses":{"201":{"description":"DID document created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDidResponse"},"examples":{"did:web":{"value":{"did":"did:web:learn.vii.au01.mattr.global","registrationStatus":"COMPLETED","localMetadata":{"keys":[{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#z12KiP7r","kmsKeyId":"96fa6a94-a8cf-4afd-825b-70b46bdb60ee"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","kmsKeyId":"378dfe87-6eba-4779-a402-34ff5b267840"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","kmsKeyId":"a0cba537-ffe1-486d-aedd-6ead80e75519"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","kmsKeyId":"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2"}],"registered":1674421454614,"initialDidDocument":{"@context":["https://w3.org/ns/did/v1","https://w3id.org/security/suites/x25519-2019/v1","https://w3id.org/security/suites/jws-2020/v1","https://w3id.org/security/suites/ed25519-2018/v1","https://w3id.org/security/bbs/v1"],"id":"did:web:learn.vii.au01.mattr.global","verificationMethod":[{"id":"did:web:learn.vii.au01.mattr.global#z12KiP7r","controller":"did:web:learn.vii.au01.mattr.global","type":"JsonWebKey2020","publicKeyJwk":{"kty":"EC","crv":"P-256","x":"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w","y":"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI"}},{"id":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","controller":"did:web:learn.vii.au01.mattr.global","type":"Ed25519VerificationKey2018","publicKeyBase58":"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24"},{"id":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","controller":"did:web:learn.vii.au01.mattr.global","type":"Bls12381G2Key2020","publicKeyBase58":"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB"}],"authentication":["did:web:learn.vii.au01.mattr.global#2vcj3MjR4d"],"assertionMethod":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityDelegation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityInvocation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"keyAgreement":[{"id":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","controller":"did:web:learn.vii.au01.mattr.global","type":"X25519KeyAgreementKey2019","publicKeyBase58":"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7"}]}}}}}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createDid","x-analytic-events":["DID_CREATE_START","DID_CREATE_SUCCESS","DID_CREATE_FAIL"]},"get":{"tags":["DIDs"],"summary":"Retrieve a list of DIDs","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"description":"Returns a list of all DIDs (Decentralized Identifiers) managed by the tenant and their associated meta-data.","responses":{"200":{"description":"A list of DIDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDidsResponse"},"examples":{"Example":{"value":{"data":[{"did":"did:web:learn.vii.au01.mattr.global","localMetadata":{"keys":[{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#z12KiP7r","kmsKeyId":"96fa6a94-a8cf-4afd-825b-70b46bdb60ee"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","kmsKeyId":"378dfe87-6eba-4779-a402-34ff5b267840"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","kmsKeyId":"a0cba537-ffe1-486d-aedd-6ead80e75519"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","kmsKeyId":"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2"}],"registered":1674421454614,"initialDidDocument":{"@context":["https://w3.org/ns/did/v1","https://w3id.org/security/suites/x25519-2019/v1","https://w3id.org/security/suites/jws-2020/v1","https://w3id.org/security/suites/ed25519-2018/v1","https://w3id.org/security/bbs/v1"],"id":"did:web:learn.vii.au01.mattr.global","verificationMethod":[{"id":"did:web:learn.vii.au01.mattr.global#z12KiP7r","controller":"did:web:learn.vii.au01.mattr.global","type":"JsonWebKey2020","publicKeyJwk":{"kty":"EC","crv":"P-256","x":"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w","y":"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI"}},{"id":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","controller":"did:web:learn.vii.au01.mattr.global","type":"Ed25519VerificationKey2018","publicKeyBase58":"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24"},{"id":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","controller":"did:web:learn.vii.au01.mattr.global","type":"Bls12381G2Key2020","publicKeyBase58":"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB"}],"authentication":["did:web:learn.vii.au01.mattr.global#2vcj3MjR4d"],"assertionMethod":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityDelegation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityInvocation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"keyAgreement":[{"id":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","controller":"did:web:learn.vii.au01.mattr.global","type":"X25519KeyAgreementKey2019","publicKeyBase58":"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7"}]}}},{"did":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ","localMetadata":{"keys":[{"kmsKeyId":"2462a440-ef70-413b-8e73-0b2905a73562","didDocumentKeyId":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ"},{"kmsKeyId":"e65e6545-1ba0-4959-8272-db22a46f2e34","didDocumentKeyId":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6LSsfqtdz5mtaGRTZrGwhzK73xDYAtack5AHKcakR1eco7K"}],"registered":1671586060525,"initialDidDocument":{"id":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ","@context":["https://w3.org/ns/did/v1","https://w3id.org/security/suites/x25519-2019/v1","https://w3id.org/security/suites/ed25519-2018/v1"],"verificationMethod":[{"id":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ","type":"Ed25519VerificationKey2018","controller":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ","publicKeyBase58":"Bqf3SpwXEypMQq9txNrURNy1kZXzAPXKVwinChGztncB"}],"keyAgreement":[{"id":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6LSsfqtdz5mtaGRTZrGwhzK73xDYAtack5AHKcakR1eco7K","type":"X25519KeyAgreementKey2019","controller":"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ","publicKeyBase58":"Gzfj7gGuo7YgNBUWR4UMnTjjh2MTv8u1QLtuFxN7uRLZ"}],"authentication":["did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ"],"assertionMethod":["did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ"],"capabilityDelegation":["did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ"],"capabilityInvocation":["did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ"]}}}],"nextCursor":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}}}}}}},"operationId":"retrieveListOfDids","x-analytic-events":["DID_RETRIEVE_LIST_START","DID_RETRIEVE_LIST_SUCCESS","DID_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v1/dids/{id}":{"get":{"tags":["DIDs"],"summary":"Resolve a DID","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"description":"Retrieves a DID and its metadata from the tenant by its URI. This may involve a network call depending on the method involved:\n- For did:key the public key is encapsulated in the DID URI itself.\n- For did:web it must be resolved by accessing the `/.well-known/did.json` path on its domain.","responses":{"200":{"description":"A DID Document and its meta-data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDidResponse"},"examples":{"Example did:web":{"value":{"did":"did:web:learn.vii.au01.mattr.global","registrationStatus":"COMPLETED","localMetadata":{"keys":[{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#z12KiP7r","kmsKeyId":"96fa6a94-a8cf-4afd-825b-70b46bdb60ee"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","kmsKeyId":"378dfe87-6eba-4779-a402-34ff5b267840"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","kmsKeyId":"a0cba537-ffe1-486d-aedd-6ead80e75519"},{"didDocumentKeyId":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","kmsKeyId":"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2"}],"registered":1674421454614,"initialDidDocument":{"@context":["https://w3.org/ns/did/v1","https://w3id.org/security/suites/x25519-2019/v1","https://w3id.org/security/suites/jws-2020/v1","https://w3id.org/security/suites/ed25519-2018/v1","https://w3id.org/security/bbs/v1"],"id":"did:web:learn.vii.au01.mattr.global","verificationMethod":[{"id":"did:web:learn.vii.au01.mattr.global#z12KiP7r","controller":"did:web:learn.vii.au01.mattr.global","type":"JsonWebKey2020","publicKeyJwk":{"kty":"EC","crv":"P-256","x":"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w","y":"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI"}},{"id":"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","controller":"did:web:learn.vii.au01.mattr.global","type":"Ed25519VerificationKey2018","publicKeyBase58":"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24"},{"id":"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi","controller":"did:web:learn.vii.au01.mattr.global","type":"Bls12381G2Key2020","publicKeyBase58":"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB"}],"authentication":["did:web:learn.vii.au01.mattr.global#2vcj3MjR4d"],"assertionMethod":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityDelegation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"capabilityInvocation":["did:web:learn.vii.au01.mattr.global#z12KiP7r","did:web:learn.vii.au01.mattr.global#2vcj3MjR4d","did:web:learn.vii.au01.mattr.global#nCxqyzxHFi"],"keyAgreement":[{"id":"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t","controller":"did:web:learn.vii.au01.mattr.global","type":"X25519KeyAgreementKey2019","publicKeyBase58":"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7"}]}}}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"resolveDid","x-analytic-events":["DID_RETRIEVE_START","DID_RETRIEVE_SUCCESS","DID_RETRIEVE_FAIL"]},"delete":{"description":"Deletes a DID and all associated metadata by providing its URI. This includes all the removal of all associated private keys from the Key Management System (KMS).\n\n\nFor `did:web` you will need to manually remove the `did.json` from your hosted domain.\n","tags":["DIDs"],"summary":"Delete a DID","x-roles":["admin","issuer","verifier","dts-provider","managed-issuer"],"responses":{"204":{"description":"DID successfully deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteDid","x-analytic-events":["DID_DELETE_START","DID_DELETE_SUCCESS","DID_DELETE_FAIL"]},"parameters":[{"name":"id","in":"path","description":"DID","schema":{"type":"string","format":"did","example":"did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9","examples":["did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9"]},"required":true}]},"/v2/credentials/compact/sign":{"post":{"requestBody":{"description":"CWT credential payload to sign","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCompactCredentialRequest"}}}},"tags":["CWT credentials issuance"],"summary":"Sign a CWT credential","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"CWT credential signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCompactCredentialResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"sign-compact-credential","description":"Returns a signed CWT credential generated from a provided valid payload.\n\nThe payload can include any number of custom claims, as CWT credentials do not comply with any specific standard or specification.","x-analytic-events":["CREDENTIAL_COMPACT_SIGN_START","CREDENTIAL_COMPACT_SIGN_SUCCESS","CREDENTIAL_COMPACT_SIGN_FAIL"]}},"/v2/credentials/compact/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Credential ID"}],"delete":{"tags":["CWT credentials management"],"summary":"Delete CWT credential metadata","x-roles":["admin","issuer","managed-issuer"],"responses":{"204":{"description":"Credential metadata deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"removeCompactCredential","description":"Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OID4VCI flow is saved.\n\n\nDeleted metadata cannot be recovered.\n"}},"/v2/credentials/compact/revocation-lists":{"get":{"security":[],"tags":["CWT credentials management"],"description":"Returns a list of all CWT credential revocation lists on the tenant.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","summary":"Retrieve all CWT credential revocation lists","operationId":"compact-credential-revocation-list-discovery","responses":{"200":{"description":"Revocation lists retrieved","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nextCursor":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this Revocation List. You will need it to retrieve this specific list."},"issuer":{"type":"string","description":"Issuer DID for this tenant."},"url":{"type":"string","description":"This is the public URL where this revocation list is available."}}}}}}}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_START","CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_FAIL"]}},"/v2/credentials/compact/revocation-lists/{listId}":{"get":{"security":[],"tags":["CWT credentials management"],"description":"Returns a CWT credential revocation list by providing its ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","summary":"Retrieve CWT credential revocation list","operationId":"compact-credential-revocation-list","responses":{"200":{"description":"Revocation list retrieved","content":{"application/cwt":{"schema":{"type":"string","format":"binary"}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_START","CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"listId","in":"path","required":true,"description":"The unique identifier of the Revocation List you wish to retrieve."}]},"/v2/credentials/compact/{id}/revocation-status":{"post":{"requestBody":{"description":"Update revocation status","required":true,"content":{"application/json":{"schema":{"type":"object","required":["isRevoked"],"properties":{"isRevoked":{"type":"boolean","description":"When set to `true` the credential will be revoked. When set to `false`, the credential will be unrevoked."}}}}}},"tags":["CWT credentials management"],"summary":"Update CWT credential revocation status","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Revocation status updated","content":{"application/json":{"schema":{"type":"object","required":["id","isRevoked"],"properties":{"id":{"type":"string","description":"Unique credential identifier."},"isRevoked":{"type":"boolean","description":"Indicates whether the credential has been revoked (`true`) or not (`false`)."}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"update-revocation-compact-credential","description":"Updates the credential status as revoked (invalid) or unrevoked (valid).","x-analytic-events":["CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_START","CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_SUCCESS","CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_FAIL"]},"get":{"tags":["CWT credentials management"],"summary":"Retrieve CWT credential revocation status","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Revocation status retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"isRevoked":{"type":"boolean","description":"Indicates whether the credential has been revoked (`true`) or not (`false`)."}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"get-revocation-compact-credential","description":"Retrieve the revocation status of a CWT credential by providing its ID."},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Unique credential identifier."}]},"/v2/credentials/compact/verify":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payload"],"properties":{"payload":{"type":"string","description":"The CWT credential to verify, represented as an encoded string.","example":"CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ","examples":["CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ"]},"trustedIssuers":{"type":"array","description":"When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.","items":{"type":"string","example":"did:web:organization.com","examples":["did:web:organization.com"]}},"assertValidFrom":{"type":"boolean","description":"MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.","default":true},"assertValidUntil":{"type":"boolean","description":"MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.","default":true},"checkRevocation":{"type":"boolean","description":"MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.","default":true}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed. \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. "},"trustedIssuers":{"type":"array","description":"When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.","items":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]}},"assertValidFrom":{"type":"boolean","description":"MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.","default":true},"assertValidUntil":{"type":"boolean","description":"MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.","default":true},"checkRevocation":{"type":"boolean","description":"MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.","default":true}},"required":["file"]}}}},"tags":["CWT credentials verification"],"summary":"Verify a CWT credential","x-roles":["admin","verifier"],"responses":{"200":{"description":"Verification completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCompactCredentialResponse"}}}},"400":{"$ref":"#/components/responses/400"},"413":{"description":"Payload Too Large"},"415":{"description":"Unsupported Media Type"}},"operationId":"verify-compact-credential","description":"Verify a CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload structure is a valid CWT credential.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.","x-analytic-events":["CREDENTIAL_COMPACT_VERIFY_START","CREDENTIAL_COMPACT_VERIFY_SUCCESS","CREDENTIAL_COMPACT_VERIFY_FAIL"]}},"/v2/credentials/compact/qrcode":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateQrCodeRequest"}}}},"tags":["CWT credentials issuance"],"operationId":"generateQrCodeCompactCredential","summary":"Format a CWT credential as a QR code","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a QR code representation of a CWT credential from a provided encoded string representation of that credential.","responses":{"200":{"description":"QR code generated","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Payload is not string":{"$ref":"#/components/examples/PayloadNotStringError"},"The payload does not belong to compact credential profile":{"$ref":"#/components/examples/InvalidCompactCredentialError"},"The amount of data is too big to be stored in a QR Code":{"$ref":"#/components/examples/QRCodeTooLargeDataError"},"The generated QR Code is larger than the provided width":{"$ref":"#/components/examples/QRCodeLargerWidthError"}}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_QRCODE_CREATE_START","CREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESS","CREDENTIAL_COMPACT_QRCODE_CREATE_FAIL"]}},"/v2/credentials/compact/configurations":{"post":{"operationId":"createCompactCredentialConfiguration","tags":["CWT credentials configuration"],"summary":"Create a CWT credential configuration","x-roles":["admin","issuer"],"description":"Creates a new CWT credential configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.","requestBody":{"description":"The credential configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialConfigurationRequest"}}}},"responses":{"201":{"description":"CWT credential configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_START","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_FAIL"]},"get":{"operationId":"getCompactCredentialConfigurations","tags":["CWT credentials configuration"],"summary":"Retrieve all CWT credential configurations","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all CWT credential configurations from your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"schema":{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},"in":"query","name":"type","description":"The optional credential type to filter on"}],"responses":{"200":{"description":"CWT credential configurations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialConfigurationsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact/configurations/{id}":{"parameters":[{"name":"id","in":"path","description":"Unique identifier for the CWT credential configuration.","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getCompactCredentialConfiguration","tags":["CWT credentials configuration"],"summary":"Retrieve a CWT credential configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a CWT credential configuration by providing its ID.","responses":{"200":{"description":"CWT credential configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_START","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL"]},"put":{"operationId":"updateCompactCredentialConfiguration","tags":["CWT credentials configuration"],"summary":"Update a CWT credential configuration","x-roles":["admin","issuer"],"description":"Updates an existing CWT credential configuration by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialConfigurationRequest"}}},"description":"Update a CWT credential configuration"},"responses":{"200":{"description":"CWT credential configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_START","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_FAIL"]},"delete":{"operationId":"deleteCompactCredentialConfiguration","tags":["CWT credentials configuration"],"summary":"Delete a CWT credential configuration","x-roles":["admin","issuer"],"description":"Deletes an existing CWT credential configuration by providing its ID.","responses":{"204":{"description":"CWT credential configuration deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_START","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS","CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_FAIL"]}},"/v2/credentials/compact-semantic/sign":{"post":{"requestBody":{"description":"Semantic CWT credential payload to sign","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCompactSemanticCredentialRequest"}}}},"tags":["Semantic CWT credentials issuance"],"summary":"Sign a Semantic CWT credential","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Semantic CWT credential signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignCompactSemanticCredentialResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"signCompactSemanticcredential","description":"Returns a signed Semantic CWT credential generated from a provided valid payload.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_SIGN_START","CREDENTIAL_COMPACT_SEMANTIC_SIGN_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_SIGN_FAIL"]}},"/v2/credentials/compact-semantic/verify":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payload"],"properties":{"payload":{"type":"string","description":"The Semantic CWT credential to verify, represented as an encoded string.","example":"CSS:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFRMFEAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33COZR2G2CAMNXW45DFPB2IC6BGNB2HI4DTHIXS653XO4XHOMZON5ZGOLZSGAYTQL3DOJSWIZLOORUWC3DTF53DCZDUPFYGLALUKZSXE2LGNFQWE3DFINZGKZDFNZ2GSYLMOFRXEZLEMVXHI2LBNRJXKYTKMVRXJILENZQW2ZLEJJXWQ3QH3BAFAW2MIRFQDICFCSNL5EIX4IISCEIFDJRFHCRRLBALWFYDLUVEKXHERNWHUDGJI3DDNNXSFWIRHUASBHGB2I7UHGPZMJEB3SMOFMBL3PABL5HUFSQLLGNE7YRKSAM3OAQN7F4LG365HL67BU","examples":["CSS:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFRMFEAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33COZR2G2CAMNXW45DFPB2IC6BGNB2HI4DTHIXS653XO4XHOMZON5ZGOLZSGAYTQL3DOJSWIZLOORUWC3DTF53DCZDUPFYGLALUKZSXE2LGNFQWE3DFINZGKZDFNZ2GSYLMOFRXEZLEMVXHI2LBNRJXKYTKMVRXJILENZQW2ZLEJJXWQ3QH3BAFAW2MIRFQDICFCSNL5EIX4IISCEIFDJRFHCRRLBALWFYDLUVEKXHERNWHUDGJI3DDNNXSFWIRHUASBHGB2I7UHGPZMJEB3SMOFMBL3PABL5HUFSQLLGNE7YRKSAM3OAQN7F4LG365HL67BU"]},"trustedIssuers":{"type":"array","description":"When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.","items":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]}},"assertValidFrom":{"description":"MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.","type":"boolean","default":true},"assertValidUntil":{"description":"MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.","type":"boolean","default":true},"checkRevocation":{"description":"MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.","type":"boolean","default":true}}}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed. \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. "},"trustedIssuers":{"type":"array","description":"When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.","items":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]}},"assertValidFrom":{"description":"MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.","type":"boolean","default":true},"assertValidUntil":{"description":"MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.","type":"boolean","default":true},"checkRevocation":{"description":"MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.","type":"boolean","default":true}},"required":["file"]}}}},"tags":["Semantic CWT credentials verification"],"summary":"Verify a Semantic CWT credential","x-roles":["admin","verifier"],"responses":{"200":{"description":"Verification completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCompactSemanticCredentialResponse"},"examples":{"Issuer not trusted":{"$ref":"#/components/examples/IssuerNotTrusted"},"Issuer public key invalid":{"$ref":"#/components/examples/IssuerPublicKeyInvalid"},"Signature invalid":{"$ref":"#/components/examples/SignatureInvalid"},"Expired":{"$ref":"#/components/examples/Expired"},"NotActive":{"$ref":"#/components/examples/NotActive"},"Revoked":{"$ref":"#/components/examples/Revoked"}}}}},"400":{"$ref":"#/components/responses/400"},"413":{"description":"Payload Too Large"},"415":{"description":"Unsupported Media Type"}},"operationId":"verifyCompactSemantiCredential","description":"Verify a Semantic CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid Semantic CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload CWT structure and attributes can be validated.\n- Remote context schema can be resolved and validate claims can be dereferenced.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_VERIFY_START","CREDENTIAL_COMPACT_SEMANTIC_VERIFY_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_VERIFY_FAIL"]}},"/v2/credentials/compact-semantic/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Credential ID"}],"delete":{"tags":["Semantic CWT credentials management"],"summary":"Delete Semantic CWT credential metadata","x-roles":["admin","issuer","managed-issuer"],"responses":{"204":{"description":"Credential metadata deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"removeCompactSemanticCredential","description":"Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OID4VCI flow is saved.\n\n\nDeleted metadata cannot be recovered.\n"}},"/v2/credentials/compact-semantic/revocation-lists":{"get":{"security":[],"tags":["Semantic CWT credentials management"],"description":"Returns a list of all Semantic CWT credential revocation lists on the tenant.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","summary":"Retrieve all Semantic CWT credential revocation lists","operationId":"compact-credential-semantic-revocation-list-discovery","responses":{"200":{"description":"Revocation lists retrieved","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nextCursor":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this Revocation List. You will need it to retrieve this specific list."},"issuer":{"type":"string","description":"Issuer DID for this tenant."},"url":{"type":"string","description":"This is the public URL where this revocation list is available."}}}}}}}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_FAIL"]}},"/v2/credentials/compact-semantic/revocation-lists/{listId}":{"get":{"security":[],"tags":["Semantic CWT credentials management"],"description":"Returns a Semantic CWT credential revocation list by providing its ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","summary":"Retrieve Semantic CWT credential revocation list","operationId":"compact-credential-semantic-revocation-list","responses":{"200":{"description":"Revocation list retrieved","content":{"application/cwt":{"schema":{"type":"string","format":"binary"}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"listId","in":"path","required":true,"description":"The unique identifier of the revocation list you wish to retrieve."}]},"/v2/credentials/compact-semantic/{id}/revocation-status":{"post":{"requestBody":{"description":"Update revocation status","required":true,"content":{"application/json":{"schema":{"type":"object","required":["isRevoked"],"properties":{"isRevoked":{"type":"boolean","description":"When set to `true` the credential will be revoked. When set to `false`, the credential will be unrevoked."}}}}}},"tags":["Semantic CWT credentials management"],"summary":"Update Semantic CWT credential revocation status","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Revocation status updated","content":{"application/json":{"schema":{"type":"object","required":["id","isRevoked"],"properties":{"id":{"type":"string","description":"Unique credential identifier."},"isRevoked":{"type":"boolean","description":"Indicates whether the credential has been revoked (`true`) or not (`false`)."}}}}}},"404":{"$ref":"#/components/responses/400"}},"operationId":"update-revocation-compact-credential-semantic","description":"Updates the credential status as revoked (invalid) or unrevoked (valid).","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_START","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_FAIL"]},"get":{"tags":["Semantic CWT credentials management"],"summary":"Retrieve Semantic CWT credential revocation status","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Revocation status retrieved","content":{"application/json":{"schema":{"type":"object","required":["isRevoked"],"properties":{"isRevoked":{"type":"boolean","description":"Indicates whether the credential has been revoked (`true`) or not (`false`)."}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"get-revocation-compact-credential-semantic","description":"Retrieve the revocation status of a Semantic CWT credential by providing its ID."},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Unique credential identifier (`jti`)"}]},"/v2/credentials/compact-semantic/qrcode":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateQrCodeRequest"}}}},"tags":["Semantic CWT credentials issuance"],"operationId":"generateQrCodeCompactSemanticCredential","summary":"Format a Semantic CWT credential as a QR code","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a QR code representation of a Semantic CWT credential from a provided encoded string representation of that credential.","responses":{"200":{"description":"QR code generated","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Payload is not string":{"$ref":"#/components/examples/PayloadNotStringError"},"The payload does not belong to compact semantic credential profile":{"$ref":"#/components/examples/InvalidCompactSemanticCredentialError"},"The amount of data is too big to be stored in a QR Code":{"$ref":"#/components/examples/QRCodeTooLargeDataError"},"The generated QR Code is larger than the provided width":{"$ref":"#/components/examples/QRCodeLargerWidthError"}}}}}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/configurations":{"post":{"operationId":"createCompactSemanticCredentialConfiguration","tags":["Semantic CWT credentials configuration"],"summary":"Create a Semantic CWT credentials configuration","x-roles":["admin","issuer"],"description":"Creates a new Semantic CWT credentials configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.","requestBody":{"description":"The Credential Configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationRequest"}}}},"responses":{"201":{"description":"Credential configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL"]},"get":{"operationId":"getCompactSemanticCredentialConfigurations","tags":["Semantic CWT credentials configuration"],"summary":"Retrieve all Semantic CWT credentials configurations","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all Compact Semantic Credential configurations from your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"schema":{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},"in":"query","name":"type","description":"The optional credential type to filter on"}],"responses":{"200":{"description":"Semantic CWT credentials configurations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompactSemanticCredentialConfigurationsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/configurations/{id}":{"parameters":[{"name":"id","in":"path","description":"Unique identifier for the Semantic CWT credentials configuration.","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getCompactSemanticCredentialConfiguration","tags":["Semantic CWT credentials configuration"],"summary":"Retrieve a Semantic CWT credentials configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a Semantic CWT credentials configuration by providing its ID.","responses":{"200":{"description":"Semantic CWT credentials configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL"]},"put":{"operationId":"updateCompactSemanticCredentialConfiguration","tags":["Semantic CWT credentials configuration"],"summary":"Update a Semantic CWT credentials configuration","x-roles":["admin","issuer"],"description":"Updates an existing Semantic CWT credentials configuration by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationRequest"}}},"description":"Update a Credential Configuration"},"responses":{"200":{"description":"Semantic CWT credentials configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL"]},"delete":{"operationId":"deleteCompactSemanticCredentialConfiguration","tags":["Semantic CWT credentials configuration"],"summary":"Delete a Semantic CWT credentials configuration","x-roles":["admin","issuer"],"description":"Deletes an existing Semantic CWT credentials configuration by providing its ID.","responses":{"204":{"description":"Semantic CWT credentials configuration deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL"]}},"/v2/credentials/compact/pdf/templates":{"post":{"tags":["CWT credentials PDF templates"],"summary":"Create a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"PDF template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"createCompactPdfTemplate","description":"Creates a CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/docs/issuance/cwt-credential-templates/pdf-templates) for more information on how to design a template and structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL"]},"get":{"summary":"Retrieve all PDF templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"PDF templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"getCompactPdfTemplates","description":"Retrieves a list of all CWT credentials PDF templates available on the tenant.","tags":["CWT credentials PDF templates"],"x-analytic-events":["CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact/pdf/templates/{id}":{"put":{"tags":["CWT credentials PDF templates"],"summary":"Update a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF template ID"}],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"PDF template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateCompactPdfTemplate","description":"Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/docs/issuance/cwt-credential-templates/pdf-templates) for more information on how to design a template and structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["CWT credentials PDF templates"],"summary":"Retrieve a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF template ID"}],"responses":{"200":{"description":"PDF template retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"getCompactPdfTemplate","description":"Retrieves an existing CWT credentials PDF template using its ID.","x-analytic-events":["CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["CWT credentials PDF templates"],"summary":"Delete a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF Template ID"}],"responses":{"204":{"description":"PDF template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteCompactPdfTemplate","description":"Delete an existing PDF template by providing its ID","x-analytic-events":["CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true}]},"/v2/credentials/compact/pdf":{"post":{"tags":["CWT credentials issuance"],"summary":"Format a CWT credential as a PDF","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"description":"Credential payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePDFRequest"},"examples":{"Generate PDF":{"value":{"templateId":"4eea7654-d4c5-4eba-bd7a-5ca334d54725","payload":"{payload}"}}}}}},"responses":{"200":{"description":"PDF created","content":{"application/pdf":{"schema":{"format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"GenCompactPdf","description":"Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_PDF_CREATE_START","CREDENTIAL_COMPACT_PDF_CREATE_SUCCESS","CREDENTIAL_COMPACT_PDF_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/pdf/templates":{"post":{"tags":["Semantic CWT credentials PDF templates"],"summary":"Create a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"PDF template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"createCompactSemanticPdfTemplate","description":"Creates a Semantic CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/docs/issuance/cwt-credential-templates/pdf-templates) for more information on how to design a template and structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_FAIL"]},"get":{"tags":["Semantic CWT credentials PDF templates"],"summary":"Retrieve all PDF templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"PDF templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"getCompactSemanticPdfTemplates","description":"Retrieves a list of all Semantic CWT credential PDF templates available on the tenant.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/pdf/templates/{id}":{"put":{"tags":["Semantic CWT credentials PDF templates"],"summary":"Update a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF Template ID"}],"requestBody":{"required":true,"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"PDF template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateCompactSemanticPdfTemplate","description":"Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/docs/issuance/cwt-credential-templates/pdf-templates) for more information on how to design a template and structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["Semantic CWT credentials PDF templates"],"summary":"Retrieve a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF Template ID"}],"responses":{"200":{"description":"PDF template retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PDFTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"getCompactSemanticPdfTemplate","description":"Retrieves an existing Semantic CWT credential PDF template using its ID.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["Semantic CWT credentials PDF templates"],"summary":"Delete a PDF template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"PDF Template ID"}],"responses":{"204":{"description":"PDF template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteCompactSemanticPdfTemplate","description":"Delete an existing PDF template by providing its ID","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true}]},"/v2/credentials/compact-semantic/pdf":{"post":{"tags":["Semantic CWT credentials issuance"],"summary":"Format a CWT credential as a PDF","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"description":"The credential payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePDFRequest"},"examples":{"Generate PDF":{"value":{"templateId":"4eea7654-d4c5-4eba-bd7a-5ca334d54725","payload":"{payload}"}}}}}},"responses":{"200":{"description":"PDF created","content":{"application/pdf":{"schema":{"format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"GenCompactSemanticPdf","description":"Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/compact/digital-pass/apple/templates":{"post":{"tags":["CWT credentials Apple Pass templates"],"summary":"Create an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateRequest"}}}},"responses":{"201":{"description":"Apple Pass template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"operationId":"createCCApplePassTemplate","description":"Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n\nThe Apple Pass template uses the official Apple Pass bundle structure.\n","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_FAIL"]},"get":{"tags":["CWT credentials Apple Pass templates"],"summary":"Retrieve all Apple Pass templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Apple Pass templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"listCCApplePassTemplates","description":"Retrieves a list of all Apple Pass template available on the tenant.","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact/digital-pass/apple/templates/{id}":{"put":{"tags":["CWT credentials Apple Pass templates"],"summary":"Update an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Apple Pass template ID"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateRequest"}}}},"responses":{"200":{"description":"Apple Pass template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateCCApplePassTemplate","description":"Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["CWT credentials Apple Pass templates"],"summary":"Retrieve an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Apple Pass template ID"}],"responses":{"200":{"description":"Apple Pass template retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveCCApplePassTemplate","description":"Retrieves an existing Apple Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["CWT credentials Apple Pass templates"],"summary":"Delete an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Apple Pass template ID"}],"responses":{"204":{"description":"Apple Pass template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteCCApplePassTemplate","description":"Deletes an existing Apple Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Apple Pass template ID"}]},"/v2/credentials/compact/digital-pass/google/templates":{"post":{"tags":["CWT credentials Google Pass templates"],"summary":"Create a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateRequest"}}}},"responses":{"201":{"description":"Google Pass template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createCCGooglePassTemplate","description":"Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL"]},"get":{"tags":["CWT credentials Google Pass templates"],"summary":"Retrieve all Google Pass templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Google Pass templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"getCCGooglePassTemplates","description":"Retrieves a list of all Google Pass templates available on your tenant.","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact/digital-pass/google/templates/{id}":{"put":{"tags":["CWT credentials Google Pass templates"],"summary":"Update a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Google Pass template ID"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateRequest"}}}},"responses":{"200":{"description":"Google Pass template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateCCGooglePassTemplate","description":"Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["CWT credentials Google Pass templates"],"summary":"Retrieve a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Google Pass template ID"}],"responses":{"200":{"description":"Google Pass templated retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveCCGooglePassTemplate","description":"Retrieves an existing Google Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["CWT credentials Google Pass templates"],"summary":"Delete a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Google Pass template ID"}],"responses":{"204":{"description":"Google Pass template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteCCGooglePassTemplate","description":"Deletes an existing Google Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Template ID"}]},"/v2/credentials/compact/digital-pass/apple":{"post":{"tags":["CWT credentials issuance"],"summary":"Format a CWT credential as an Apple Pass","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitalPassRequest"},"examples":{"Generate Apple Pass":{"value":{"templateId":"3812166c-ac9f-4e4e-96dd-c1336b5be378","payload":"{payload}"}}}}}},"responses":{"200":{"description":"Apple Pass created","content":{"application/vnd.apple.pkpass":{"schema":{"$ref":"#/components/schemas/CreateApplePassResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"generateCCApplePass","description":"Returns an Apple Pass representation of a provided CWT credential based on an existing Apple Pass template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_APPLE_PASS_CREATE_START","CREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESS","CREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/compact/digital-pass/google":{"post":{"tags":["CWT credentials issuance"],"summary":"Format a CWT credential as a Google Pass","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitalPassRequest"},"examples":{"Generate Google Pay Pass":{"value":{"templateId":"3812166c-ac9f-4e4e-96dd-c1336b5be378","payload":"{payload}"}}}}}},"responses":{"200":{"description":"Google Pass created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGooglePassResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createCCDigitalPass","description":"Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_START","CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESS","CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL"]}},"/v2/credentials/compact-semantic/digital-pass/apple/templates":{"post":{"tags":["Semantic CWT credentials Apple Pass templates"],"summary":"Create an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateRequest"}}}},"responses":{"201":{"description":"Apple Pass template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createSCApplePassTemplate","description":"Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n\nThe Apple Pass template uses the official Apple Pass bundle structure.\n","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL"]},"get":{"tags":["Semantic CWT credentials Apple Pass templates"],"summary":"Retrieve all Apple Pass templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Apple Pass templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"listSCApplePassTemplates","description":"Retrieves a list of all Apple Pass template available on the tenant.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/digital-pass/apple/templates/{id}":{"put":{"tags":["Semantic CWT credentials Apple Pass templates"],"summary":"Update an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Apple Pass template ID"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateRequest"}}}},"responses":{"200":{"description":"Apple Pass template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateSCApplePassTemplate","description":"Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["Semantic CWT credentials Apple Pass templates"],"summary":"Retrieve an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Apple Pass template ID"}],"responses":{"200":{"description":"Apple Pass template retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveSCApplePassTemplate","description":"Retrieves an existing Apple Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["Semantic CWT credentials Apple Pass templates"],"summary":"Delete an Apple Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Apple Pass template ID"}],"responses":{"204":{"description":"Apple Pass template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteSCApplePassTemplate","description":"Deletes an existing Apple Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Template ID"}]},"/v2/credentials/compact-semantic/digital-pass/google/templates":{"post":{"tags":["Semantic CWT credentials Google Pass templates"],"summary":"Create a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateRequest"}}}},"responses":{"201":{"description":"Google Pass template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createSCGooglePassTemplate","description":"Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_FAIL"]},"get":{"tags":["Semantic CWT credentials Google Pass templates"],"summary":"Retrieve all Google Pass templates","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Google Pass templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplatesResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"getSCGooglePassTemplates","description":"Retrieves a list of all Google Pass templates available on your tenant.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/digital-pass/google/templates/{id}":{"put":{"tags":["Semantic CWT credentials Google Pass templates"],"summary":"Update a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Google Pass template ID"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateRequest"}}}},"responses":{"200":{"description":"Google Pass template updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"updateSCGooglePassTemplate","description":"Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/docs/issuance/cwt-credential-templates/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL"]},"get":{"tags":["Semantic CWT credentials Google Pass templates"],"summary":"Retrieve a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Google Pass template ID"}],"responses":{"200":{"description":"Google Pass templated retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveSCGooglePassTemplate","description":"Retrieves an existing Google Pass template by providing its ID.","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"tags":["Semantic CWT credentials Google Pass templates"],"summary":"Delete a Google Pass template","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Google Pass template ID"}],"responses":{"204":{"description":"Google Pass template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"deleteSCGooglePassTemplate","description":"Delete a Google Pay Pass template by ID","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_FAIL"]},"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Template ID"}]},"/v2/credentials/compact-semantic/digital-pass/apple":{"post":{"tags":["Semantic CWT credentials issuance"],"summary":"Format a Semantic CWT credential as an Apple Pass","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitalPassRequest"},"examples":{"Generate Apple Pass":{"value":{"templateId":"3812166c-ac9f-4e4e-96dd-c1336b5be378","payload":"{payload}"}}}}}},"responses":{"200":{"description":"Apple Pass created","content":{"application/vnd.apple.pkpass":{"schema":{"$ref":"#/components/schemas/CreateApplePassResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"generateSCApplePass","description":"Returns an Apple Pass representation of a provided Semantic CWT credential based on an existing Apple Pass template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/compact-semantic/digital-pass/google":{"post":{"tags":["Semantic CWT credentials issuance"],"summary":"Format a Semantic CWT credential as a Google Pass","x-roles":["admin","issuer","managed-issuer"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitalPassRequest"},"examples":{"Generate Google Pay Pass":{"value":{"templateId":"3812166c-ac9f-4e4e-96dd-c1336b5be378","payload":"{payload}"}}}}}},"responses":{"200":{"description":"Google Pass created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGooglePassResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"createSCDigitalPass","description":"Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n\nThe request will fail if the provided credential isn't valid or has expired.\n","x-analytic-events":["CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_START","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_SUCCESS","CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/mobile/iacas":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIacaRequest"}}}},"tags":["IACA"],"summary":"Create an IACA","x-roles":["admin","issuer"],"responses":{"201":{"description":"IACA created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IacaResponse"},"examples":{"exampleIaca":{"summary":"Example IACA","description":"IACAs are always created inactive. Update the IACA to `active: true` before using it to sign mDocs.","value":{"id":"2e89c156-31d5-4783-bd59-9055b5f8e7d2","active":false,"certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"},"certificateFingerprint":"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311","isManaged":true}}}}}},"400":{"$ref":"#/components/responses/400"},"409":{"description":"Maximum number of IACA certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"operationId":"create-mobile-credential-iaca","description":"Creates a new IACA that can be used to sign certificates for Document and Status List signers.\n- IACAs are always created as inactive. You must manually [update](#operation/update-mobile-credential-iaca) the IACA to [`active: true`](#operation/update-mobile-credential-iaca!path=active&t=request) before it can be used to sign mDocs.\n- A maximum of three IACAs can be created per tenant.","x-analytic-events":["MOBILE_CREDENTIAL_IACA_CREATE_START","MOBILE_CREDENTIAL_IACA_CREATE_SUCCESS","MOBILE_CREDENTIAL_IACA_CREATE_FAIL"]},"get":{"tags":["IACA"],"summary":"Retrieve all IACAs","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"IACAs Retrieved","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IacaResponse"}},"nextCursor":{"type":"string"}}},"examples":{"singlePage":{"summary":"A single page of IACAs","description":"`nextCursor` is absent because there are no further pages.","value":{"data":[{"id":"2e89c156-31d5-4783-bd59-9055b5f8e7d2","active":true,"certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"},"certificateFingerprint":"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311","isManaged":true}]}}}}}}},"operationId":"list-mobile-credential-iaca","description":"Retrieves all existing IACAs from the tenant.","x-analytic-events":["MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/mobile/iacas/{iacaId}":{"get":{"operationId":"get-mobile-credential-iaca","summary":"Retrieve an IACA","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an existing IACA by providing its ID.","tags":["IACA"],"parameters":[{"name":"iacaId","required":true,"in":"path","description":"IACA ID","schema":{"type":"string","format":"uuid","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","examples":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}}],"responses":{"200":{"description":"IACA retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IacaResponse"},"examples":{"exampleIaca":{"summary":"Example IACA","value":{"id":"2e89c156-31d5-4783-bd59-9055b5f8e7d2","active":true,"certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"},"certificateFingerprint":"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311","isManaged":true}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_IACA_RETRIEVE_START","MOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL"]},"put":{"tags":["IACA"],"summary":"Update an IACA","x-roles":["admin","issuer"],"operationId":"update-mobile-credential-iaca","description":"Update the status of an IACA. Only active IACAs can be used for signing mDocs.\n\nCreating an IACA with `active` set to `false` enables distributing the IACA's PEM to relying parties in advance, before it is being used to sign any mDocs.","parameters":[{"name":"iacaId","required":true,"in":"path","description":"IACA ID","schema":{"type":"string","format":"uuid","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","examples":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIacaRequest"},"example":{"active":false}}}},"responses":{"200":{"description":"IACA updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IacaResponse"},"examples":{"exampleIaca":{"summary":"Example IACA deactivated","description":"Result of the `active: false` request body above.","value":{"id":"2e89c156-31d5-4783-bd59-9055b5f8e7d2","active":false,"certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"},"certificateFingerprint":"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311","isManaged":true}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_IACA_UPDATE_START","MOBILE_CREDENTIAL_IACA_UPDATE_SUCCESS","MOBILE_CREDENTIAL_IACA_UPDATE_FAIL"]},"delete":{"parameters":[{"name":"iacaId","required":true,"in":"path","description":"IACA ID","schema":{"type":"string","format":"uuid","example":"497f6eca-6276-4993-bfeb-53cbbbba6f08","examples":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}}],"tags":["IACA"],"summary":"Delete an IACA","x-roles":["admin","issuer"],"responses":{"204":{"description":"IACA deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"delete-mobile-credential-iaca","description":"Deletes an existing IACA by providing its ID.","x-analytic-events":["MOBILE_CREDENTIAL_IACA_DELETE_START","MOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESS","MOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL"]}},"/v2/credentials/mobile/iacas/{iacaId}/crl":{"get":{"security":[],"tags":["IACA"],"summary":"Retrieve IACA CRL","parameters":[{"name":"iacaId","description":"IACA identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"IACA CRL retrieved","content":{"application/pkix-crl":{"schema":{"type":"string","format":"binary","description":"Certificate Revocation List in DER binary format"}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"get-mobile-credential-iaca-crl","description":"Retrieves the Certificate Revocation List (CRL) for the specified IACA in DER binary format.\n\nThis endpoint is public and does not require authentication. CRLs must be publicly accessible so relying parties can validate certificates.","x-analytic-events":["MOBILE_CREDENTIAL_IACA_CRL_RETRIEVE_START","MOBILE_CREDENTIAL_IACA_CRL_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_IACA_CRL_RETRIEVE_FAIL"]}},"/v2/credentials/mobile/document-signers":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentSignerRequest"}}}},"tags":["Document Signers"],"summary":"Create a Document Signer","x-roles":["admin","issuer"],"responses":{"201":{"description":"Document Signer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignerCsrResponse"}}}},"400":{"$ref":"#/components/responses/400"},"409":{"description":"Maximum number of document signer certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"operationId":"create-mobile-credential-document-signer","description":"Creates a new Document Signer that can be used to sign new mDocs.\n- Only available in implementations using unmanaged (external) IACAs.\n- A maximum of five Document Signers can be created per tenant.","x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_FAIL"]},"get":{"tags":["Document Signers"],"summary":"Retrieve all Document Signers","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Document Signers retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDocumentSignersResponse"}}}}},"operationId":"list-mobile-credential-document-signers","description":"Retrieves all existing Document Signers from the tenant.","x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/mobile/document-signers/{documentSignerId}":{"put":{"parameters":[{"name":"documentSignerId","required":true,"in":"path","description":"Document Signer ID","schema":{"type":"string","format":"uuid","example":"d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6","examples":["d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocumentSignerRequest"}}}},"tags":["Document Signers"],"summary":"Update a Document Signer","x-roles":["admin","issuer"],"responses":{"200":{"description":"Document Signer updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignerCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"update-mobile-credential-document-signer","description":"Updates an existing Document Signer by providing its ID and `active` parameter.\n\nOnly available in implementations using unmanaged (external) IACAs.","x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_FAIL"]},"get":{"parameters":[{"name":"documentSignerId","required":true,"in":"path","description":"Document Signer ID","schema":{"type":"string","format":"uuid","example":"d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6","examples":["d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6"]}}],"tags":["Document Signers"],"summary":"Retrieve a Document Signer","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Document Signer retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignerResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieve-mobile-credential-document-signer","description":"Retrieves an existing Document Signer by providing its ID.","x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_FAIL"]},"delete":{"parameters":[{"name":"documentSignerId","required":true,"in":"path","description":"Document Signer ID","schema":{"type":"string","format":"uuid","example":"d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6","examples":["d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6"]}}],"tags":["Document Signers"],"summary":"Delete a Document Signer","x-roles":["admin","issuer"],"responses":{"204":{"description":"Document Signer deleted"},"404":{"$ref":"#/components/responses/404"}},"operationId":"remove-mobile-credential-document-signer","description":"Deletes an existing Document Signer by providing its ID.\n\nOnly available in implementations using unmanaged (external) IACAs.","x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_FAIL"]}},"/v2/credentials/mobile/document-signers/{documentSignerId}/revoke":{"post":{"operationId":"revokeDocumentSigner","tags":["Document Signers"],"summary":"Revoke a Document Signer","x-roles":["admin","issuer"],"description":"Revokes an existing Document Signer, making it unusable for signing new mDocs.\n\nIf the verifier checks the CRL referenced in the IACA certificate, it must treat revoked Document Signers and any mDocs they signed as untrusted.\n\n\nOnly available in implementations using managed IACAs. When using unmanaged (external) IACAs, you must revoke the Document Signer certificate directly with the CA that issued it.\n","parameters":[{"name":"documentSignerId","description":"Document Signer identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignerRevokeRequest"}}}},"responses":{"200":{"description":"Document Signer revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignerRevokeResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Document Signer already revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_START","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_SUCCESS","MOBILE_CREDENTIAL_DOCUMENT_SIGNER_REVOKE_FAIL"]}},"/v2/credentials/mobile/status-list-signers":{"post":{"operationId":"createStatusListSigner","tags":["Status list signers"],"summary":"Create a new status list signer","x-roles":["admin","issuer"],"description":"Uses an existing IACA to sign a status list signer (intermediate certificate) that can be used to sign status list tokens.\n\n- Only available in implementations using unmanaged (external) IACAs.\n- A maximum of three Status List Signers can be created per tenant.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerCreateRequest"}}}},"responses":{"200":{"description":"Status list signer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerResponse"}}}},"409":{"description":"Maximum number of status list signer certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_FAIL"]},"get":{"operationId":"getStatusListSigners","tags":["Status list signers"],"summary":"Retrieve all status list signers","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves all existing status list signers.","responses":{"200":{"description":"Status list signers retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignersResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/mobile/status-list-signers/{statusListSignerId}":{"get":{"operationId":"getStatusListSigner","tags":["Status list signers"],"summary":"Retrieve a status list signer","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an existing status list signer.\n\nStatus list signer operations are only available in implementations using unmanaged (external) IACAs.","parameters":[{"name":"statusListSignerId","description":"Status list identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Status list signer retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_FAIL"]},"put":{"operationId":"updateStatusListSigner","tags":["Status list signers"],"summary":"Update a status list signer","x-roles":["admin","issuer"],"description":"Updates the status of an existing status list signer.\n\nOnly available in implementations using unmanaged (external) IACAs.","parameters":[{"name":"statusListSignerId","description":"Status list identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerUpdateRequest"}}}},"responses":{"200":{"description":"Status list signer updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerUpdateResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_FAIL"]},"delete":{"operationId":"deleteStatusListSigner","tags":["Status list signers"],"summary":"Delete a status list signer","x-roles":["admin","issuer"],"description":"Deletes an existing status list signer.\n\nOnly available in implementations using unmanaged (external) IACAs.","parameters":[{"name":"statusListSignerId","description":"Status list identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_FAIL"]}},"/v2/credentials/mobile/status-list-signers/{statusListSignerId}/revoke":{"post":{"operationId":"revokeStatusListSigner","tags":["Status list signers"],"summary":"Revoke a status list signer","x-roles":["admin","issuer"],"description":"Revokes an existing status list signer, making it unusable for signing new status lists.\n\nIf the verifier checks the CRL referenced in the IACA certificate, it must treat revoked status list signers and any status list they signed as untrusted.\n\n\nOnly available in implementations using managed IACAs. When using unmanaged (external) IACAs, you must revoke the status list signer certificate directly with the CA that issued it.\n","parameters":[{"name":"statusListSignerId","description":"Status list signer identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerRevokeRequest"}}}},"responses":{"200":{"description":"Status list signer revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListSignerRevokeResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Status list signer already revoked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_REVOKE_START","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_REVOKE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_REVOKE_FAIL"]}},"/v2/credentials/mobile/{credentialId}":{"parameters":[{"name":"credentialId","in":"path","required":true,"schema":{"type":"string"},"description":"mDoc ID"}],"delete":{"tags":["mDocs management"],"summary":"Delete mDoc metadata","x-roles":["admin","issuer","managed-issuer"],"responses":{"204":{"description":"mDoc metadata deleted"},"400":{"description":"Invalid id parameter format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"remove-mobile-credential","description":"Deletes all stored data for an existing mDoc that matches the provided ID.\n\nRemoved credential data cannot be recovered.","x-analytic-events":["USER_CREDENTIAL_DELETE_START","USER_CREDENTIAL_DELETE_SUCCESS","USER_CREDENTIAL_DELETE_FAIL"]}},"/v2/credentials/mobile/configurations":{"post":{"operationId":"createMobileCredentialConfiguration","tags":["mDoc credentials configuration"],"summary":"Create an mDocs configuration","x-roles":["admin","issuer"],"description":"Creates a new mDocs configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.","requestBody":{"description":"The mDocs configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialConfigurationRequest"}}}},"responses":{"201":{"description":"mDocs configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MOBILE_CREDENTIAL_CONFIGURATION_CREATE_START","MOBILE_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS","MOBILE_CREDENTIAL_CONFIGURATION_CREATE_FAIL"]},"get":{"operationId":"getMobileCredentialConfigurations","tags":["mDoc credentials configuration"],"summary":"Retrieve all mDocs configurations","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves all mDocs configurations from your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"schema":{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},"in":"query","name":"type","description":"Optional credential type to filter on"}],"responses":{"200":{"description":"mDocs configurations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMobileCredentialConfigurationsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/mobile/configurations/{id}":{"parameters":[{"name":"id","in":"path","description":"mDocs configuration ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getMobileCredentialConfiguration","tags":["mDoc credentials configuration"],"summary":"Retrieve an mDocs configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an existing mDocs configuration by providing its ID.","responses":{"200":{"description":"mDocs configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_START","MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL"]},"put":{"operationId":"updateMobileCredentialConfiguration","tags":["mDoc credentials configuration"],"summary":"Update an mDocs configuration","x-roles":["admin","issuer"],"description":"Updates an existing mDocs configuration by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialConfigurationRequest"}}},"description":"Update an mDocs configuration"},"responses":{"200":{"description":"mDocs configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_START","MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS","MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL"]},"delete":{"operationId":"deleteMobileCredentialConfiguration","tags":["mDoc credentials configuration"],"summary":"Delete an mDocs configuration","x-roles":["admin","issuer"],"description":"Deletes an existing mDocs configuration by providing its ID.","responses":{"204":{"description":"mDocs configuration deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_CONFIGURATION_DELETE_START","MOBILE_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS","MOBILE_CREDENTIAL_CONFIGURATION_DELETE_FAIL"]}},"/v2/credentials/mobile/{credentialId}/status":{"parameters":[{"name":"credentialId","in":"path","description":"mDoc identifier","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"post":{"operationId":"postCredentialStatus","tags":["mDocs status"],"summary":"Update mDoc status","x-roles":["admin","issuer","managed-issuer"],"description":"Sets the status of an existing mDoc by providing its `credentialId` and the new status.\n\nAvailable status values depend on the Status List configuration format:\n\n**Draft 14 of the IETF Token Status List specification (1-bit encoding)**:\n* **valid** - Credential is valid\n* **invalid** - Credential is invalid (cannot be reversed)\n\n**Deprecated Legacy format (2-bit encoding)**:\n* **valid** - Credential is valid\n* **invalid** - Credential is invalid (cannot be reversed)\n* **suspended** - Credential is temporarily suspended\n\nThe **suspended** status is deprecated and only available in legacy format.","requestBody":{"description":"Credential status payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialStatus"}}}},"responses":{"201":{"description":"Credential status updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialStatus"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Invalid ID":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"params","msg":"Invalid value","param":"credentialId","value":"abc"}]}},"Unsupported status provided":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"must be one of the following values 'valid', 'invalid', 'suspended' (suspended only available in legacy format)","param":"status","value":"abc"}]}},"mDoc status is invalid":{"value":{"code":"BadRequest","message":"Credential status is in final 'invalid' state and cannot be updated."}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_SET_START","MOBILE_CREDENTIAL_STATUS_SET_SUCCESS","MOBILE_CREDENTIAL_STATUS_SET_FAIL"]},"get":{"operationId":"getCredentialStatus","tags":["mDocs status"],"summary":"Retrieve mDoc status","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves the status of an existing mDoc by providing its `credentialId`.","parameters":[{"name":"credentialId","in":"path","description":"mDoc identifier","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"responses":{"200":{"description":"Credential status retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MobileCredentialStatus"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_RETRIEVE_START","MOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL"]}},"/v2/credentials/mobile/status-lists/configurations":{"post":{"operationId":"createStatusListConfiguration","tags":["Status list configuration"],"summary":"Create a Status list configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.","requestBody":{"description":"The Status list configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListConfigurationRequest"}}}},"responses":{"201":{"description":"Status list configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatusListConfigurationResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalid timeToLiveDuration":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"must be a Duration","param":"timeToLiveDuration","value":"abc"}]}},"invalid expiryDuration":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"must be a Duration","param":"expiryDuration","value":"abc"}]}},"invalid docType":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"must be a string","param":"docType","value":"1"}]}},"configuration exists for docType":{"value":{"code":"BadRequest","message":"Configuration for docType already exists"}}}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_START","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL"]},"get":{"operationId":"StatusListConfigurations","tags":["Status list configuration"],"summary":"Retrieve all Status list configurations","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves all Status list configurations from your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Status list configurations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatusListConfigurationsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/mobile/status-lists/configurations/{statusListConfigurationId}":{"parameters":[{"name":"statusListConfigurationId","in":"path","description":"Status list configuration ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getStatusListConfiguration","tags":["Status list configuration"],"summary":"Retrieve a Status list configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an existing Status list configuration by providing its ID.","parameters":[{"name":"statusListConfigurationId","in":"path","description":"Status list configuration ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"responses":{"200":{"description":"Status list configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListConfiguration"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_START","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL"]},"put":{"operationId":"updateStatusListConfiguration","tags":["Status list configuration"],"summary":"Update a Status list configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.","parameters":[{"name":"statusListConfigurationId","in":"path","description":"Status list configuration ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"requestBody":{"description":"The Status list configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListConfigurationUpdateRequest"}}}},"responses":{"200":{"description":"Status list configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatusListConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_START","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL"]},"delete":{"operationId":"deleteStatusListConfiguration","tags":["Status list configuration"],"summary":"Delete a Status list configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Permanently deletes an existing Status list configuration.","parameters":[{"name":"statusListConfigurationId","in":"path","description":"Status list configuration ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"responses":{"204":{"description":"Status list configuration deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Configuration in use":{"value":{"code":"BadRequest","message":"Status list configuration is in use by at least one status list"}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_START","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL"]}},"/v2/credentials/mobile/status-lists":{"get":{"operationId":"getStatusLists","tags":["Status list retrieval"],"summary":"Retrieve all Status lists","deprecated":true,"x-roles":["admin","issuer","managed-issuer"],"description":"\n**Deprecated.** In line with our SLA, this endpoint will be removed no earlier than 22 September 2026. To discover the Status lists available on a tenant, use the public [Status list distribution](#operation/getStatusListDistribution) endpoint (`GET /v2/credentials/mobile/status-lists/distribution`), which returns the URLs of all Status list tokens on the tenant. To retrieve an individual Status list token, use the public [Retrieve a Status list token](#operation/getStatusListToken) endpoint (`GET /v2/credentials/mobile/status-lists/{statusListId}/token`).\n\n\nRetrieves all existing status lists from your tenant.","responses":{"200":{"description":"Status lists retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListsResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/mobile/status-lists/{statusListId}":{"get":{"operationId":"getStatusList","tags":["Status list retrieval"],"summary":"Retrieve a Status list","deprecated":true,"x-roles":["admin","issuer","managed-issuer"],"description":"\n**Deprecated.** In line with our SLA, this endpoint will be removed no earlier than 22 September 2026. To retrieve a Status list token, use the public [Retrieve a Status list token](#operation/getStatusListToken) endpoint (`GET /v2/credentials/mobile/status-lists/{statusListId}/token`), which returns the signed Status list token in CWT format. To discover the Status lists available on a tenant, use the public [Status list distribution](#operation/getStatusListDistribution) endpoint (`GET /v2/credentials/mobile/status-lists/distribution`).\n\n\nRetrieves an existing Status list and its signed token by providing its ID.","parameters":[{"name":"statusListId","description":"Status list unique identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Status list retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusListResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_START","MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_FAIL"]}},"/v2/credentials/mobile/status-lists/{statusListId}/token":{"get":{"operationId":"getStatusListToken","security":[],"tags":["Status list retrieval"],"summary":"Retrieve a Status list token","description":"Retrieves the Status list token in CWT format. This public endpoint returns a token which contains a compressed, signed list of credential statuses. Relying parties can use this token to check the revocation status of an mDoc that references this Status list.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.\n\n**Token Format Differences**:\n\nThe token structure depends on the Status List configuration format:\n\n**Draft 14 of the IETF Token Status List specification**:\n- Token header `typ`: `application/statuslist+cwt`\n- CBOR payload claims: `65533` (status_list), `65534` (ttl)\n- Status encoding: 1-bit (Valid/Invalid)\n\n**Legacy format**:\n- Token header `typ`: `mattr-statuslist+cwt`\n- CBOR payload claims: `-65538` (status_list), `-65539` (ttl)\n- Status encoding: 2-bit (Valid/Invalid/Suspended)","parameters":[{"name":"statusListId","in":"path","description":"Status list identifier","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Status list token retrieved","content":{"application/cwt":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"},"410":{"description":"Status list expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_START","MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_FAIL"]}},"/v2/credentials/mobile/status-lists/distribution":{"get":{"operationId":"getStatusListDistribution","security":[],"tags":["Status list retrieval"],"summary":"Status list distribution","description":"Retrieves an object that details all existing Status lists tokens on the tenant. This public endpoint allows a relying party to consume and cache status lists. Each list\nin the response includes a URL where its token can be retrieved. Status list tokens that were signed by expired IACAs are excluded from the response.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.\n\n**Response Format Differences**:\n\nThe response structure depends on the Status List configuration format:\n\n**Draft 14 of the IETF Token Status List specification**: `{\"status_lists\": [\"https://...\"]}`\n\n**Legacy format**: `{\"status_lists\": [{\"uri\": \"https://...\"}]}`","responses":{"200":{"description":"Status lists retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionStatusListsResponse"}}}}},"x-analytic-events":["MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_START","MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESS","MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL"]}},"/v2/credentials/mobile/trusted-issuers":{"post":{"operationId":"addMobileCredentialTrustedIssuer","tags":["Trusted issuers"],"summary":"Create a trusted issuer","x-roles":["admin","verifier"],"description":"Add a new mDocs trusted issuer, to be used in online presentation workflows.","requestBody":{"description":"The trusted issuer payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedIssuerRequest"},"examples":{"exampleIaca":{"summary":"Example IACA","description":"A PEM-encoded IACA certificate obtained from the issuer.","value":{"certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n"}}}}}},"responses":{"201":{"description":"Trusted issuer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedIssuer"},"examples":{"exampleIaca":{"summary":"Example IACA","description":"The stored trusted issuer. The `certificateData` fields are read back from the supplied certificate.","value":{"id":"ed74319e-72a6-4401-b3a5-94e980fbebea","certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"}}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_START","MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_SUCCESS","MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_FAIL"]},"get":{"operationId":"getMobileCredentialTrustedIssuers","tags":["Trusted issuers"],"summary":"Retrieve all trusted issuers","x-roles":["admin","verifier"],"description":"Retrieves all mDocs trusted issuers from your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Trusted issuers retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTrustedIssuersResponse"},"examples":{"singlePage":{"summary":"A single page of trusted issuers","description":"`nextCursor` is absent because there are no further pages.","value":{"data":[{"id":"ed74319e-72a6-4401-b3a5-94e980fbebea","certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"}}]}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_START","MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_SUCCESS","MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/mobile/trusted-issuers/{trustedIssuerId}":{"parameters":[{"name":"trustedIssuerId","in":"path","description":"Trusted issuer ID","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getMobileCredentialTrustedIssuer","tags":["Trusted issuers"],"summary":"Retrieve a trusted issuer","x-roles":["admin","verifier"],"description":"Retrieves an existing trusted issuer from your tenant by providing its ID.","responses":{"200":{"description":"Trusted issuer retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedIssuer"},"examples":{"exampleIaca":{"summary":"Example IACA","value":{"id":"ed74319e-72a6-4401-b3a5-94e980fbebea","certificatePem":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","certificateData":{"notBefore":"2023-09-11T23:34:22.000Z","notAfter":"2033-09-08T23:34:22.000Z","country":"NZ","commonName":"Example IACA"}}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_START","MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_SUCCESS","MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteMobileCredentialTrustedIssuer","tags":["Trusted issuers"],"summary":"Delete a trusted issuer","x-roles":["admin","verifier"],"description":"Deletes an existing trusted issuer by providing its ID.","responses":{"204":{"description":"Trusted issuer deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_START","MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_SUCCESS","MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_FAIL"]}},"/v2/presentations/certificates/ca":{"post":{"operationId":"postVerifierCACertificate","tags":["Verifier root CA certificates"],"summary":"Create a verifier root CA certificate","x-roles":["admin","verifier"],"description":"Creates a verifier root CA certificate to be used as part of mDocs online verification workflows.\n- A maximum of three Verifier root CA certificates can be created per tenant.","requestBody":{"description":"Verifier root CA certificate payload","required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/VerifierCACertificateManagedRequest"},{"$ref":"#/components/schemas/VerifierCACertificateUnmanagedRequest"}]}}}},"responses":{"200":{"description":"Verifier root CA certificate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCACertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"409":{"description":"Maximum number of verifier root certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_START","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_FAIL"]},"get":{"operationId":"getVerifierCACertificates","tags":["Verifier root CA certificates"],"summary":"Retrieve all verifier root CA certificates","x-roles":["admin","verifier"],"description":"Retrieves all existing verifier root CA certificates.","responses":{"200":{"description":"Verifier root CA certificates retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VerifierCACertificateResponse"}},"nextCursor":{"type":"string","description":"Cursor to retrieve the next page of results."}}}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/certificates/ca/{certificateId}":{"parameters":[{"name":"certificateId","in":"path","description":"Unique identifier for the verifier root CA certificate.","schema":{"type":"string","format":"uuid","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"required":true}],"put":{"operationId":"putVerifierCACertificate","tags":["Verifier root CA certificates"],"summary":"Update a verifier root CA certificate","x-roles":["admin","verifier"],"description":"Updates an existing verifier root CA certificate.","requestBody":{"description":"Verifier root CA certificate payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCACertificateUpdateRequest"}}}},"responses":{"200":{"description":"Verifier root CA certificate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCACertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_START","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_FAIL"]},"get":{"operationId":"getVerifierCACertificate","tags":["Verifier root CA certificates"],"summary":"Retrieve a verifier root CA certificate","x-roles":["admin","verifier"],"description":"Retrieves an existing verifier root CA certificate.","responses":{"200":{"description":"Verifier root CA certificate retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCACertificateResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_START","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteVerifierCACertificate","tags":["Verifier root CA certificates"],"summary":"Delete a verifier root CA certificate","x-roles":["admin","verifier"],"description":"Deletes an existing verifier root CA certificate.","responses":{"204":{"description":"Verifier root CA certificate deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_START","PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_SUCCESS","PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_FAIL"]}},"/v2/presentations/certificates/verifier-signers":{"post":{"tags":["Verification request signers"],"summary":"Create a Verification request signer","x-roles":["admin","verifier"],"description":"Creates a Verification request signer.\n- Only available in implementations using unmanaged (external) Verifier root CA certificates.\n- A maximum of five Verification request signers can be created per tenant.","operationId":"createVerificationRequestSigner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequestSignerCreateRequest"}}}},"responses":{"201":{"description":"Verification request signer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVerificationRequestSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_START","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["Verification request signers"],"summary":"Retrieve all Verification request signers","x-roles":["admin","verifier"],"description":"Retrieves all Verification request signers.","operationId":"getVerificationRequestSigners","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Verification request signers retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UpdateVerificationRequestSignerResponse"},{"$ref":"#/components/schemas/CreateVerificationRequestSignerResponse"}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/certificates/verifier-signers/{verifierSignerId}":{"parameters":[{"$ref":"#/components/parameters/verifierSignerId"}],"put":{"tags":["Verification request signers"],"summary":"Update a Verification request signer","x-roles":["admin","verifier"],"description":"Updates a Verification request signer by:\n- Providing a Verification Request Signer Certificate (VRSC) in PEM format that matches its Certificate Signing Request (CSR).\n- Activating or deactivating the VRSC signer. Only VRSC signers with a valid PEM certificate can be activated.\n- The `certificatePem` field becomes immutable after it's updated for the first time.\n\nOnly available in implementations using unmanaged (external) Verifier root CA certificates.","operationId":"updateVerificationRequestSigner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequestSignerUpdateRequest"}}}},"responses":{"200":{"description":"Verification request signer updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVerificationRequestSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_START","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["Verification request signers"],"summary":"Delete a Verification request signer","x-roles":["admin","verifier"],"description":"Deletes a Verification request signer.\n\nOnly available in implementations using unmanaged (external) Verifier root CA certificates.","operationId":"deleteVerificationRequestSigner","responses":{"204":{"description":"Verification request signer deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_START","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_FAIL"]},"get":{"tags":["Verification request signers"],"summary":"Retrieve a Verification request signer","x-roles":["admin","verifier"],"description":"Retrieves a Verification request signer.","operationId":"getVerificationRequestSigner","responses":{"200":{"description":"Verification request signer retrieved","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateVerificationRequestSignerResponse"},{"$ref":"#/components/schemas/CreateVerificationRequestSignerResponse"}]}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_START","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_FAIL"]}},"/v2/presentations/applications":{"post":{"operationId":"postVerifierApplication","tags":["Verifier applications"],"summary":"Create verifier application","x-roles":["admin","verifier"],"description":"Creates an mDocs online verifier application.\n\nOnce created, application instances can be registered and interact with the MATTR VII platform (for example, to verify credential presentations).","requestBody":{"description":"Verifier application payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationRequest"}}}},"responses":{"201":{"description":"Verifier application created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_FAIL"]},"get":{"operationId":"getVerifierApplications","tags":["Verifier applications"],"summary":"Retrieve all verifier applications","x-roles":["admin","verifier"],"description":"Retrieves all configured mDocs online verifier applications.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Verifier applications retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"$ref":"#/components/schemas/nextCursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VerifierApplicationResponse"}}}}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/applications/{verifierApplicationId}":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}],"put":{"operationId":"putVerifierApplication","tags":["Verifier applications"],"summary":"Update verifier application","x-roles":["admin","verifier"],"description":"Updates an existing mDocs online verifier application.","requestBody":{"description":"Verifier application payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationRequest"}}}},"responses":{"200":{"description":"Verifier application updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_FAIL"]},"get":{"operationId":"getVerifierApplication","tags":["Verifier applications"],"summary":"Retrieve a verifier application","x-roles":["admin","verifier"],"description":"Retrieves an existing mDocs online verifier application.","responses":{"200":{"description":"Verifier application retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteVerifierApplication","tags":["Verifier applications"],"summary":"Delete a verifier application","x-roles":["admin","verifier"],"description":"Deletes an existing verifier application. Once deleted, any associated application instances will no longer be able to interact with the MATTR VII platform.","responses":{"204":{"description":"Verifier application deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["PRESENTATION_VERIFIER_APPLICATION_DELETE_START","PRESENTATION_VERIFIER_APPLICATION_DELETE_SUCCESS","PRESENTATION_VERIFIER_APPLICATION_DELETE_FAIL"]}},"/v2/presentations/applications/{verifierApplicationId}/instances":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}],"get":{"operationId":"getVerifierApplicationInstances","tags":["Verifier applications"],"summary":"Retrieve all registered verifier application instances","x-roles":["admin","verifier"],"description":"Retrieves all registered instances of a verifier application.\n\nThis can be used by application owners to view all registered instances for a given verifier application.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Verifier application instances retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"$ref":"#/components/schemas/nextCursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VerifierApplicationInstanceResponse"}}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/applications/{verifierApplicationId}/instances/{instanceId}":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"},{"$ref":"#/components/parameters/instanceId"}],"delete":{"operationId":"deleteVerifierApplicationInstance","tags":["Verifier applications"],"summary":"Delete a registered verifier application instance","x-roles":["admin","verifier"],"description":"Deletes a registered instance of a verifier application.\n\nDeleted instances will no longer be able to interact with the platform or receive tokens, and any existing tokens will be revoked.\n\nApplication owners can use this endpoint to remove individual instances that are no longer needed or were registered by mistake, without affecting the entire verifier application or its other instances. This is useful for cleaning up test instances or managing specific devices, rather than deleting the whole application and all its associated instances.","responses":{"204":{"description":"Verifier application instance deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_DELETE_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_DELETE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_DELETE_FAIL"]},"get":{"operationId":"getVerifierApplicationInstance","tags":["Verifier applications"],"summary":"Retrieve a registered verifier application instance","x-roles":["admin","verifier"],"description":"Retrieves a registered instance of a verifier application.","responses":{"200":{"description":"Verifier application instance retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierApplicationInstanceResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_START","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_INSTANCE_RETRIEVE_FAIL"]}},"/v2/presentations/applications/{verifierApplicationId}/android/instances/register":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}]},"/v2/presentations/applications/{verifierApplicationId}/ios/instances/register":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}]},"/v2/presentations/applications/{verifierApplicationId}/android/instances/token":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}]},"/v2/presentations/applications/{verifierApplicationId}/ios/instances/token":{"parameters":[{"$ref":"#/components/parameters/verifierApplicationId"}]},"/v2/presentations/wallet-providers":{"post":{"operationId":"postWalletProvider","tags":["Wallet providers"],"summary":"Create wallet provider","x-roles":["admin","verifier"],"description":"Creates a wallet provider that can present mDocs for online verification.","requestBody":{"description":"Wallet provider payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletProviderRequest"}}}},"responses":{"200":{"description":"Wallet provider created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletProviderResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_START","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_SUCCESS","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_FAIL"]},"get":{"operationId":"getWalletProviders","tags":["Wallet providers"],"summary":"Retrieve all wallet providers","x-roles":["admin","verifier"],"description":"Retrieves all existing wallet providers that can present mDocs for online verification.","responses":{"200":{"description":"Wallet providers retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WalletProviderResponse"}}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/wallet-providers/{walletProviderId}":{"parameters":[{"name":"walletProviderId","in":"path","description":"Unique identifier for the wallet provider.","schema":{"type":"string","format":"uuid","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"required":true}],"put":{"operationId":"putWalletProvider","tags":["Wallet providers"],"summary":"Update a wallet provider","x-roles":["admin","verifier"],"description":"Updates an existing wallet provider that can present mDocs for online verification.","requestBody":{"description":"Wallet provider payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletProviderRequest"}}}},"responses":{"200":{"description":"Wallet provider updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletProviderResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_START","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_SUCCESS","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_FAIL"]},"get":{"operationId":"getWalletProvider","tags":["Wallet providers"],"summary":"Retrieve a wallet provider","x-roles":["admin","verifier"],"description":"Retrieves an existing wallet provider that can present mDocs for online verification.","responses":{"200":{"description":"Wallet provider retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletProviderResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_START","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteWalletProvider","tags":["Wallet providers"],"summary":"Delete a wallet provider","x-roles":["admin","verifier"],"description":"Deletes an existing wallet provider that can present mDocs for online verification.","responses":{"204":{"description":"Wallet provider deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["PRESENTATION_WALLET_PROVIDER_DELETE_START","PRESENTATION_WALLET_PROVIDER_DELETE_SUCCESS","PRESENTATION_WALLET_PROVIDER_DELETE_FAIL"]}},"/v2/presentations/sessions/{sessionId}":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/sessions/{sessionId}/result":{"parameters":[{"$ref":"#/components/parameters/SessionId"}],"get":{"operationId":"getPresentationResult","tags":["mDocs presentation sessions"],"summary":"Retrieve presentation session result","description":"Retrieves the result of an online presentation session by providing the session's ID.\n\nWhen a holder responds to a verification request, the result indicates whether the presentation succeeded and whether the credentials were verified. The response can be a `PresentationSuccessResult` (holder completed the presentation workflow) or a `PresentationFailureResult` (holder was unable to complete the workflow).\n\nA successful presentation may include verified credentials, credential errors (requested credentials not provided), claim errors (specific claims that failed verification), or a combination of these outcomes.\n\nYour backend should validate that the returned `challenge` matches the challenge generated before starting the session to protect against session replay attacks.\n\nFor detailed information about result structures, error types, and complete examples, see the [handling verification results guide](https://learn.mattr.global/docs/verification/remote-web-verifiers/handling-verification-results).","responses":{"200":{"description":"Session result retrieved","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PresentationSuccessResult"},{"$ref":"#/components/schemas/PresentationFailureResult"}]},"examples":{"successfulVerification":{"summary":"Successful verification","description":"Holder successfully presented a valid mDL with all requested claims verified","value":{"sessionId":"550e8400-e29b-41d4-a716-446655440000","challenge":"c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c","credentialQuery":[{"profile":"mobile","docType":"org.iso.18013.5.1.mDL","nameSpaces":{"org.iso.18013.5.1":{"family_name":{"intentToRetain":false},"given_name":{"intentToRetain":false},"birth_date":{"intentToRetain":false},"address":{"intentToRetain":false}}}}],"credentials":[{"docType":"org.iso.18013.5.1.mDL","claims":{"org.iso.18013.5.1":{"family_name":{"value":"Smith"},"given_name":{"value":"Jane"},"birth_date":{"value":"1990-05-15"},"address":{"value":"123 Main Street, Springfield"}}},"validityInfo":{"signed":"2024-01-15T10:00:00Z","validFrom":"2024-01-15T10:00:00Z","validUntil":"2027-01-15T10:00:00Z","expectedUpdate":"2028-01-15T10:00:00Z"},"verificationResult":{"verified":true},"issuerInfo":{"commonName":"State Department of Motor Vehicles","trustedIssuerId":"d4a6e9f2-3b1c-4d8e-a5f7-9c2b0e8d1a3f"},"branding":{"name":"Driver License","description":"State-issued driver license","backgroundColor":"#1E3A8A"}}]}},"credentialNotProvided":{"summary":"Credential not provided","description":"Holder doesn't have the requested mDL credential","value":{"sessionId":"550e8400-e29b-41d4-a716-446655440000","challenge":"c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c","credentialQuery":[{"profile":"mobile","docType":"org.iso.18013.5.1.mDL","nameSpaces":{"org.iso.18013.5.1":{"family_name":{"intentToRetain":false},"given_name":{"intentToRetain":false}}}}],"credentialErrors":[{"docType":"org.iso.18013.5.1.mDL","errorCode":"notReturned"}]}},"claimErrors":{"summary":"Claim errors","description":"Holder presented an mDL but some requested claims were not returned","value":{"sessionId":"550e8400-e29b-41d4-a716-446655440000","challenge":"c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c","credentialQuery":[{"profile":"mobile","docType":"org.iso.18013.5.1.mDL","nameSpaces":{"org.iso.18013.5.1":{"family_name":{"intentToRetain":false},"given_name":{"intentToRetain":false},"birth_date":{"intentToRetain":false},"portrait":{"intentToRetain":false}}}}],"credentials":[{"docType":"org.iso.18013.5.1.mDL","claims":{"org.iso.18013.5.1":{"family_name":{"value":"Smith"},"given_name":{"value":"Jane"},"birth_date":{"value":"1990-05-15"}}},"claimErrors":{"org.iso.18013.5.1":{"portrait":"notReturned"}},"validityInfo":{"signed":"2024-01-15T10:00:00Z","validFrom":"2024-01-15T10:00:00Z","validUntil":"2027-01-15T10:00:00Z","expectedUpdate":"2028-01-15T10:00:00Z"},"verificationResult":{"verified":true},"issuerInfo":{"commonName":"State Department of Motor Vehicles","trustedIssuerId":"d4a6e9f2-3b1c-4d8e-a5f7-9c2b0e8d1a3f"}}]}},"verificationFailed":{"summary":"Verification failed","description":"Holder presented an mDL but verification failed due to credential expiration","value":{"sessionId":"550e8400-e29b-41d4-a716-446655440000","challenge":"c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c","credentialQuery":[{"profile":"mobile","docType":"org.iso.18013.5.1.mDL","nameSpaces":{"org.iso.18013.5.1":{"family_name":{"intentToRetain":false},"given_name":{"intentToRetain":false}}}}],"credentials":[{"docType":"org.iso.18013.5.1.mDL","verificationResult":{"verified":false,"reason":{"type":"MobileCredentialInvalid","message":"Credential has expired"}},"validityInfo":{"signed":"2024-01-15T10:00:00Z","validFrom":"2024-01-15T10:00:00Z","validUntil":"2025-01-15T10:00:00Z","expectedUpdate":"2026-01-15T10:00:00Z"}}]}},"presentationFailed":{"summary":"Presentation failed","description":"User aborted the session before completing the presentation","value":{"sessionId":"550e8400-e29b-41d4-a716-446655440000","challenge":"c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c","credentialQuery":[{"profile":"mobile","docType":"org.iso.18013.5.1.mDL","nameSpaces":{"org.iso.18013.5.1":{"family_name":{"intentToRetain":false},"given_name":{"intentToRetain":false}}}}],"error":{"type":"SessionAborted","message":"User aborted the session"}}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_START","CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL"]}},"/v2/presentations/ios/sessions/{sessionId}/openid4vp/status":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/ios/sessions/{sessionId}/openid4vp/result":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/ios/sessions/{sessionId}/abort":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/sessions/{sessionId}/requests":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/sessions/{sessionId}/dc-api/response":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/web/sessions/{sessionId}/dc-api/response":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/android/sessions/{sessionId}/dc-api/response":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/ios/sessions/{sessionId}/apple-wallet-api/response":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/certificates/apple-identity-access-certificates":{"post":{"operationId":"postAppleIdentityAccessCertificates","tags":["Apple Identity Access certificates"],"summary":"Create an Apple Identity Access CSR","x-roles":["admin","verifier"],"description":"Creates an Apple Identity Access Certificate Signing Request (CSR) that can be uploaded to the Apple Developer Portal.\n\nThis certificate contains the public key that will be used to decrypt the response from the Apple Wallet.","requestBody":{"description":"Apple Identity Access CSR payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppleIdentityAccessCertificateSigningRequest"}}}},"responses":{"201":{"description":"Apple Identity Access CSR created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppleIdentityAccessCertificateSigningResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_START","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_SUCCESS","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_FAIL"]},"get":{"operationId":"getAppleIdentityAccessCertificates","tags":["Apple Identity Access certificates"],"summary":"Retrieve all Apple Identity Access CSRs","x-roles":["admin","verifier"],"description":"Retrieves all Apple Identity Access CSRs created by the tenant.","responses":{"200":{"description":"Apple Identity Access CSRs retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AppleIdentityAccessCertificateSigningResponse"}}}}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v2/presentations/certificates/apple-identity-access-certificates/{certificateId}":{"parameters":[{"name":"certificateId","in":"path","description":"Unique identifier for the Apple Identity Access CSR.","schema":{"type":"string","format":"uuid","example":"673a20c3-97a3-40dd-b29a-115ff32b02c3","examples":["673a20c3-97a3-40dd-b29a-115ff32b02c3"]},"required":true}],"get":{"operationId":"getAppleIdentityAccessCertificate","tags":["Apple Identity Access certificates"],"summary":"Retrieve an Apple Identity Access CSR","x-roles":["admin","verifier"],"description":"Retrieves an existing Apple Identity Access CSR.","responses":{"200":{"description":"Apple Identity Access Certificate CSR retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppleIdentityAccessCertificateSigningResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_START","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_SUCCESS","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteAppleIdentityAccessCertificate","tags":["Apple Identity Access certificates"],"summary":"Delete an Apple Identity Access CSR","x-roles":["admin","verifier"],"description":"Deletes an existing Apple Identity Access CSR.","responses":{"204":{"description":"Apple Identity Access Certificate CSR deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_START","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_SUCCESS","CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_FAIL"]}},"/v2/presentations/sessions/{sessionId}/abort":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/android/sessions/{sessionId}/openid4vp/status":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/android/sessions/{sessionId}/openid4vp/result":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/android/sessions/{sessionId}/abort":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/web/sessions/{sessionId}/abort":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/sessions/{sessionId}/status":{"parameters":[{"$ref":"#/components/parameters/SessionId"}]},"/v2/presentations/trusted-issuers":{"get":{"security":[],"operationId":"getTrustedIssuers","tags":["Trusted issuers"],"summary":"Retrieve all trusted issuers","description":"Retrieves all configured trusted issuers.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","responses":{"200":{"description":"Trusted issuers retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedIssuersResponse"}}}}},"x-analytic-events":["CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_START","CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_SUCCESS","CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_FAIL"]}},"/v2/credentials/web-semantic/sign":{"post":{"requestBody":{"description":"JSON credential payload to sign","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialSignRequest"}}}},"tags":["JSON credentials issuance"],"summary":"Sign a JSON credential","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"JSON Credential signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialSignResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"signWebSemanticCredentialV2","description":"Returns a signed JSON credential generated from a provided valid payload.","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_SIGN_START","CREDENTIAL_WEB_SEMANTIC_SIGN_SUCCESS","CREDENTIAL_WEB_SEMANTIC_SIGN_FAIL"]}},"/v2/credentials/web-semantic":{"get":{"tags":["JSON credentials management"],"summary":"Retrieve all credential data","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"schema":{"type":"string","example":"identifier123","examples":["identifier123"]},"in":"query","name":"tag","description":"Optional tag to filter on."},{"schema":{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},"in":"query","name":"type","description":"Optional credential type to filter on."},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Credentials data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialsResponse"},"examples":{"List of credential data":{"value":{"nextCursor":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","data":[{"id":"873277c0-a162-11ea-8a1d-a111119347e6","credential":{"@context":["https://www.w3.org/2018/credentials/v1"],"type":["VerifiableCredential","AlumniCredential"],"issuer":{"id":"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5","name":"https://tenant.vii.mattr.global"},"issuanceDate":"2020-05-02T12:06:29.156Z","credentialSubject":{"id":"did:key:z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y","givenName":"Jamie","familyName":"Doe"},"proof":{"type":"Ed25519Signature2018","created":"2020-05-02T12:06:29Z","jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","proofPurpose":"assertionMethod","verificationMethod":"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5#z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y"}},"tag":"identifier123","issuanceDate":"2020-05-02T12:06:29.156Z"},{"id":"9043aa74-eb08-11ea-adc1-0242ac120002","tag":"identifier124","credentialStatus":{"id":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1","type":"RevocationList2020Status","revocationListCredential":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3","revocationListIndex":1},"issuanceDate":"2020-10-06T03:21:02.397Z"}]}}}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"retrieveWebSemanticCredentialListV2","description":"Returns all available data for existing credentials:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`).","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_START","CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_SUCCESS","CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/web-semantic/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Credential ID"}],"get":{"tags":["JSON credentials management"],"summary":"Retrieve credential data","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Credential data retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialResponse"},"examples":{"With persisted credential":{"value":{"id":"873277c0-a162-11ea-8a1d-a111119347e6","credential":{"@context":["https://www.w3.org/2018/credentials/v1"],"type":["VerifiableCredential","AlumniCredential"],"issuer":{"id":"did:web:organization.com","name":"Example University"},"issuanceDate":"2020-05-02T12:06:29.156Z","credentialStatus":{"id":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1","type":"RevocationList2020Status","revocationListCredential":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3","revocationListIndex":4},"credentialSubject":{"givenName":"Jamie","familyName":"Doe"},"proof":{"type":"Ed25519Signature2018","created":"2020-05-02T12:06:29Z","jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","proofPurpose":"assertionMethod","verificationMethod":"did:web:organization.com"}},"tag":"identifier123","credentialStatus":{"id":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1","type":"RevocationList2020Status","revocationListCredential":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3","revocationListIndex":4},"issuanceDate":"2020-05-02T12:06:29.156Z"}},"No persisted credential":{"value":{"id":"9043aa74-eb08-11ea-adc1-0242ac120002","tag":"identifier124","issuanceDate":"2020-05-02T12:06:29.156Z"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveWebSemanticCredentialV2","description":"Returns all available data for an existing credential that matches the provided ID:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`)","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_RETRIEVE_START","CREDENTIAL_WEB_SEMANTIC_RETRIEVE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_RETRIEVE_FAIL"]},"delete":{"tags":["JSON credentials management"],"summary":"Delete credential data","x-roles":["admin","issuer","managed-issuer"],"responses":{"204":{"description":"Credential deleted and revoked if revocable"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"operationId":"removeWebSemanticCredentialV2","description":"Deletes all stored data for an existing credential that matches the provided ID. If the credential is revocable, it will also be permanently revoked.\n\n\nRemoved credential data cannot be recovered.\n","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_DELETE_START","CREDENTIAL_WEB_SEMANTIC_DELETE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_DELETE_FAIL"]}},"/v2/credentials/web-semantic/verify":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyWebSemanticCredentialRequest"}}}},"tags":["JSON credentials verification"],"summary":"Verify a JSON credential","x-roles":["admin","verifier"],"responses":{"200":{"description":"Verification completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyWebSemanticCredentialResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"operationId":"verifyWebSemanticCredentialV2","description":"Verify a JSON credential by providing its payload. The credential is verified against the following criteria:\n- Issuer DID can be resolved, so that the referenced DID Document is available and valid and the public key is obtainable.\n- Proof is valid and the credential has not been tampered with.\n- JSON-LD context is valid for subject claims.\n\nOptional verification checks:\n- If `assertExpiry` is set to `true` and the credential has a set expiration date, verification will fail if the expiration date has passed.\n- If `checkRevocation` is set to `true` and the provided credential contains a revocation status list, verification will fail if the credential has been set to `revoked`.","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_VERIFY_START","CREDENTIAL_WEB_SEMANTIC_VERIFY_SUCCESS","CREDENTIAL_WEB_SEMANTIC_VERIFY_FAIL"]}},"/v2/credentials/web-semantic/{id}/revocation-status":{"post":{"tags":["JSON credentials management"],"summary":"Set credential revocation status","x-roles":["admin","issuer","managed-issuer"],"description":"Sets the revocation status of the credential that matches the provided ID as `true` (revoked) or `false` (unrevoked).","requestBody":{"description":"Setting the revocation status","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetRevocationStatus"},"examples":{"Example":{"value":{"isRevoked":true}}}}}},"responses":{"200":{"description":"Revocation status updated"},"404":{"$ref":"#/components/responses/404"}},"operationId":"setWebSemanticCredentialRevocationStatusV2","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_START","CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS","CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_FAIL"]},"parameters":[{"schema":{"type":"string","format":"uuid","example":"a80a5e7e-1972-4be6-8a4e-2adf09badf24","examples":["a80a5e7e-1972-4be6-8a4e-2adf09badf24"]},"name":"id","in":"path","required":true,"description":"Credential ID"}],"get":{"tags":["JSON credentials management"],"summary":"Retrieve credential revocation status","x-roles":["admin","issuer","managed-issuer"],"responses":{"200":{"description":"Credential status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevocationStatusResponse"},"examples":{"Revocation Status":{"value":{"isRevoked":false}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"getWebSemanticCredentialRevocationStatusV2","description":"Returns the revocation status of the credential matching the provided ID.","x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_START","CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_FAIL"]}},"/v2/credentials/web-semantic/revocation-lists/{id}":{"get":{"security":[],"tags":["JSON credentials management"],"summary":"Retrieve revocation list","description":"Retrieves a JSON credential revocation list by providing its ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","responses":{"200":{"description":"Revocation list retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifiableCredential"},"examples":{"Revocation List":{"value":{"id":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3","@context":["https://www.w3.org/2018/credentials/v1","https://w3id.org/vc-revocation-list-2020/v1"],"type":["VerifiableCredential","RevocationList2020Credential"],"issuer":"did:web:organization.com","issuanceDate":"2020-05-02T12:06:29.156Z","credentialSubject":{"type":"RevocationList2020","encodedList":"H4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA"},"proof":{"type":"Ed25519Signature2018","created":"2020-05-02T12:06:29Z","jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","proofPurpose":"assertionMethod","verificationMethod":"did:web:organization.com#CU6dJt9p8t"}}}}}}},"404":{"$ref":"#/components/responses/404"}},"operationId":"retrieveWebSemanticCredentialRevocationListV2"},"parameters":[{"schema":{"type":"string","format":"uuid","example":"cc641396-3750-43c8-b8b8-f30d74eb3fb3","examples":["cc641396-3750-43c8-b8b8-f30d74eb3fb3"]},"name":"id","in":"path","required":true,"description":"Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/v1/revocation-lists/` is what you're looking for"}]},"/v2/credentials/web-semantic/{id}/revocation-status/notification":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"873277c0-a162-11ea-8a1d-a111119347e6","examples":["873277c0-a162-11ea-8a1d-a111119347e6"]},"description":"Unique identifier for the credential whose status has changed."}],"post":{"summary":"Create a revocation message payload","x-roles":["admin","issuer","managed-issuer"],"operationId":"createWebSemanticCredentialRevNotificationV2","responses":{"201":{"description":"Revocation message payload created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevocationStatusNotification"}}}}},"description":"Returns a message in JWM format that can be used to notify subjects based on their credential revocation status change.\n\nTo send a notification to the Subject DID holder, use the returned payload with the [encrypt](#operation/encryptMessage) and [send](#operation/sendMessage) endpoints.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayloadRequest"}}},"description":"Create a JWM message payload"},"tags":["JSON credentials management"],"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_START","CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_FAIL"]}},"/v2/credentials/web-semantic/presentations/templates":{"post":{"operationId":"createPresTemplateV2","tags":["JSON credentials verification"],"summary":"Create a presentation template","x-roles":["admin","verifier"],"description":"Creates a presentation template defining what type of credential is required for a particular verification workflow. Presentation templates are used to create presentation requests that are shared with a specific holder.","requestBody":{"description":"The template","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationTemplate"},"examples":{"Query by Example":{"value":{"domain":"tenant.vii.mattr.global","name":"alumni_credential_request","query":[{"type":"QueryByExample","credentialQuery":[{"required":true,"reason":"We need you to prove your alumni membership.","example":{"@context":["https://optionalschema.example/"],"type":"AlumniCredential","trustedIssuer":[{"required":true,"issuer":"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5"}]}}]}]}},"Query by Frame":{"value":{"domain":"tenant.vii.mattr.global","name":"zkp-certificate-presentation","query":[{"type":"QueryByFrame","credentialQuery":[{"reason":"Please provide your educational award and surname from your Certificate","frame":{"@context":["https://www.w3.org/2018/credentials/v1","https://w3id.org/vc-revocation-list-2020/v1","https://optionalschema.example/"],"type":["VerifiableCredential","AlumniCredential"],"credentialSubject":{"@explicit":true,"educationalCredentialAwarded":{},"familyName":{}}},"trustedIssuer":[{"issuer":"did:key:zUC7KmMGXt7fs9URk9EDqWLfpCjVTtfFMexViLLkPPUfm9j4heqvk9JkLarva3sP54FGjFNLpwc63ZTef2aR2cPssFbyDj75kopYqWL16j7JigA2BAvJcwnaKvKPUybxbroRg1v","required":true}],"required":true}]}]}},"DID Auth":{"value":{"name":"did-auth","domain":"tenant.vii.mattr.global","query":[{"type":"DIDAuth"}]}}}}}},"responses":{"201":{"description":"Presentation template created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplateResponse"},"examples":{"Created":{"value":{"id":"364b6a1b-3600-4927-a6ac-4d66aa6bbac3","domain":"tenant.vii.mattr.global","name":"alumni_credential_request","query":[{"type":"QueryByExample","credentialQuery":[{"required":true,"reason":"We need you to prove your alumni membership.","example":{"@context":["https://optionalschema.example/"],"type":"AlumniCredential","trustedIssuer":[{"required":true,"issuer":"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5"}]}}]}]}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_START","PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_SUCCESS","PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_FAIL"]},"get":{"operationId":"retrievePresTemplatesV2","tags":["JSON credentials verification"],"summary":"Retrieve all presentation templates","x-roles":["admin","verifier"],"description":"Returns a list of all presentation templates on your tenant.","responses":{"200":{"description":"Presentation templates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplateArrayResponse"}}}}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_START","PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_SUCCESS","PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/web-semantic/presentations/templates/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"Presentation template ID","schema":{"type":"string"}}],"get":{"operationId":"retrievePresTemplateV2","tags":["JSON credentials verification"],"summary":"Retrieve a presentation template","x-roles":["admin","verifier"],"description":"Retrieve an existing presentation template by its ID.","responses":{"200":{"description":"Presentation template retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_START","PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_SUCCESS","PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_FAIL"]},"delete":{"operationId":"removePresTemplateV2","tags":["JSON credentials verification"],"summary":"Delete a presentation template","x-roles":["admin","verifier"],"description":"Deletes an existing presentation template by its ID.","responses":{"204":{"description":"Presentation template deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_START","PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_SUCCESS","PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_FAIL"]},"put":{"summary":"Update a presentation template","x-roles":["admin","verifier"],"operationId":"updatePresTemplateV2","tags":["JSON credentials verification"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PresentationTemplateResponse"}}}}},"description":"Updates an existing presentation template by its ID.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePresentationTemplate"}}},"description":""},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_START","PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_SUCCESS","PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_FAIL"]}},"/v2/credentials/web-semantic/presentations/requests":{"post":{"operationId":"createPresRequestV2","tags":["JSON credentials verification"],"summary":"Create a presentation request","x-roles":["admin","verifier"],"description":"Creates a short lived presentation request based on an existing presentation template. The request is returned in the form of a JWM message and must be [signed](#operation/signMessage) and sent to the holder via one of the following methods:\n- QR code.\n- Deeplink.\n- [Encrypted](#operation/encryptMessage) and [sent](#operation/sendMessage) as a wallet notification.","requestBody":{"description":"The presentation request payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationRequestRequest"}}}},"responses":{"201":{"description":"Presentation request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresentationRequestResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_START","PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_SUCCESS","PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_FAIL"]},"parameters":[]},"/v2/credentials/web-semantic/presentations/verify":{"post":{"summary":"Verify a verifiable presentation","x-roles":["admin","verifier"],"operationId":"verifyPresV2","responses":{"200":{"description":"Presentation verification completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyPresentation"},"examples":{"Verified":{"value":{"verified":true}},"Invalid":{"value":{"verified":false,"reason":"Credential is invalid"}}}}}},"400":{"$ref":"#/components/responses/400"}},"tags":["JSON credentials verification"],"description":"Verifies a provided verifiable presentation that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations):\n- Ensures the presentation conforms to the VC Data model.\n- For each `verifiableCredential` objects:\n - Issuer DID can be resolved.\n - JSON-LD context is valid for subject claims.\n - Proof is valid & the credential has not been tampered with.\n - Is not in a `revoked` status on a `RevocationList2020`.\n - The proof is valid for each subjectDID to prove ownership.\n - Valid proof exists for the presentation `holderDID`.\n\nThe request must include a `presentation` object that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations).\n\nIf a `challenge` and/or `domain` is provided they are used for credential verification. Otherwise, the `challenge` and/or `domain` within the presentation proof is used instead.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifiablePresentation"}}},"description":"Presentation to verify"},"x-analytic-events":["PRESENTATION_WEB_SEMANTIC_VERIFY_START","PRESENTATION_WEB_SEMANTIC_VERIFY_SUCCESS","PRESENTATION_WEB_SEMANTIC_VERIFY_FAIL"]},"parameters":[]},"/v2/credentials/web-semantic/configurations":{"post":{"operationId":"createWebSemanticCredentialConfiguration","tags":["JSON credentials configuration"],"summary":"Create a JSON credentials configuration","x-roles":["admin","issuer"],"description":"Creates a new JSON credentials configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.","requestBody":{"description":"The credential configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationRequest"}}}},"responses":{"201":{"description":"JSON credentials configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL"]},"get":{"operationId":"getWebSemanticCredentialConfigurations","tags":["JSON credentials configuration"],"summary":"Retrieve all JSON credentials configurations","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all JSON credential configurations on your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"schema":{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},"in":"query","name":"type","description":"The optional credential type to filter on"}],"responses":{"200":{"description":"JSON credentials configurations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebSemanticCredentialConfigurationsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v2/credentials/web-semantic/configurations/{id}":{"parameters":[{"name":"id","in":"path","description":"JSON credentials configuration unique identifier","schema":{"type":"string","format":"uuid","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"required":true}],"get":{"operationId":"getWebSemanticCredentialConfiguration","tags":["JSON credentials configuration"],"summary":"Retrieve a JSON credentials configuration","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieve a JSON credentials configuration by providing its ID.","responses":{"200":{"description":"JSON credentials configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL"]},"put":{"operationId":"updateWebSemanticCredentialConfiguration","tags":["JSON credentials configuration"],"summary":"Update a JSON credentials configuration","x-roles":["admin","issuer"],"description":"Updates an existing JSON credentials configuration by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationRequest"}}},"description":"Update a credential configuration"},"responses":{"200":{"description":"JSON credentials configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL"]},"delete":{"operationId":"deleteWebSemanticCredentialConfiguration","tags":["JSON credentials configuration"],"summary":"Delete a JSON credentials configuration","x-roles":["admin","issuer"],"description":"Deletes an existing JSON credentials configuration by providing its ID.","responses":{"204":{"description":"JSON credentials configuration deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"description":"The credential configuration is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Credential configuration not found":{"value":{"code":"NotFound","message":"Validation Error","details":[{"location":"params","msg":"Resource Not Found","param":"id","value":"638c5634-fb06-403a-bb00-ddb867ea9063"}]}}}}}}},"x-analytic-events":["CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS","CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL"]}},"/v1/holder/applications":{"post":{"operationId":"postHolderApplication","tags":["Holder applications"],"summary":"Create a holder application","x-roles":["admin","holder"],"description":"Creates a holder application. Once created, application instances can be registered and interact with the MATTR VII platform (for example, to claim credentials).","requestBody":{"description":"Holder application payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationRequest"}}}},"responses":{"201":{"description":"Holder application created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_CREATE_START","CREDENTIAL_HOLDER_APPLICATION_CREATE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_CREATE_FAIL"]},"get":{"operationId":"getHolderApplications","tags":["Holder applications"],"summary":"Retrieve all holder applications","x-roles":["admin","holder"],"description":"Retrieves all configured holder applications.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Holder applications retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"$ref":"#/components/schemas/nextCursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/HolderApplicationResponse"}}}}}}}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_LIST_START","CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_LIST_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_LIST_FAIL"]}},"/v1/holder/applications/{holderApplicationId}":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}],"put":{"operationId":"putHolderApplication","tags":["Holder applications"],"summary":"Update a holder application","x-roles":["admin","holder"],"description":"Updates an existing holder application.","requestBody":{"description":"Holder application payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationRequest"}}}},"responses":{"200":{"description":"Holder application updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_UPDATE_START","CREDENTIAL_HOLDER_APPLICATION_UPDATE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_UPDATE_FAIL"]},"get":{"operationId":"getHolderApplication","tags":["Holder applications"],"summary":"Retrieve a holder application","x-roles":["admin","holder"],"description":"Retrieves an existing holder application.","responses":{"200":{"description":"Holder application retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_START","CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_RETRIEVE_FAIL"]},"delete":{"operationId":"deleteHolderApplication","tags":["Holder applications"],"summary":"Delete a holder application","x-roles":["admin","holder"],"description":"Deletes an existing holder application. Once deleted, any associated application instances will no longer be able to interact with the MATTR VII platform.","responses":{"204":{"description":"Holder application deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_DELETE_START","CREDENTIAL_HOLDER_APPLICATION_DELETE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_DELETE_FAIL"]}},"/v1/holder/applications/{holderApplicationId}/android/instances/register":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/applications/{holderApplicationId}/ios/instances/register":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/applications/{holderApplicationId}/android/instances/token":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/applications/{holderApplicationId}/ios/instances/token":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/applications/{holderApplicationId}/instances":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}],"get":{"operationId":"getHolderApplicationInstances","tags":["Holder applications"],"summary":"Retrieve all registered holder application instances","x-roles":["admin","holder"],"description":"Retrieves all registered instances of a holder application.\n\nThis can be used by application owners to view all registered instances for a given holder application.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Holder application instances retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"$ref":"#/components/schemas/nextCursor"},"data":{"type":"array","items":{"$ref":"#/components/schemas/HolderApplicationInstanceResponse"}}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_LIST_START","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_LIST_FAIL"]}},"/v1/holder/applications/{holderApplicationId}/instances/{instanceId}":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"},{"$ref":"#/components/parameters/holderApplicationInstanceId"}],"delete":{"operationId":"deleteHolderApplicationInstance","tags":["Holder applications"],"summary":"Delete a registered holder application instance","x-roles":["admin","holder"],"description":"Deletes a registered instance of a holder application.\n\nDeleted instances will no longer be able to interact with the platform or receive tokens, and any existing tokens will be revoked.\n\nApplication owners can use this endpoint to remove individual instances that are no longer needed or were registered by mistake, without affecting the entire holder application or its other instances. This is useful for cleaning up test instances or managing specific devices, rather than deleting the whole application and all its associated instances.","responses":{"204":{"description":"Holder application instance deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_START","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_DELETE_FAIL"]},"get":{"operationId":"getHolderApplicationInstance","tags":["Holder applications"],"summary":"Retrieve a registered holder application instance","x-roles":["admin","holder"],"description":"Retrieves a registered instance of a holder application.","responses":{"200":{"description":"Holder application instance retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderApplicationInstanceResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_START","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_SUCCESS","CREDENTIAL_HOLDER_APPLICATION_INSTANCE_RETRIEVE_FAIL"]}},"/v1/holder/applications/{holderApplicationId}/instances/wallet-attestation/register":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/applications/{holderApplicationId}/instances/wallet-attestation/token":{"parameters":[{"$ref":"#/components/parameters/holderApplicationId"}]},"/v1/holder/certificates/ca":{"post":{"tags":["Holder root CA certificates"],"summary":"Create a holder root CA certificate","x-roles":["admin","holder"],"description":"Creates a holder root CA certificate that is used to issue wallet attestation signer certificates.\n\nTwo flows are supported:\n- **Managed** — MATTR VII generates the root certificate and manages the private key on the customer's behalf. Supply no `certificatePem` in the request body; `commonName` and `country` are optional.\n- **Unmanaged** — the customer supplies their own externally-managed root CA in PEM format. `commonName` and `country` are extracted from the certificate and must not be provided in the request.\n\nA maximum of three holder root CA certificates can be created per tenant. Only one can be active at a time.\n\nThe newly-created root is always inactive. Activate it by issuing `PUT /v1/holder/certificates/ca/{certificateId}` with `{ \"active\": true }`, which also deactivates any previously active root for the tenant (single-active constraint).","operationId":"createHolderCaCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/HolderCaCreateRequestManaged"},{"not":{"required":["certificatePem"]}}]},{"allOf":[{"$ref":"#/components/schemas/HolderCaCreateRequestUnmanaged"},{"required":["certificatePem"]}]}]}}}},"responses":{"201":{"description":"Holder root CA certificate created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"409":{"description":"Maximum number of holder root CA certificates reached. Delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"$ref":"#/components/responses/503"}},"x-analytic-events":["CREDENTIAL_HOLDER_CA_CERTIFICATE_CREATE_START","CREDENTIAL_HOLDER_CA_CERTIFICATE_CREATE_SUCCESS","CREDENTIAL_HOLDER_CA_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["Holder root CA certificates"],"summary":"Retrieve all holder root CA certificates","x-roles":["admin","holder"],"description":"Retrieves all holder root CA certificates for the tenant.","operationId":"getHolderCaCertificates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Holder root CA certificates retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HolderCaResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_LIST_START","CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/holder/certificates/ca/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/holderCaCertificateId"}],"get":{"tags":["Holder root CA certificates"],"summary":"Retrieve a holder root CA certificate","x-roles":["admin","holder"],"description":"Retrieves a holder root CA certificate by ID.","operationId":"getHolderCaCertificate","responses":{"200":{"description":"Holder root CA certificate retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderCaResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_START","CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_SUCCESS","CREDENTIAL_HOLDER_CA_CERTIFICATE_RETRIEVE_FAIL"]},"put":{"tags":["Holder root CA certificates"],"summary":"Update a holder root CA certificate","x-roles":["admin","holder"],"description":"Updates a holder root CA certificate. The only mutable field is `active`.\n\nSetting `active: true` deactivates all other roots for the tenant (single-active constraint).","operationId":"updateHolderCaCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderCaUpdateRequest"}}}},"responses":{"200":{"description":"Holder root CA certificate updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HolderCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_CA_CERTIFICATE_UPDATE_START","CREDENTIAL_HOLDER_CA_CERTIFICATE_UPDATE_SUCCESS","CREDENTIAL_HOLDER_CA_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["Holder root CA certificates"],"summary":"Delete a holder root CA certificate","x-roles":["admin","holder"],"description":"Deletes a holder root CA certificate and cascade-deletes all associated signer certificates. For managed roots and signers, MATTR VII also removes the private key material it was holding on the customer's behalf.\n\nDeletion does not invalidate any wallet attestation JWTs that were issued under this root. Those JWTs remain cryptographically valid until their natural expiry — verifiers that have already cached the signer's public key may continue to accept them. CRL-based revocation of issued attestations is not supported in this release.","operationId":"deleteHolderCaCertificate","responses":{"204":{"description":"Holder root CA certificate deleted."},"404":{"$ref":"#/components/responses/404"},"503":{"$ref":"#/components/responses/503"}},"x-analytic-events":["CREDENTIAL_HOLDER_CA_CERTIFICATE_DELETE_START","CREDENTIAL_HOLDER_CA_CERTIFICATE_DELETE_SUCCESS","CREDENTIAL_HOLDER_CA_CERTIFICATE_DELETE_FAIL"]}},"/v1/holder/certificates/ca/{certificateId}/crl":{"parameters":[{"$ref":"#/components/parameters/holderCaCertificateId"}],"get":{"security":[],"tags":["Holder root CA certificates"],"summary":"Retrieve a holder root CA certificate revocation list","description":"Retrieves the Certificate Revocation List (CRL) for a managed holder root CA certificate, as a DER-encoded binary document.\n\nThis endpoint is only available for managed roots — for unmanaged roots it returns `404 NoCertificateRevocationList`.","operationId":"getHolderCaCertificateRevocationList","responses":{"200":{"description":"Holder root CA certificate revocation list retrieved.","content":{"application/pkix-crl":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"},"503":{"$ref":"#/components/responses/503"}}}},"/v1/holder/certificates/wallet-attestation-signers":{"post":{"tags":["Wallet attestation signers"],"summary":"Create a wallet attestation signer","x-roles":["admin","holder"],"description":"Creates a wallet attestation signer for an unmanaged root CA and returns its Certificate Signing Request (CSR).\n\nThis endpoint is only available for unmanaged roots — managed root signers are auto-provisioned on demand during the first wallet attestation request and never need to be created explicitly.\n\nThe returned signer is created with `active: false`; use the CSR to obtain a signed certificate externally and upload it via `PUT /v1/holder/certificates/wallet-attestation-signers/{certificateId}` to activate the signer.\n\nA maximum of five wallet attestation signers can be created per root.","operationId":"createWalletAttestationSigner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletAttestationSignerCreateRequest"}}}},"responses":{"201":{"description":"Wallet attestation signer created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletAttestationSignerResponse"}}}},"400":{"description":"Bad request. The request was malformed, missing required parameters, or the target root is managed (managed signers are auto-provisioned and cannot be created via this endpoint).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Maximum number of wallet attestation signers for this root has been reached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"$ref":"#/components/responses/503"}},"x-analytic-events":["CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_CREATE_START","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_CREATE_SUCCESS","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["Wallet attestation signers"],"summary":"Retrieve all wallet attestation signers","x-roles":["admin","holder"],"description":"Retrieves all wallet attestation signers for the tenant across all roots.\n\nThe response may contain a mix of:\n- CSR-pending signers (unmanaged, certificate not yet uploaded)\n- Active signers (managed or unmanaged with an uploaded certificate)","operationId":"getWalletAttestationSigners","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Wallet attestation signers retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/WalletAttestationSignerResponse"},{"$ref":"#/components/schemas/CreateWalletAttestationSignerResponse"}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_LIST_START","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/holder/certificates/wallet-attestation-signers/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/walletAttestationSignerId"}],"get":{"tags":["Wallet attestation signers"],"summary":"Retrieve a wallet attestation signer","x-roles":["admin","holder"],"description":"Retrieves a wallet attestation signer by ID. The response shape depends on the signer's state — CSR-pending signers return a CSR, signers with a signed certificate return the full certificate details.","operationId":"getWalletAttestationSigner","responses":{"200":{"description":"Wallet attestation signer retrieved.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WalletAttestationSignerResponse"},{"$ref":"#/components/schemas/CreateWalletAttestationSignerResponse"}]}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_START","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_RETRIEVE_FAIL"]},"put":{"tags":["Wallet attestation signers"],"summary":"Update a wallet attestation signer","x-roles":["admin","holder"],"description":"Updates a wallet attestation signer by:\n- Uploading a signed certificate PEM that matches the signer's CSR (first-time upload for CSR-pending signers only).\n- Activating or deactivating the signer. Only signers with a valid PEM certificate can be activated.\n\n`certificatePem` is immutable after the first upload — subsequent PUT requests may only toggle `active`.","operationId":"updateWalletAttestationSigner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletAttestationSignerUpdateRequest"}}}},"responses":{"200":{"description":"Wallet attestation signer updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletAttestationSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_UPDATE_START","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_UPDATE_SUCCESS","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["Wallet attestation signers"],"summary":"Delete a wallet attestation signer","x-roles":["admin","holder"],"description":"Deletes a wallet attestation signer. For managed signers, MATTR VII also removes the private key material it was holding on the customer's behalf.","operationId":"deleteWalletAttestationSigner","responses":{"204":{"description":"Wallet attestation signer deleted."},"404":{"$ref":"#/components/responses/404"},"503":{"$ref":"#/components/responses/503"}},"x-analytic-events":["CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_DELETE_START","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_DELETE_SUCCESS","CREDENTIAL_HOLDER_WALLET_ATTESTATION_SIGNER_CERTIFICATE_DELETE_FAIL"]}},"/v1/oauth/authorize":{"get":{"operationId":"getOauthAuthorize","tags":["Credential issuance"],"summary":"Request authorization for access to resources","description":"This endpoint is used to request authorization from the user for access to the requested resources. After the user approves the request, an authorization code is returned to the client.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint)\nSee [https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1)","security":[],"parameters":[{"name":"response_type","in":"query","description":"The response type, which must be 'code'.","required":true,"schema":{"type":"string","enum":["code"]}},{"name":"client_id","in":"query","description":"The client identifier.","required":true,"schema":{"type":"string"}},{"name":"redirect_uri","in":"query","description":"The URI to which the authorization server will redirect the user-agent with the authorization code.","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","description":"The scope of the access request.","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"An opaque value used by the client to maintain state between the request and callback.","schema":{"type":"string"}},{"name":"code_challenge_method","in":"query","description":"The method used to derive the code_challenge, which must be 'S256'.","required":true,"schema":{"type":"string","enum":["S256"]}},{"name":"code_challenge","in":"query","description":"A high entropy random challenge generated by the client.","required":true,"schema":{"type":"string"}}],"responses":{"302":{"description":"Redirection to client application with authorization code","headers":{"Location":{"description":"URL to redirect to with the authorization code","schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["OPENID_AUTHORIZE_START","OPENID_AUTHORIZE_SUCCESS","OPENID_AUTHORIZE_FAIL"]}},"/v1/oauth/token":{"post":{"operationId":"postOauthToken","tags":["Credential issuance"],"summary":"Exchange authorization code for access token","description":"This endpoint is used to exchange an authorization code or a pre-authorized code for an access token, which is later used to request a credential.\n\n- In an Authorization Code flow the authorization code is obtained from the authorization endpoint after the user has successfully authenticated. \n- In a Pre-authorized Code flow the pre-authorized code is obtained from the offer URI.\n\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint) for more information.","security":[],"parameters":[{"$ref":"#/components/parameters/DPoP"},{"$ref":"#/components/parameters/OAuthClientAttestationPoP"},{"name":"OAuth-Client-Attestation","in":"header","required":false,"description":"$194","schema":{"type":"string","example":"eyJhbGciOiJFUzI1NiIsInR5cCI6Im9hdXRoLWNsaWVudC1hdHRlc3RhdGlvbi1wb3Arand0In0.eyJhdWQiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwiLCJqdGkiOiI2ZmU2ZWMwMi00NGRlLTQ0OTktYWFiYy1iNzZiNzRiMzJjZjciLCJpYXQiOjE3NzA4Njc1ODh9.NBMLwAa65ICxE_nwsZoJeuyFmCFWV-1s7anheUC-qTtL4ZdOE5sfzS1_v_GourNUTTdtszIJTfhYYnRhwB7t6A","examples":["eyJhbGciOiJFUzI1NiIsInR5cCI6Im9hdXRoLWNsaWVudC1hdHRlc3RhdGlvbi1wb3Arand0In0.eyJhdWQiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwiLCJqdGkiOiI2ZmU2ZWMwMi00NGRlLTQ0OTktYWFiYy1iNzZiNzRiMzJjZjciLCJpYXQiOjE3NzA4Njc1ODh9.NBMLwAa65ICxE_nwsZoJeuyFmCFWV-1s7anheUC-qTtL4ZdOE5sfzS1_v_GourNUTTdtszIJTfhYYnRhwB7t6A"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"oneOf":[{"type":"object","title":"Authorization Code flow","properties":{"client_id":{"type":"string","description":"The client identifier."},"grant_type":{"type":"string","description":"The grant type, which must be 'authorization_code'.","enum":["authorization_code"]},"redirect_uri":{"type":"string","description":"The redirect URI that was used in the authorization request."},"code":{"type":"string","description":"The authorization code obtained from the authorization endpoint."},"code_verifier":{"type":"string","description":"SHA256 hash of the `code_challenge` in the authorization request."}},"required":["client_id","grant_type","redirect_uri","code","code_verifier"]},{"type":"object","title":"Pre-authorized Code flow","properties":{"client_id":{"type":"string","description":"The client identifier."},"grant_type":{"type":"string","description":"The grant type, which must be 'urn:ietf:params:oauth:grant-type:pre-authorized_code'.","enum":["urn:ietf:params:oauth:grant-type:pre-authorized_code"]},"pre-authorized_code":{"type":"string","description":"The pre-authorized code obtained from the pre-authorized offer URI"},"tx_code":{"type":"string","description":"The transaction code obtained from the pre-authorized offer URI."}},"required":["client_id","grant_type","pre-authorized_code"]}]}}}},"responses":{"200":{"description":"Access token successfully returned.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Opaque Access Token","properties":{"access_token":{"type":"string","description":"The access token issued by the authorization server.","example":"KrrFP8GUeddJJtj7EF-4ugdvCl-dDdWwOqvAbvYsmfy","examples":["KrrFP8GUeddJJtj7EF-4ugdvCl-dDdWwOqvAbvYsmfy"]},"token_type":{"type":"string","description":"The type of the token, which is always 'Bearer'.","enum":["Bearer"]},"expires_in":{"type":"integer","description":"The number of seconds until the token expires.","example":900,"examples":[900]},"scope":{"type":"string","description":"The scope of the access token.","example":"mso_mdoc:org.iso.18013.5.1.mDL","examples":["mso_mdoc:org.iso.18013.5.1.mDL"]}},"required":["access_token","token_type","expires_in","scope"]}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["OPENID_TOKEN_START","OPENID_TOKEN_SUCCESS","OPENID_TOKEN_FAIL"]}},"/v1/openid/credential":{"post":{"operationId":"postOpenIdCredential","summary":"Issue a verifiable credential","tags":["Credential issuance"],"description":"$195","security":[{"bearerAuthOpenIdCredentials":[]},{"dpopAuthOpenIdCredentials":[]}],"parameters":[{"$ref":"#/components/parameters/DPoP"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Credential request payload for unencrypted credential requests","oneOf":[{"$ref":"#/components/schemas/ldpvcIssueCredentialRequest"},{"$ref":"#/components/schemas/cwtIssueCredentialRequest"},{"$ref":"#/components/schemas/cwtvcIssueCredentialRequest"},{"$ref":"#/components/schemas/msomdocIssueCredentialRequest"},{"$ref":"#/components/schemas/deprecatedLdpvcIssueCredentialRequest"},{"$ref":"#/components/schemas/deprecatedCwtIssueCredentialRequest"},{"$ref":"#/components/schemas/deprecatedCwtvcIssueCredentialRequest"},{"$ref":"#/components/schemas/deprecatedMsomdocIssueCredentialRequest"}]},"examples":{"web-semantic":{"summary":"Request to issue a JSON credential","value":{"credential_configuration_id":"2cdb2c15-39a7-4556-abab-4515ce2d831b","proofs":{"jwt":["eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."]}}},"compact-semantic":{"summary":"Request to issue a Semantic CWT credential","value":{"credential_configuration_id":"2cdb2c15-39a7-4556-abab-4515ce2d831b"}},"compact":{"summary":"Request to issue a CWT credential","value":{"credential_configuration_id":"2cdb2c15-39a7-4556-abab-4515ce2d831b"}},"mobile-credential":{"summary":"Request to issue an mDocs credential","value":{"credential_configuration_id":"2cdb2c15-39a7-4556-abab-4515ce2d831b","proofs":{"jwt":["eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."]}}},"web-semantic-deprecated":{"summary":"Request to issue a JSON credential (deprecated)","value":{"format":"ldp_vc","credential_definition":{"type":["VerifiableCredential","AlumniCredential"],"@context":["https://www.w3.org/2018/credentials/v1"]},"proof":{"proof_type":"jwt","jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."}}},"compact-semantic-deprecated":{"summary":"Request to issue a Semantic CWT credential (deprecated)","value":{"format":"cwt_vc","types":["VerifiableCredential","AlumniCredential"]}},"compact-deprecated":{"summary":"Request to issue a CWT credential (deprecated)","value":{"format":"cwt","type":"AlumniCredential"}},"mobile-credential-deprecated":{"summary":"Request to issue an mDocs credential (deprecated)","value":{"format":"mso_mdoc","doctype":"org.iso.18013.5.1.mDL","proof":{"proof_type":"jwt","jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."}}}}},"application/jwt":{"schema":{"type":"string","description":"JSON Web Encryption (JWE) formatted credential request payload for encrypted credential requests"},"examples":{"mobile-credential":{"summary":"Request to issue an mDocs credential with encryption","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."}}}}},"responses":{"200":{"description":"Credential issued","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ldpvcSupportedCredentialResponse"},{"$ref":"#/components/schemas/msomdocIssueCredentialResponse"},{"$ref":"#/components/schemas/cwtvcIssueCredentialResponse"},{"$ref":"#/components/schemas/cwtIssueCredentialResponse"},{"$ref":"#/components/schemas/deprecatedLdpvcSupportedCredentialResponse"},{"$ref":"#/components/schemas/deprecatedMsomdocIssueCredentialResponse"},{"$ref":"#/components/schemas/deprecatedCwtvcIssueCredentialResponse"},{"$ref":"#/components/schemas/deprecatedCwtIssueCredentialResponse"}]},"examples":{"web-semantic":{"summary":"Response to issue a JSON credential","value":{"credentials":[{"credential":{"@context":["https://www.w3.org/2018/credentials/v1"],"id":"http://example.edu/credentials/3732","type":["VerifiableCredential","AlumniCredential"],"issuer":"https://example.edu/issuers/14","issuanceDate":"2020-03-10T04:24:12.164Z","credentialSubject":{"id":"did:example:123","alumniOf":"Example University"},"proof":{"type":"RsaSignature2018","created":"2020-03-10T04:24:12Z","proofPurpose":"assertionMethod","verificationMethod":"https://example.edu/issuers/keys/1","jws":"EXAMPLE_JWS_TOKEN_eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9aH0..."}}}]}},"compact-semantic":{"summary":"Response to issue a Semantic CWT credential","value":{"credentials":[{"credential":"h4sIAAAAAAAAE+3BMQEAAAgDoJvcK3+gAAAAAAAAAAAAAAAAAAAAAAA","pdf":"JVBERi0xLjQKJcfs... (optional)"}]}},"compact":{"summary":"Response to issue a CWT credential","value":{"credentials":[{"credential":"h4sIAAAAAAAAE+3BMQEAAAgDoJvcK3+gAAAAAAAAAAAAAAAAAAAAAAA","pdf":"JVBERi0xLjQKJcfs... (optional)"}]}},"mobile-credential":{"summary":"Response to issue an mDocs credential","value":{"credentials":[{"credential":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."}]}},"web-semantic-deprecated":{"summary":"Response to issue a JSON credential (deprecated)","value":{"credential":{"@context":["https://www.w3.org/2018/credentials/v1"],"id":"http://example.edu/credentials/3732","type":["VerifiableCredential","AlumniCredential"],"issuer":"https://example.edu/issuers/14","issuanceDate":"2020-03-10T04:24:12.164Z","credentialSubject":{"id":"did:example:123","alumniOf":"Example University"},"proof":{"type":"RsaSignature2018","created":"2020-03-10T04:24:12Z","proofPurpose":"assertionMethod","verificationMethod":"https://example.edu/issuers/keys/1","jws":"EXAMPLE_JWS_TOKEN_eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9aH0..."}},"format":"ldp_vc"}},"compact-semantic-deprecated":{"summary":"Response to issue a Semantic CWT credential (deprecated)","value":{"credential":"h4sIAAAAAAAAE+3BMQEAAAgDoJvcK3+gAAAAAAAAAAAAAAAAAAAAAAA","format":"cwt_vc","pdf":"JVBERi0xLjQKJcfs... (optional)"}},"compact-deprecated":{"summary":"Response to issue a CWT credential (deprecated)","value":{"credential":"h4sIAAAAAAAAE+3BMQEAAAgDoJvcK3+gAAAAAAAAAAAAAAAAAAAAAAA","format":"cwt","pdf":"JVBERi0xLjQKJcfs... (optional)"}},"mobile-credential-deprecated":{"summary":"Response to issue an mDocs credential (deprecated)","value":{"credential":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...","format":"mso_mdoc"}}}},"application/jwt":{"schema":{"type":"string","description":"JSON Web Encryption (JWE) formatted issued credential"},"examples":{"mobile-credential":{"summary":"Issued mDocs credential with encryption","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."}}}}}},"x-analytic-events":["OPENID_CREDENTIAL_START","OPENID_CREDENTIAL_SUCCESS","OPENID_CREDENTIAL_FAIL"]}},"/v1/openid/offers":{"post":{"operationId":"postOpenIdOffers","tags":["Credential offers"],"summary":"Create an Authorization Code credential offer","x-roles":["admin","issuer","managed-issuer"],"description":"Returns an OID4VCI credential offer URI.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1)\n\nThis offer can be used more than once, and can be shared with multiple users. Each user will authenticate independently during the credential issuance workflow, allowing the same offer URI to issue credentials with different user-specific data to multiple holders.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"string"},"description":"This array includes a list of identifiers for credential configurations that will be included in the credential offer. These identifiers are the `id` elements returned in the response when you create a credential configuration. To issue multiple credential formats of the same credential in a single flow, include all the required credential configuration id elements in the request payload.","example":["707e920a-f342-443b-ae24-6946b7b5033e"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/openid/offers:post:requestBody:content:application/json:schema:properties:credentials:example"]},"request_parameters":{"type":"object","description":"Specifies a list of additional request parameters that the wallet can include in the authentication request.","properties":{"login_hint":{"type":"string","description":"Login hints are included in the authentication flow the holder is redirected to after accepting the credential offer. For example, you can include the user's e-mail so that it is already populated in the login screen.","example":"user@example.com","examples":["user@example.com"]},"prompt":{"type":"string","description":"Prompts are sent to the authentication provider to control the authentication flow. For example, using `login` would always require the user to authenticate, even if they had already completed login on the same device.","example":"login","examples":["login"]}}}}}}}},"responses":{"200":{"description":"Credential offer URI created","content":{"application/json":{"schema":{"type":"object","required":["uri"],"properties":{"uri":{"type":"string","description":"Generated URI that can be sent to a user's digital wallet via a message, a QR code or a deep link. When a multi-format credential offer is created, the generated URI offer is used to issue all the credential formats in a single workflow.","example":"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fmyissuer.example.com%22%2C%22credentials%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22credential_configuration_ids%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22request_parameters%22%3A%7B%22login_hint%22%3A%22user%40example.com%22%2C%22prompt%22%3A%22login%22%7D%7D","examples":["openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fmyissuer.example.com%22%2C%22credentials%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22credential_configuration_ids%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22request_parameters%22%3A%7B%22login_hint%22%3A%22user%40example.com%22%2C%22prompt%22%3A%22login%22%7D%7D"]}}}}}}},"x-analytic-events":["OPENID_OFFER_CREATE_START","OPENID_OFFER_CREATE_SUCCESS","OPENID_OFFER_CREATE_FAIL"]}},"/.well-known/openid-credential-issuer":{"get":{"responses":{"200":{"description":"OID4VCI credential issuer metadata retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"issuer":{"type":"string","format":"uri"},"authorization_endpoint":{"type":"string","format":"uri"},"jwks_uri":{"type":"string","format":"uri"},"token_endpoint":{"type":"string","format":"uri"},"scopes_supported":{"type":"array","items":{"type":"string"},"example":["ldp_vc:ExampleCredential"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:scopes_supported:example"]},"response_types_supported":{"type":"array","items":{"type":"string"},"example":["code"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:response_types_supported:example"]},"response_modes_supported":{"type":"array","items":{"type":"string"},"example":["query"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:response_modes_supported:example"]},"grant_types_supported":{"type":"array","items":{"type":"string"},"example":["authorization_code"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:grant_types_supported:example"]},"code_challenge_methods_supported":{"type":"array","items":{"type":"string"},"example":["S256"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:code_challenge_methods_supported:example"]},"credential_issuer":{"type":"string","format":"uri"},"credential_endpoint":{"type":"string","format":"uri"},"credentials_supported":{"deprecated":true,"description":"This field is deprecated and maintained only for backward compatibility.\nUse `credential_configurations_supported` instead to discover supported credentials.","type":"array","items":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ldpvcSupportedCredential"},{"$ref":"#/components/schemas/cwtvcSupportedCredential"},{"$ref":"#/components/schemas/cwtSupportedCredential"},{"$ref":"#/components/schemas/msomdocSupportedCredential"}]}},"credential_configurations_supported":{"type":"object","description":"Supported credential configurations.","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/ldpvcCredentialConfigurationSupported"},{"$ref":"#/components/schemas/cwtvcCredentialConfigurationSupported"},{"$ref":"#/components/schemas/cwtCredentialConfigurationSupported"},{"$ref":"#/components/schemas/msomdocCredentialConfigurationSupported"}]},"example":{"2cdb2c15-39a7-4556-abab-4515ce2d831b":{"format":"ldp_vc","id":"2cdb2c15-39a7-4556-abab-4515ce2d831b","scope":"ldp_vc:TestCredential","credential_definition":{"@context":["https://www.w3.org/2018/credentials/v1","https://schema.org"],"type":["VerifiableCredential","TestCredential"]},"credential_signing_alg_values_supported":["Ed25519Signature2018","BbsSignatureProof2022"],"cryptographic_binding_methods_supported":["did:key"],"proof_types_supported":{"jwt":{"proof_signing_alg_values_supported":["EdDSA"]}},"credential_metadata":{"display":[{"name":"Test Credential","logo":{"uri":"https://example.com/logo.png","alt_text":"Example Logo"},"locale":"en-US","background_color":"#FFFFFF","text_color":"#000000"}],"claims":[{"path":["credentialSubject","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"3dfe1c4a-5b6c-4e2f-9f3a-2b1c4d5e6f7g":{"format":"cwt_vc","id":"3dfe1c4a-5b6c-4e2f-9f3a-2b1c4d5e6f7g","scope":"cwt_vc:TestCredential","types":["VerifiableCredential","TestCredential"],"cryptographic_binding_methods_supported":[],"credential_signing_alg_values_supported":[-7],"credential_metadata":{"claims":[{"path":["vc","credentialSubject","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"b068c060-cc72-4758-9526-92d29edb821f":{"format":"cwt","id":"b068c060-cc72-4758-9526-92d29edb821f","scope":"cwt:TestCredential","type":"TestCredential","cryptographic_binding_methods_supported":[],"credential_signing_alg_values_supported":[-7],"credential_metadata":{"claims":[{"path":["firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"a1b2c3d4-e5f6-4789-abcd-ef0123456789":{"format":"mso_mdoc","doctype":"org.iso.18013.5.1.mDL.T","scope":"mso_mdoc:TestCredential","id":"a1b2c3d4-e5f6-4789-abcd-ef0123456789","cryptographic_binding_methods_supported":["mso"],"credential_signing_alg_values_supported":[-7],"proof_types_supported":{"jwt":{"proof_signing_alg_values_supported":["ES256"]}},"credential_metadata":{"claims":[{"path":["org.iso.18013.5.1","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}],"display":[{"name":"Test Mobile Credential","logo":{"uri":"https://example.com/logo.png","alt_text":"Example Logo"},"locale":"en-US","background_color":"#FFFFFF","text_color":"#000000"}]}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:credential_configurations_supported:example"]},"mdoc_iacas_uri":{"type":"string","format":"uri"},"credential_response_encryption":{"type":"object","description":"Declares the issuer's ability to encrypt credential responses.\nWhen configured, MATTR VII can encrypt credential responses to specific wallet instances using encryption keys provided by the wallet application.\nThis provides end-to-end encryption ensuring that credential data remains confidential and unreadable to intermediary backend servers.","properties":{"alg_values_supported":{"type":"array","items":{"type":"string"},"description":"Supported HPKE algorithms for credential response encryption.\nCurrently supports HPKE-7, which uses DHKEM (P-256, HKDF-SHA256) KEM, HKDF-SHA256 KDF, and AES-256-GCM AEAD.","example":["HPKE-7"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:credential_response_encryption:properties:alg_values_supported:example"]},"enc_values_supported":{"type":"array","items":{"type":"string"},"description":"Supported encryption methods. Must be A256GCM for HPKE-7.","example":["A256GCM"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:credential_response_encryption:properties:enc_values_supported:example"]},"encryption_required":{"type":"boolean","description":"Always set to `false`. Encryption requirements are enforced through the per-client policies configured for each wallet application, which override this default value where applicable.\nWallet applications provide encryption details in the credential request through the `credential_response_encryption` parameter.","example":false,"examples":[false]}}},"credential_request_encryption":{"type":"object","description":"Declares the issuer's ability to receive and decrypt credential requests.\nWhen configured, wallet applications can encrypt credential requests to ensure sensitive information in the request is protected in transit.\nMATTR VII will decrypt the request as part of the issuance flow and enforce the configured encryption policies.","properties":{"jwks":{"type":"object","description":"JSON Web Key Set containing the issuer's public encryption keys.","properties":{"keys":{"type":"array","description":"Array of public keys for encrypting credential requests to this issuer.","items":{"type":"object","properties":{"kty":{"type":"string","description":"Key type. Must be EC for HPKE-7.","example":"EC","examples":["EC"]},"kid":{"type":"string","description":"Key identifier for the encryption key.","example":"kid","examples":["kid"]},"use":{"type":"string","description":"Public key use. Must be \"enc\" for encryption.","example":"enc","examples":["enc"]},"crv":{"type":"string","description":"Elliptic curve. Must be P-256 for HPKE-7.","example":"P-256","examples":["P-256"]},"alg":{"type":"string","description":"Algorithm. Currently supports HPKE-7 (JWE Integrated Encryption with HPKE using DHKEM (P-256, HKDF-SHA256) KEM, HKDF-SHA256 KDF, and AES-256-GCM AEAD).","example":"HPKE-7","examples":["HPKE-7"]},"x":{"type":"string","description":"X coordinate for the EC public key (base64url encoded).","example":"YO4epjifD-KWeq1sL2tNmm36BhXnkJ0He-WqMYrp9Fk","examples":["YO4epjifD-KWeq1sL2tNmm36BhXnkJ0He-WqMYrp9Fk"]},"y":{"type":"string","description":"Y coordinate for the EC public key (base64url encoded).","example":"Hekpm0zfK7C-YccH5iBjcIXgf6YdUvNUac_0At55Okk","examples":["Hekpm0zfK7C-YccH5iBjcIXgf6YdUvNUac_0At55Okk"]}}}}}},"enc_values_supported":{"type":"array","items":{"type":"string"},"description":"Supported encryption methods. Must be A256GCM for HPKE-7.","example":["A256GCM"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/openid-credential-issuer:get:responses:200:content:application/json:schema:properties:credential_request_encryption:properties:enc_values_supported:example"]},"encryption_required":{"type":"boolean","description":"Always set to `false`. Encryption requirements are enforced through the per-client policies configured for each wallet application, which override this default value where applicable.\nWhen a wallet's policy requires encryption, MATTR VII will reject unencrypted requests from that wallet.","example":false,"examples":[false]}}}}}}}}},"description":"Returns OID4VCI issuer metadata. This is the standard OID4VCI Well Known endpoint for your tenant.\n\nThis endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party wishing to discover the OID4VCI capabilities.","operationId":"wellKnownOidcConfig","security":[],"summary":"Retrieve OID4VCI issuer metadata","tags":["Issuer metadata"],"x-codeSamples":[{"lang":"curl","source":"curl --request GET \\\n --url https://{tenantName}.{region}.mattr.global/.well-known/openid-credential-issuer \\\n --header 'Accept: application/json'\n"}]}},"/.well-known/oauth-authorization-server":{"get":{"responses":{"200":{"description":"OAuth authorization server metadata","content":{"application/json":{"schema":{"type":"object","properties":{"issuer":{"type":"string","format":"uri","description":"The authorization server's issuer identifier."},"authorization_endpoint":{"type":"string","format":"uri","description":"Authorization endpoint URL."},"token_endpoint":{"type":"string","format":"uri","description":"Token endpoint URL."},"jwks_uri":{"type":"string","format":"uri","description":"JSON Web Key Set document URL."},"scopes_supported":{"type":"array","items":{"type":"string"},"example":["ldp_vc:ExampleCredential","ldp_vc:CourseCredential","cwt:CourseCredential","cwt_vc:CourseCredential","mso_mdoc:org.iso.18013.5.1.mDL"],"description":"Scopes supported by the authorization server.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:scopes_supported:example"]},"response_types_supported":{"type":"array","items":{"type":"string"},"example":["code"],"description":"Response types supported by the authorization server.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:response_types_supported:example"]},"response_modes_supported":{"type":"array","items":{"type":"string"},"example":["query","fragment"],"description":"Response modes supported by the authorization server.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:response_modes_supported:example"]},"grant_types_supported":{"type":"array","items":{"type":"string"},"example":["authorization_code"],"description":"Grant types supported by the authorization server.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:grant_types_supported:example"]},"token_endpoint_auth_methods_supported":{"type":"array","items":{"type":"string"},"example":["client_secret_basic","none"],"description":"Authentication methods supported by the token endpoint.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:token_endpoint_auth_methods_supported:example"]},"code_challenge_methods_supported":{"type":"array","items":{"type":"string"},"example":["S256"],"description":"Code challenge methods supported by the authorization server.","examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:code_challenge_methods_supported:example"]},"dpop_signing_alg_values_supported":{"description":"Supported DPoP signing algorithms.","type":"array","items":{"type":"string"},"example":["ES256"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/.well-known/oauth-authorization-server:get:responses:200:content:application/json:schema:properties:dpop_signing_alg_values_supported:example"]},"pre-authorized_grant_anonymous_access_supported":{"type":"boolean","description":"Indicates whether the authorization server supports anonymous access for pre-authorized grants (`true`) or not (`false`)."},"status_list_aggregation_endpoint":{"type":"string","format":"uri","description":"URL of the status list credential aggregation endpoint, if supported by the authorization server."}}}}}}},"description":"Returns the OAuth 2.0 Authorization Server Metadata for your tenant.\n\nThis is the standard OAuth 2.0 Well-Known endpoint, providing public metadata that describes the tenant’s OAuth 2.0 configuration and capabilities.\nhttps://www.rfc-editor.org/rfc/rfc8414.html\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"wellKnownOauthAuthorizationServer","security":[],"summary":"Retrieve authorization server metadata","tags":["Issuer metadata"]}},"/v1/openid/offers/pre-authorized":{"post":{"operationId":"postOpenIdPreAuthorizedOffers","tags":["Credential offers"],"summary":"Create a Pre-Authorized Code credential offer","x-roles":["admin","issuer","managed-issuer"],"description":"$196","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"string"},"description":"This array includes a list of identifiers for mDocs credential configurations that will be included in the credential offer. These identifiers are the `id` elements returned in the response when you create a credential configuration. Providing the identifier of a non-mDocs credential configuration will result in an error.","example":["707e920a-f342-443b-ae24-6946b7b5033e"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/openid/offers/pre-authorized:post:requestBody:content:application/json:schema:properties:credentials:example"]},"userId":{"type":"string","description":"Unique system generated identifier to reference the user for this offer. This can be obtained by [searching for a user](/docs/api-reference/platform/users/searchUsers). If not provided, a new user entity will be created."},"transactionCodeConfiguration":{"type":"object","description":"Configure whether a second-factor transaction code is required for this offer. If a configuration is provided, a code will be generated for the offer, and the end user must submit it during credential retrieval. If an incorrect transaction code is entered three times by the holder, the credential offer is permanently invalidated and the wallet can no longer claim the credential.","properties":{"inputMode":{"type":"string","description":"A string that specifies the input character set. Only `numeric` (digits only) is supported.","enum":["numeric"],"example":"numeric","examples":["numeric"]},"description":{"type":"string","description":"A string providing guidance to the wallet holder on how to obtain the transaction code, such as indicating the communication channel through which it will be delivered. This string is displayed to the wallet holder during the credential retrieval flow.","example":"Please enter the one-time code that was sent to you via email.","examples":["Please enter the one-time code that was sent to you via email."]}}},"claims":{"type":"object","description":"Additional user claims that are available during credential issuance for this offer.","example":{"givenName":"John","familyName":"Doe","email":"john.doe@example.com"},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/openid/offers/pre-authorized:post:requestBody:content:application/json:schema:properties:claims:example"]},"claimsToPersist":{"type":"array","description":"This array includes a list of claims that will be persisted against the [user object](/docs/issuance/users/overview) in the MATTR VII database. These claims are then available for any future credential offers or issuance operations for this user. By default no claims are persisted, and it is recommended to consider carefully which claims to persist, if any, as this has implications for data privacy and security.","items":{"type":"string"},"example":["userId"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/openid/offers/pre-authorized:post:requestBody:content:application/json:schema:properties:claimsToPersist:example"]},"expiresIn":{"type":"object","description":"Specifies when the offer will expire. Once the offer expires, the user can no longer use it to claim a credential, and a new offer must be generated. The expiration period can include any combination of minutes and seconds. By default, the offer expires in 5 minutes, and the maximum allowed duration is 10 minutes.","properties":{"minutes":{"type":"number","example":5,"examples":[5]},"seconds":{"type":"number"}}}}}}}},"responses":{"200":{"description":"Credential offer created","content":{"application/json":{"schema":{"type":"object","required":["id","uri","userId","expiresAt"],"properties":{"id":{"type":"string","description":"Unique system generated identifier to reference this offer."},"userId":{"type":"string","description":"A unique system-generated identifier used to reference the user for this offer."},"uri":{"type":"string","description":"Generated offer URI that can be sent to the intended holder embedded in a QR code or deep link.","example":"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fexample.com%22%2C%22credentials%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22credential_configuration_ids%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22grants%22%3A%7B%22urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Apre-authorized_code%22%3A%7B%22pre-authorized_code%22%3A%22stukD6lg9c9tQ3jUCa32wVi1HI%2BQIVsFK%2FQPvC2CHRs%3D%22%2C%22tx_code%22%3A%7B%22length%22%3A6%2C%22input_mode%22%3A%22numeric%22%2C%22description%22%3A%22Please%20provide%20the%20one-time%20code%20that%20was%20sent%20via%20e-mail%22%7D%7D%7D%7D","examples":["openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fexample.com%22%2C%22credentials%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22credential_configuration_ids%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22grants%22%3A%7B%22urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Apre-authorized_code%22%3A%7B%22pre-authorized_code%22%3A%22stukD6lg9c9tQ3jUCa32wVi1HI%2BQIVsFK%2FQPvC2CHRs%3D%22%2C%22tx_code%22%3A%7B%22length%22%3A6%2C%22input_mode%22%3A%22numeric%22%2C%22description%22%3A%22Please%20provide%20the%20one-time%20code%20that%20was%20sent%20via%20e-mail%22%7D%7D%7D%7D"]},"expiresAt":{"type":"number","description":"Offer expiry time in ISO-6801 format.","example":"2025-05-01T00:01:00.000Z","examples":["2025-05-01T00:01:00.000Z"]},"transactionCode":{"type":"string","description":"The system-generated transaction code. This property is only present if the `transactionCodeConfiguration` parameter is provided. The transaction code can be shared with the intended holder through an alternative secure communication channel. The holder must enter this code during the credential retrieval flow to successfully claim the credential. If an incorrect transaction code is entered three times, the offer is permanently invalidated and can no longer be used to claim the credential.","example":493536,"examples":[493536]}}}}}}},"x-analytic-events":["OPENID_PRE_AUTHORIZED_OFFER_CREATE_START","OPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESS","OPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL"]}},"/v1/openid/offers/pre-authorized/{id}":{"parameters":[{"name":"id","in":"path","description":"Pre-authorized credential offer ID","schema":{"type":"string","format":"uuid","example":"8241400f-de3b-42c5-ad7c-8a380039e796","examples":["8241400f-de3b-42c5-ad7c-8a380039e796"]},"required":true}],"delete":{"operationId":"deleteOpenIdPreAuthorizedOffers","tags":["Credential offers"],"summary":"Delete a Pre-authorized Code credential offer","x-roles":["admin","issuer","managed-issuer"],"description":"Delete an [OID4VCI Pre-authorized Code](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-4.1) credential offer.","responses":{"204":{"description":"Credential offer deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["OPENID_PRE_AUTHORIZED_OFFER_DELETE_START","OPENID_PRE_AUTHORIZED_OFFER_DELETE_SUCCESS","OPENID_PRE_AUTHORIZED_OFFER_DELETE_FAIL"]}},"/v1/openid/clients/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"OpenID OAuth Client unique identifier","schema":{"type":"string","format":"uuid","example":"65e5aeee-1816-11f1-b7be-a79d594cc55e","examples":["65e5aeee-1816-11f1-b7be-a79d594cc55e"]}}]},"/v1/claim-sources":{"post":{"operationId":"createClaimSource","tags":["Claims Source"],"summary":"Configure a claims source","x-roles":["admin","issuer","managed-issuer"],"description":"Configures a new claims source for your tenant. When issuing a new credential, MATTR VII will make either a GET or a POST request to the claims source using the configured request parameters and fetch available data. This fetched data can then be included in the issued credential.","requestBody":{"description":"The claim source payload","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ClaimSourceRequest"}]},"examples":{"Authorization with x-api-key header":{"value":{"name":"Claims source accepting a x-api-key header","url":"https://example.com/api/data","authorization":{"type":"api-key","value":"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"},"requestParameters":{"account_type":{"mapFrom":"claims.accountType","defaultValue":"account.student"},"account_id":{"mapFrom":"claims.accountId"}}}},"Authorization with OAuth 2.0 client credentials":{"value":{"name":"Claims source accepting an OAuth 2.0 bearer token","url":"https://example.com/api/data","authorization":{"type":"oauth-client-credentials","clientId":"afd16fec-8131-4f0c-8f20-1cd5d67f8e29","clientSecret":"1b41186347e4cc716155155cdecbded07536d0f5","tokenEndpoint":"https://example.com/oauth/token","tokenEndpointAuthMethod":"client_secret_basic","audience":"example.claim.source","scope":"example.scope"},"requestMethod":"POST","requestParameters":{"account_type":{"mapFrom":"claims.accountType","defaultValue":"account.student"},"account_id":{"mapFrom":"claims.accountId"}}}}}}}},"responses":{"201":{"description":"Claims source configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClaimSourceResponse"},"examples":{"Authorization with x-api-key header":{"value":{"name":"Claims source accepting a x-api-key header","url":"https://example.com/api/data","authorization":{"type":"api-key","value":"****************************************61m1J"},"requestParameters":{"account_type":{"mapFrom":"claims.accountType","defaultValue":"account.student"},"account_id":{"mapFrom":"claims.accountId"}}}},"Authorization with OAuth 2.0 client credentials":{"value":{"name":"Claims source accepting an OAuth 2.0 bearer token","url":"https://example.com/api/data","authorization":{"type":"oauth-client-credentials","clientId":"afd16fec-8131-4f0c-8f20-1cd5d67f8e29","clientSecret":"***********************************6d0f5","tokenEndpoint":"https://example.com/oauth/token","tokenEndpointAuthMethod":"client_secret_basic","audience":"example.claim.source","scope":"example.scope"},"requestMethod":"POST","requestParameters":{"account_type":{"mapFrom":"claims.accountType","defaultValue":"account.student"},"account_id":{"mapFrom":"claims.accountId"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad Request":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"Invalid value","param":"url"}]}}}}}}},"x-analytic-events":["CLAIM_SOURCE_CREATE_START","CLAIM_SOURCE_CREATE_SUCCESS","CLAIM_SOURCE_CREATE_FAIL"]},"get":{"operationId":"getClaimSources","tags":["Claims Source"],"summary":"Retrieve all claims sources","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all claims sources configured on your tenant.","parameters":[{"schema":{"type":"number","example":2,"maximum":1000,"minimum":1,"examples":[2]},"in":"query","name":"limit","description":"Range size of returned entries, default 100"},{"schema":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"]},"in":"query","name":"cursor","description":"Starting point for the range of entries"}],"responses":{"200":{"description":"Claims sources retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClaimSourcesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad Request":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"query","msg":"Invalid value","param":"cursor","value":"abc"}]}}}}}}},"x-analytic-events":["CLAIM_SOURCE_RETRIEVE_LIST_START","CLAIM_SOURCE_RETRIEVE_LIST_SUCCESS","CLAIM_SOURCE_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v1/claim-sources/{id}":{"parameters":[{"name":"id","in":"path","description":"Claims source ID","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true}],"get":{"operationId":"getClaimSource","tags":["Claims Source"],"summary":"Retrieve a claims source","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an existing claims source by providing its `claimSourceID`.","responses":{"200":{"description":"Claims source retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClaimSourceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad Request":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"params","msg":"Invalid value","param":"claimSourceId","value":"abc"}]}}}}}},"404":{"description":"Claims source not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Claim Source not found":{"value":{"code":"NotFound","message":"Validation Error","details":[{"location":"params","msg":"Resource Not Found","param":"claimSourceId","value":"a368cfb4-9537-4439-acc6-ce3cf2287eb7"}]}}}}}}},"x-analytic-events":["CLAIM_SOURCE_RETRIEVE_START","CLAIM_SOURCE_RETRIEVE_SUCCESS","CLAIM_SOURCE_RETRIEVE_FAIL"]},"put":{"operationId":"updateClaimSource","tags":["Claims Source"],"summary":"Update a claims source","x-roles":["admin","issuer","managed-issuer"],"description":"Updates an existing claim source by providing its `claimSourceID`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClaimSourcesRequest"}}},"description":"The updated claims source payload"},"responses":{"200":{"description":"Claims source updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClaimSourceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad Request":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"Invalid value","param":"url"}]}}}}}},"404":{"description":"Claims source not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Claim Source not found":{"value":{"code":"NotFound","message":"Validation Error","details":[{"location":"params","msg":"Resource Not Found","param":"claimSourceId","value":"a368cfb4-9537-4439-acc6-ce3cf2287eb7"}]}}}}}}},"x-analytic-events":["CLAIM_SOURCE_UPDATE_START","CLAIM_SOURCE_UPDATE_SUCCESS","CLAIM_SOURCE_UPDATE_FAIL"]},"delete":{"operationId":"deleteClaimSource","tags":["Claims Source"],"summary":"Delete a claims source","x-roles":["admin","issuer","managed-issuer"],"description":"Deletes an existing claims source by providing its `claimSourceID`.","responses":{"204":{"description":"Claims source deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Bad Request":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"params","msg":"Invalid value","param":"claimSourceId","value":"abc"}]}}}}}},"404":{"description":"Claims source not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Claim Source not found":{"value":{"code":"NotFound","message":"Validation Error","details":[{"location":"params","msg":"Resource Not Found","param":"claimSourceId","value":"a368cfb4-9537-4439-acc6-ce3cf2287eb7"}]}}}}}}},"x-analytic-events":["CLAIM_SOURCE_DELETE_START","CLAIM_SOURCE_DELETE_SUCCESS","CLAIM_SOURCE_DELETE_FAIL"]}},"/v1/messaging/inboxes":{"post":{"tags":["Inboxes"],"summary":"Create an inbox","x-roles":["admin","issuer","managed-issuer"],"description":"Creates an inbox that can register DIDs and then hold messages sent to those DIDs service points.","requestBody":{"description":"Inbox configuration","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Inbox name.","minLength":1,"example":"My_Inbox","examples":["My_Inbox"]}},"required":["name"]}}}},"operationId":"createInbox","responses":{"201":{"description":"Inbox created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingInbox"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MESSAGING_INBOX_CREATE_START","MESSAGING_INBOX_CREATE_SUCCESS","MESSAGING_INBOX_CREATE_FAIL"]},"get":{"tags":["Inboxes"],"summary":"List inboxes","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"description":"Returns a list of all inboxes on the tenant.","operationId":"getInboxes","responses":{"200":{"description":"A list of inboxes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","minItems":2,"items":{"$ref":"#/components/schemas/MessagingInbox"}},"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]}}}}}}},"x-analytic-events":["MESSAGING_INBOX_RETRIEVE_LIST_START","MESSAGING_INBOX_RETRIEVE_LIST_SUCCESS","MESSAGING_INBOX_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v1/messaging/inboxes/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Inbox ID"}],"get":{"tags":["Inboxes"],"summary":"Retrieve an inbox","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves an inbox based on its ID.","operationId":"getInbox","responses":{"200":{"description":"Inbox returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingInbox"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["MESSAGING_INBOX_RETRIEVE_START","MESSAGING_INBOX_RETRIEVE_SUCCESS","MESSAGING_INBOX_RETRIEVE_FAIL"]},"put":{"tags":["Inboxes"],"summary":"Update an inbox","x-roles":["admin","issuer","managed-issuer"],"requestBody":{"description":"Updates an inbox name.\n\n### **Analytic events**\n* MESSAGING_INBOX_UPDATE_START\n* MESSAGING_INBOX_UPDATE_SUCCESS\n* MESSAGING_INBOX_UPDATE_FAIL","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1}},"required":["name"]}}}},"operationId":"updateInbox","responses":{"200":{"description":"Inbox updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingInbox"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"},"Existing inbox with same name":{"$ref":"#/components/examples/InboxNameNotUnique"}}}}},"404":{"$ref":"#/components/responses/404"}},"description":"Update the inbox configurations"},"delete":{"tags":["Inboxes"],"summary":"Delete an inbox","x-roles":["admin","issuer","managed-issuer"],"responses":{"204":{"description":"Inbox deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"}}}}},"404":{"$ref":"#/components/responses/400"}},"operationId":"deleteInbox","description":"Deletes an inbox by providing its ID.","x-analytic-events":["MESSAGING_INBOX_DELETE_START","MESSAGING_INBOX_DELETE_SUCCESS","MESSAGING_INBOX_DELETE_FAIL"]}},"/v1/messaging/inboxes/{id}/dids":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Requested inbox ID"}],"post":{"tags":["Inboxes"],"summary":"Register DID with an inbox","x-roles":["admin","issuer","managed-issuer"],"requestBody":{"description":"DID registration information","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"did":{"type":"string","description":"URI of the DID to register with this inbox."},"jwt":{"type":"string"}},"required":["did"]}}}},"operationId":"registerInboxDid","responses":{"201":{"description":"DID registered with inbox","content":{"application/json":{"schema":{"type":"object","properties":{"did":{"type":"string"}},"required":["did"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"},"DID not found":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"Resource Not Found","param":"did","value":"did:key:z6MkhzsSMkbGYNxyxtqNpTpPet119FSYn4om6yoZZfdUAHqj"}]}},"BLS DID key type not supported":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","value":"did:key:zUC75Wk5aeoMttq5Z4ShQTbVVLXSTy2hiEvh6L7GaFjcUWoff1szDbwvgs978r1BPy5oFL1J6n6YttvvaexugWvjrMGurpdtnYNthukkpzDqhim2ARwAHVFkdpYMF7T184jP5rx","param":"did","msg":"DID key with BLS key type is not supported"}]}},"Bad JWT":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"j.w.t","msg":"Failed to verify JWT","param":"jwt","location":"body"}]}}}}}},"404":{"$ref":"#/components/responses/404"}},"description":"Register the provided DID to the requested inbox.\n\n\nDID registration with inboxes is currently limited to `did:key`'\n","x-analytic-events":["MESSAGING_INBOX_DID_REGISTER_START","MESSAGING_INBOX_DID_REGISTER_SUCCESS","MESSAGING_INBOX_DID_REGISTER_FAIL"]},"get":{"summary":"Retrieve inbox DIDs","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves a list of all the DIDs registered with the requested inbox.","operationId":"getInboxDids","responses":{"200":{"description":"A list of inbox DIDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagingInboxDIDs"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"}}}}},"404":{"$ref":"#/components/responses/400"}},"tags":["Inboxes"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"x-analytic-events":["MESSAGING_INBOX_DID_RETRIEVE_LIST_START","MESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESS","MESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL"]}},"/v1/messaging/inboxes/{id}/dids/{did}":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Requested inbox ID"},{"schema":{"type":"string","example":"did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9","examples":["did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9"]},"name":"did","in":"path","required":true,"description":"DID"}],"delete":{"tags":["Inboxes"],"description":"Unregisters a DID from the requested inbox.","operationId":"unregisterInboxDid","responses":{"204":{"description":"DID unregistered from inbox"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"}}}}},"404":{"$ref":"#/components/responses/404"}},"summary":"Unregister DID with an inbox","x-roles":["admin","issuer","managed-issuer"],"x-analytic-events":["MESSAGING_INBOX_DID_UNREGISTER_START","MESSAGING_INBOX_DID_UNREGISTER_SUCCESS","MESSAGING_INBOX_DID_UNREGISTER_FAIL"]}},"/v1/messaging/inboxes/{id}/messages":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Requested inbox ID"}],"get":{"tags":["Inboxes"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"description":"Retrieving all the messages from an inbox","operationId":"getInboxMessages","responses":{"200":{"description":"A list of inbox messages","content":{"application/json":{"schema":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","minItems":2,"items":{"$ref":"#/components/schemas/MessageInboxMessage"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"}}}}},"404":{"$ref":"#/components/responses/404"}},"summary":"Retrieve all messages","x-roles":["admin","issuer","managed-issuer"],"x-analytic-events":["MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_START","MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESS","MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL"]}},"/v1/messaging/inboxes/{id}/messages/{messageId}":{"parameters":[{"schema":{"type":"string"},"name":"id","in":"path","required":true,"description":"Requested inbox ID"},{"schema":{"type":"string"},"name":"messageId","in":"path","required":true,"description":"Requested message ID"}],"get":{"tags":["Inboxes"],"description":"Retrieves a message from the requested inbox by providing its ID.","operationId":"getInboxMessage","responses":{"200":{"description":"An inbox message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageInboxMessage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"},"Message ID not UUID format":{"$ref":"#/components/examples/MessageIdNotUuid"}}}}},"404":{"$ref":"#/components/responses/404"}},"summary":"Retrieve a message","x-roles":["admin","issuer","managed-issuer"],"x-analytic-events":["MESSAGING_INBOX_MESSAGE_RETRIEVE_START","MESSAGING_INBOX_MESSAGE_RETRIEVE_SUCCESS","MESSAGING_INBOX_MESSAGE_RETRIEVE_FAIL"]},"delete":{"tags":["Inboxes"],"description":"Deletes a message from the requested inbox by providing its ID.","operationId":"deleteInboxMessage","responses":{"204":{"description":"Message deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox ID not UUID format":{"$ref":"#/components/examples/InboxIdNotUuid"},"Message ID not UUID format":{"$ref":"#/components/examples/MessageIdNotUuid"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Inbox not found":{"$ref":"#/components/examples/ResourceNotFound"},"Message not found":{"$ref":"#/components/examples/ResourceNotFound"}}}}}},"summary":"Delete a message","x-roles":["admin","issuer","managed-issuer"],"x-analytic-events":["MESSAGING_INBOX_MESSAGE_DELETE_START","MESSAGING_INBOX_MESSAGE_DELETE_SUCCESS","MESSAGING_INBOX_MESSAGE_DELETE_FAIL"]}},"/v1/messaging/sign":{"post":{"tags":["Messaging"],"summary":"Sign a message","x-roles":["admin","issuer","managed-issuer"],"requestBody":{"description":"Sign message request","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignMessageRequest"},"examples":{"Sign a Message":{"value":{"didUrl":"did:web:organization.com#2vcj3MjR4d","payload":{"msg":"this is a message"}}}}}}},"responses":{"200":{"description":"Message signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignMessageResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"description":"Accepts a message payload and signs it with a JWS (JSON Web Signature) using the a specific key from the DID (Decentralized Identifier) provided in the request.","operationId":"signMessage","x-analytic-events":["MESSAGING_SIGN_START","MESSAGING_SIGN_SUCCESS","MESSAGING_SIGN_FAIL"]},"parameters":[]},"/v1/messaging/verify":{"post":{"tags":["Messaging"],"summary":"Verify a message","x-roles":["admin","issuer","managed-issuer"],"requestBody":{"description":"Provide the JWS to verify","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyRequest"},"examples":{"Request":{"value":{"jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}}}}}},"responses":{"200":{"description":"Verification successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyMessageResponse"},"examples":{"Verification successful":{"value":{"payload":"payload","didUrl":"did:web:organization.com#2vcj3MjR4d","did":"did:web:organization.com","verified":true,"signerPublicJwk":{"kty":"OKP","crv":"Ed25519","x":"oQvDM6MvUdcgRCqKGJOgteRC9U06_x7bFtY0T-MJ1rQ"}}},"Verification failed":{"value":{"payload":"payload","didUrl":"did:web:organization.com#2vcj3MjR4d","did":"did:web:organization.com","verified":false}}}}}},"400":{"description":"Invalid JWS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Verification failed":{"value":{"code":"BadRequest","message":"Verification failed"}}}}}}},"description":"Verifies the signature of a provided JWS (JSON Web Signature), validating that the payload has not been tampered with and verifying that the kid in the JWS header is the same as the `iss` value in the Request Object.\n\nOne use case for verifying a JWS with a DID is when the Mobile Wallet App sends a Request Object to an OpenID Provider as part of the Authorization Code Flow (as per https://openid.net/specs/openid-connect-core-1_0-final.html#RequestObject). The Request Object is wrapped in a JWS with a signature that is generated from the Subject DID on the mobile app. Therefore verifying the JWS proves that the mobile app has access to the private key of the Subject DID.","operationId":"verifyJws","x-analytic-events":["MESSAGING_VERIFY_START","MESSAGING_VERIFY_SUCCESS","MESSAGING_VERIFY_FAIL"]},"parameters":[]},"/v1/messaging/encrypt":{"post":{"tags":["Messaging"],"summary":"Encrypt a message","x-roles":["admin","issuer","managed-issuer"],"operationId":"encryptMessage","requestBody":{"description":"Encryption parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncryptMessageRequest"},"examples":{"Encrypt credential offer":{"value":{"senderDidUrl":"did:web:learn.vii.au01.mattr.global#z6LShWb1DVC2gkxoQ91VwHmNhci2A4NdVH4srFvLiTP6ETBK","recipientDidUrls":["did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d","did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN"],"payload":{"id":"731961f2-bdc3-4f1e-8d59-cc308fd60ec8","type":"https://mattr.global/schemas/verifiable-credential/offer/OidcCredentialProvider","from":"did:web:learn.vii.au01.mattr.global","created_time":1616466734,"body":{"uri":"openid://discovery?issuer=https://tenant.vii.mattr.global/ext/oidc/v1/issuers/0dceeddd-f717-4bf2-b520-b3ddcd104a60"}}}},"Encrypt credential":{"value":{"senderDidUrl":"did:web:learn.vii.au01.mattr.global#z6LShWb1DVC2gkxoQ91VwHmNhci2A4NdVH4srFvLiTP6ETBK","recipientDidUrls":["did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN"],"payload":{"id":"731961f2-bdc3-4f1e-8d59-cc308fd60ec8","type":"https://mattr.global/schemas/verifiable-credential/offer/Direct","to":["did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN"],"from":"did:web:learn.vii.au01.mattr.global","created_time":1616466734,"body":{"credentials":[{"@context":["https://www.w3.org/2018/credentials/v1","https://schema.org"],"type":["VerifiableCredential","CourseCredential"],"issuer":{"id":"did:web:organization.com","name":"tenant"},"issuanceDate":"2021-07-26T01:05:05.152Z","credentialSubject":{"id":"did:key:z6MkfxQU7dy8eKxyHpG267FV23agZQu9zmokd8BprepfHALi","givenName":"Chris","familyName":"Shin","educationalCredentialAwarded":"Certificate Name"},"proof":{"type":"Ed25519Signature2018","created":"2021-07-26T01:05:06Z"},"jws":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..o6hnrrWpArG8LQz2Ex_u66_BtuPdp3Hkz18nhNdNhJ7J1k_2lmCCwsNdmo-kNFirZdSIMzqO-V3wEjMDphVEAA","proofPurpose":"assertionMethod","verificationMethod":"did:key:z6MkndAHigYrXNpape7jgaC7jHiWwxzB3chuKUGXJg2b5RSj#z6MkndAHigYrXNpape7jgaC7jHiWwxzB3chuKUGXJg2b5RSj"}],"domain":"learn.vii.au01.mattr.global"}}}}}}}},"responses":{"200":{"description":"Message encrypted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EncryptedMessage"},"examples":{"Encrypted message":{"value":{"jwe":{"protected":"eyJhbGciOiJYQzIwUCJ9","recipients":[{"header":{"alg":"ECDH-1PU+A256KW","kid":"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg","epk":{"kty":"OKP","crv":"X25519","x":"JOLnYaD7L-Rszz7fczPhn6MkNre25PUsztzB1RHoz14"},"skid":"did:key:z6MkreuqFq6WrwozTeGKuUDz8bniTFRNAg8f3ZB862YdLp7v#z6LScyz3YLToyoKwZE6Tfq65hgZUkZdHrC4ZqohcUH9X6Twx"},"encryption_key":"ag5iKzjJOth9Wa68dCVKJW_vnO_Ga0zSJgQp5rIUg69HCzIjuNYhDg"},{"header":{"alg":"ECDH-1PU+A256KW","kid":"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd","epk":{"kty":"OKP","crv":"X25519","x":"gDYW7rhG3cBqFp9trFETtlut6QJxYVVSoVWL7eN1bzE"},"skid":"did:key:z6MkreuqFq6WrwozTeGKuUDz8bniTFRNAg8f3ZB862YdLp7v#z6LScyz3YLToyoKwZE6Tfq65hgZUkZdHrC4ZqohcUH9X6Twx"},"encryption_key":"F5R5ZW7Yk7_iWT5kUWqv3w_tLI7V86tLRthjy_SSbGQ2pFyXKni_gA"}],"ciphertext":"xpW-D6sDPpWc_jk87nEyxPX7JQV8_OZpaQft7ySQ5XmNhoj-lQyDkXDncOCyhB7yMSdZrRBNQjKxlEbpY_WLk1hBoWfsTeszVSAuFbX_VKUSJ7GR6rcnWGVNgDfKS8GsyC_owtswXatkF_65_mzFOygctkUmd2eI5bcpQpWjhw2vqnvnWkb7l2J27aWFF_c9cu52dB559j8lwLYyYC9oSMgV5piB6ppfrWBGo_DigjxvJcAYcjFYqFcT6A1nphPhwVTQ2HNfJodbQoseHub8UQdG4qAOcggq5DI84tbqor1SU9rdPH03jPkLgoO_aeXyJg5meITXoFSiu_tRfvf8QQ6vKq6pkTTXs8zKXcBCGhGIyKBNBG4R4RIY1UffTMnJQQQGBble3P06pGOnsnSop0BtygelB9M0ZEwnAUSAQqN1RR4AQwWcn9nH6hHEu1pMhSvhCuFNAPWS-hg24JGGw8Xe3EEZlLH0PM8qpUAfksPq","iv":"FJq5zKvuPiUQIdRcMtiChHCJByuY8XK9","tag":"u8kT0VAAtTswjGXxNpuX0g=="}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"Sender DID not found":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"location":"body","msg":"Resource Not Found","param":"senderDidUrl","value":"did:key:z6MkopLiuMudqeRm1KvQ24jyUfn6pciePNomKqpsiMgeg4nT#z6LSmWEcPwNbxCgbuSMGTz1Gddnf9MsVSMJCfgPtksgThLvi"}]}}}}}}},"description":"Encrypts the provided payload using into a JWM (JSON Web Message) format.","x-analytic-events":["MESSAGING_ENCRYPT_START","MESSAGING_ENCRYPT_SUCCESS","MESSAGING_ENCRYPT_FAIL"]},"parameters":[]},"/v1/messaging/decrypt":{"post":{"tags":["Messaging"],"summary":"Decrypt a message","x-roles":["admin","issuer","managed-issuer"],"operationId":"decryptMessage","requestBody":{"description":"Decryption parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptMessageRequest"}}}},"responses":{"200":{"description":"Message Decrypted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptMessageResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"description":"Decrypts a provided message where the tenant manages the keys for the defined `recipientDidUrl`.","x-analytic-events":["MESSAGING_DECRYPT_START","MESSAGING_DECRYPT_SUCCESS","MESSAGING_DECRYPT_FAIL"]},"parameters":[]},"/v1/messaging/send":{"post":{"summary":"Send a message","x-roles":["admin","issuer","managed-issuer"],"operationId":"sendMessage","description":"Sends an encrypted JWM (JSON Web Messaging) format message to a service endpoint defined in a public DID document.","tags":["Messaging"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"},"examples":{"Send message":{"value":{"to":"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d","message":{"protected":"eyJhbGciOiJYQzIwUCJ9","recipients":[{"header":{"alg":"ECDH-1PU+A256KW","kid":"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg","epk":{"kty":"OKP","crv":"X25519","x":"kYsO02jWHATTJel6OpePqlkdDmKlE5VOr18UblgL8W0"},"skid":"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy"},"encryption_key":"n1VUf5SQdSFNtb8DHzYfJJ_lFhJcGDAPJWG8Y1W3d2qYyPzyxMhyaA"},{"header":{"alg":"ECDH-1PU+A256KW","kid":"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd","epk":{"kty":"OKP","crv":"X25519","x":"P3jcIMPGK8thxyHxUsWB5fEsLnltJqRDWMNywtexk24"},"skid":"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy"},"encryption_key":"5ZOTqwj8NredkXEOp4ZDLL1ohRQqNTS508BTkLlUVCkDoYvizCIdrg"}],"ciphertext":"Dl4zBqMeEDwcnyyc17nYvSQ048fcsha_Lm0dfer1nqfo5y8oHvD2VGNTp_lawNJMWCzQF3NDZxxKFz__wTUeHCqisCE_DWbjo_W-R3avzW9S-JFajv9NRtjlfd5yp-1TtD2N5d-8oTtMGdAxq3dftN2Od1xRe4stubJBebl3nf8-lG99DIVGdL8Y-D98kFDxnMxgCKn4RXyHnMowFWlhQCooLeYqo8aWjqVFkzuJzn-p47W7rV9BCuoVThhVuNkjQm_dhBrqu0QMpjJucz7OvOHp0mojdYNKwvWT6dfOVNXetMlKjWCGtCTNFaDTGLc4agdcTjAlaF1iedcVXDOLqVvEugXWGlusE3a68y6gmPnqHjXR6CsEfPwkb5hKKtsyrh1eHu_9UUang5o6N76mummVw4UZkDF6tP1PVGPvyctz82tthnOcjO5mZQG41xfMEMNxWtF8P8wCh4LotpdexXtYigzBgkI1Qoa_FK1czYWAUovysAJCTOZtmg==","iv":"jSd3E-ElCHE-QhSDxrQ-Jv4eQhkxOj0s","tag":"dbDolGVDdvYsYdn-vVrICw=="}}}}}},"description":""},"responses":{"200":{"description":"Message sent"},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["MESSAGING_SEND_START","MESSAGING_SEND_SUCCESS","MESSAGING_SEND_FAIL"]},"parameters":[]},"/v1/users/search":{"post":{"operationId":"searchUsers","tags":["Users"],"summary":"Search users","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of users from the tenant that match all the provided search criteria (all criteria are optional).","requestBody":{"description":"The search criteria","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"claims":{"type":"object","description":"Filter users by claims. Nested objects are supported. Text values must be an exact match.\n","example":{"externalUserId":"0c3fad74-a8df-4a2d-8e75-f2d356b413ba"},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/users/search:post:requestBody:content:application/json:schema:properties:claims:example"]},"authenticationProvider":{"type":"object","description":"Filter users by their unique identifier in the configured Authentication Provider.\n","properties":{"providerId":{"type":"string","description":"Authentication Provider identifier.","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"subjectId":{"type":"string","description":"Unique identifier of the user in the Authentication Provider. Must be an exact match.","example":"example-university-oauth2|123456789","examples":["example-university-oauth2|123456789"]}}},"limit":{"type":"number","description":"Range size of returned entries, default 100","example":100,"maximum":1000,"minimum":1,"examples":[100]},"cursor":{"type":"string","description":"Starting point for the range of entries","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"]}}}}}},"responses":{"200":{"description":"Users retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchUsersResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["USER_SEARCH_START","USER_SEARCH_SUCCESS","USER_SEARCH_FAIL"]}},"/v1/users":{"post":{"operationId":"createUser","tags":["Users"],"summary":"Create a User","x-roles":["admin","issuer","managed-issuer"],"description":"Create a user.\n\n* USER_CREATE_START\n* USER_CREATE_SUCCESS\n* USER_CREATE_FAIL","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"description":"Create a User"},"responses":{"201":{"description":"User created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}}},"400":{"$ref":"#/components/responses/400"}}},"get":{"operationId":"getUsers","tags":["Users"],"summary":"Retrieve all users","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all users on your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Users retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsersResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["USER_RETRIEVE_LIST_START","USER_RETRIEVE_LIST_SUCCESS","USER_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v1/users/{id}":{"parameters":[{"name":"id","in":"path","description":"User ID","schema":{"type":"string","format":"uuid","example":"8241400f-de3b-42c5-ad7c-8a380039e796","examples":["8241400f-de3b-42c5-ad7c-8a380039e796"]},"required":true}],"get":{"operationId":"getUser","tags":["Users"],"summary":"Retrieve a user","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieve an existing user by providing its ID.\n* USER_RETRIEVE_START\n* USER_RETRIEVE_SUCCESS\n* USER_RETRIEVE_FAIL","responses":{"200":{"description":"User retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}},"put":{"operationId":"updateUser","tags":["Users"],"summary":"Update a User","x-roles":["admin","issuer","managed-issuer"],"description":"Updates an existing user by providing its ID.\n\n* USER_UPDATE_START\n* USER_UPDATE_SUCCESS\n* USER_UPDATE_FAIL","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"description":"Update a User"},"responses":{"200":{"description":"User updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"operationId":"deleteUser","tags":["Users"],"summary":"Delete a user","x-roles":["admin","issuer","managed-issuer"],"description":"Deletes a user and removes all data related to them by providing the user ID.\n\n\nDeleting a user is irreversible. All of the user's data is removed, and any credential previously issued to them is no longer valid.\n","responses":{"204":{"description":"User deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["USER_DELETE_START","USER_DELETE_SUCCESS","USER_DELETE_FAIL"]}},"/v1/users/{userId}/credentials":{"parameters":[{"$ref":"#/components/parameters/UserId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"get":{"operationId":"getUserCredentials","tags":["Users"],"summary":"Retrieve all user credentials data","x-roles":["admin","issuer","managed-issuer"],"description":"Returns metadata for all the credentials issued to the provided `userId`.","responses":{"200":{"description":"User credentials retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserCredentialsResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["USER_CREDENTIAL_RETRIEVE_LIST_START","USER_CREDENTIAL_RETRIEVE_LIST_SUCCESS","USER_CREDENTIAL_RETRIEVE_LIST_FAIL"]}},"/v1/users/authentication-providers":{"post":{"operationId":"createAuthenticationProvider","tags":["Authentication Provider"],"summary":"Configure an Authentication Provider","x-roles":["admin","issuer","managed-issuer"],"description":"Configures an Authentication Provider on the tenant.\n\nAn authentication or identity provider (IdP) is a platform that is typically used to store and manage user accounts on behalf of an organization or a service provider. MATTR VII uses the authentication provider to authenticate end users before issuing them credentials.\n\n\nOnly one authentication provider can be configured on a tenant.\n\n\nThe `/.well-known/openid-configuration` endpoint of the Authentication Provider must contain values for the `authorization_endpoint`, `token_endpoint` and `scopes_supported`.","requestBody":{"description":"The Authentication Provider payload","required":true,"content":{"application/json":{"schema":{"required":["clientSecret","url"],"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderRequest"},{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Base url for your Authentication Provider well-known endpoint:\n- Must be a valid URL.\n- Must use the HTTPS protocol.\n- Must not be an IP address.\n- Must not contain query parameters. Port and fragment parameters will be dropped.\n- URL must use https and have a valid public TLD.\n- Unicode will be converted to ASCII.","example":"https://example-university.au.auth0.com","examples":["https://example-university.au.auth0.com"]}}}]}}}},"responses":{"201":{"description":"Authentication Provider configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAuthenticationProviderResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["USER_AUTHENTICATION_PROVIDER_CREATE_START","USER_AUTHENTICATION_PROVIDER_CREATE_SUCCESS","USER_AUTHENTICATION_PROVIDER_CREATE_FAIL"]},"get":{"operationId":"getAuthenticationProviders","tags":["Authentication Provider"],"summary":"Retrieve all Authentication Providers","x-roles":["admin","issuer","managed-issuer"],"description":"Returns a list of all Authentication Providers on your tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Authentication Providers retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuthenticationProvidersResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_START","USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_SUCCESS","USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_FAIL"]},"parameters":[]},"/v1/users/authentication-providers/{id}":{"parameters":[{"name":"id","in":"path","description":"Authentication Provider ID","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true}],"get":{"operationId":"getAuthenticationProvider","tags":["Authentication Provider"],"summary":"Retrieve an Authentication Provider","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieve an existing Authentication Provider by providing its ID.","responses":{"200":{"description":"Authentication Provider retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAuthenticationProviderResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["USER_AUTHENTICATION_PROVIDER_RETRIEVE_START","USER_AUTHENTICATION_PROVIDER_RETRIEVE_SUCCESS","USER_AUTHENTICATION_PROVIDER_RETRIEVE_FAIL"]},"put":{"operationId":"updateAuthenticationProvider","tags":["Authentication Provider"],"summary":"Update an Authentication Provider","x-roles":["admin","issuer","managed-issuer"],"description":"Updates an existing Authentication Provider by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationProviderRequest"}}},"description":"Update an Authentication Provider"},"responses":{"200":{"description":"Authentication Provider updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAuthenticationProviderResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["USER_AUTHENTICATION_PROVIDER_UPDATE_START","USER_AUTHENTICATION_PROVIDER_UPDATE_SUCCESS","USER_AUTHENTICATION_PROVIDER_UPDATE_FAIL"]},"delete":{"operationId":"deleteAuthenticationProvider","tags":["Authentication Provider"],"summary":"Delete an Authentication Provider","x-roles":["admin","issuer","managed-issuer"],"description":"Deletes an existing Authentication Provider by providing its ID.","responses":{"204":{"description":"Authentication Provider deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["USER_AUTHENTICATION_PROVIDER_DELETE_START","USER_AUTHENTICATION_PROVIDER_DELETE_SUCCESS","USER_AUTHENTICATION_PROVIDER_DELETE_FAIL"]}},"/v1/openid/configuration":{"put":{"operationId":"updateOpenIdConfiguration","tags":["Interaction Hook"],"summary":"Configure Interaction Hook","x-roles":["admin","issuer","managed-issuer"],"description":"$197","requestBody":{"description":"The Interaction Hook configuration payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpenIdConfigurationRequest"}}}},"responses":{"200":{"description":"Interaction Hook configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConfigurationGeneral"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_START","CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_SUCCESS","CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_FAIL"]},"get":{"operationId":"getOpenIdConfiguration","tags":["Interaction Hook"],"summary":"Retrieve Interaction Hook","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves the Interaction Hook configuration from your tenant.","responses":{"200":{"description":"Interaction Hook configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConfigurationGeneral"}}}}},"x-analytic-events":["CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_START","CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_SUCCESS","CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_FAIL"]}},"/v1/events":{"get":{"tags":["Analytics"],"summary":"Retrieve events","x-roles":["admin","auditor","managed-issuer"],"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"},{"in":"query","name":"ids","schema":{"type":"array","example":["e4c387e7-3e63-40f4-9a38-062aaae9ee50"],"items":{"type":"string","minLength":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:2:schema:example"]},"description":"Query by event IDs. These can be retrieved from event details."},{"in":"query","name":"requestIds","schema":{"type":"array","example":["e4c387e7-3e63-40f4-9a38-062aaae9ee50"],"items":{"type":"string","minLength":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:3:schema:example"]},"description":"Query by request IDs. These can be retrieved from event details. The response will include all the individual events that are part of the queried request."},{"in":"query","name":"categories","schema":{"type":"array","example":["credential_compact"],"items":{"type":"string","minLength":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:4:schema:example"]},"description":"Query by event categories. Uses an **OR** operation with `types`. Every **category** includes several event **types**. Each API endpoint details the event types it generates under the **Analytic events** heading. Refer to the [Events registry](https://api-reference-sdk.mattr.global/event-registry/latest/index.html) for an inclusive list."},{"in":"query","name":"types","schema":{"type":"array","example":["CREDENTIAL_COMPACT_SIGN_START"],"items":{"type":"string","minLength":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:5:schema:example"]},"description":"Query by event types. Uses an **OR** operation with `categories`. Every **category** includes several event **types**. Each API endpoint details the events it generates under the **Analytic events** heading. Refer to the [Events registry](https://api-reference-sdk.mattr.global/event-registry/latest/index.html) for an inclusive list."},{"in":"query","name":"dateFrom","schema":{"type":"string","format":"date-time","example":"2023-06-01T02:45:44.087Z","examples":["2023-06-01T02:45:44.087Z"]},"description":"Query by event start date and time (inclusive), in ISO-8601 format."},{"in":"query","name":"dateTo","schema":{"type":"string","format":"date-time","example":"2023-06-30T23:59:59.999Z","examples":["2023-06-30T23:59:59.999Z"]},"description":"Query by event end date and time (inclusive), in ISO-8601 format."},{"in":"query","name":"managementUserIds","schema":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid"},"example":["ea691ed4-90ff-4be2-bd85-f2c74efa72c3"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:8:schema:oneOf:0:example"]},{"type":"string","enum":["none","*"]}]},"description":"Filter events by management user IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified management user IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any management user IDs. \n- `*`: Returns events that are assigned to any management user IDs.\n"},{"in":"query","name":"clientIds","schema":{"oneOf":[{"type":"array","items":{"type":"string"},"example":["54rp8Z8yGnlva19mThj7tJzNXFSyXrCf"],"examples":["$186:props:children:1:props:children:props:payload:bundled:paths:/v1/events:get:parameters:9:schema:oneOf:0:example"]},{"type":"string","enum":["none","*"]}]},"description":"Filter events by client IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified client IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any client IDs. \n- `*`: Returns events that are assigned to any client IDs.\n"}],"description":"Returns a list of matching events from the tenant's event database. \n\nThe `categories` and `types` parameters filter based on an **OR** logic, whilst all other parameters use an \"AND\" logic. For example `(categories OR types) AND requestIds AND dateFrom`.\n\nRefer to the [Events registry](https://api-reference-sdk.mattr.global/event-registry/latest/index.html) for an inclusive list of events categories and types.\n","operationId":"getEvents","responses":{"200":{"description":"A list of events","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page.","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}},"/v1/events/credential-reports":{"post":{"tags":["Analytics"],"summary":"Create credential report","x-roles":["admin","issuer","auditor","managed-issuer"],"description":"Creates a report of credential lifecycle operations (issuance and status changes). \n\nOnly CWT and mDoc credentials are included in the report.\n","operationId":"createCredentialReport","requestBody":{"description":"The credential report parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialReportRequest"}}}},"responses":{"200":{"description":"Successfully generated credential report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialReport"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}},"/v1/ecosystems":{"get":{"tags":["Ecosystems"],"summary":"Retrieve all ecosystems","x-roles":["admin","dts-provider"],"description":"Retrieves a list of ecosystems.","operationId":"getEcosystems","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Ecosystems retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Ecosystem"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["ECOSYSTEM_RETRIEVE_LIST_START","ECOSYSTEM_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_RETRIEVE_LIST_FAIL"]},"post":{"tags":["Ecosystems"],"summary":"Create ecosystem","x-roles":["admin","dts-provider"],"description":"Creates an ecosystem.","operationId":"createEcosystem","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/name"},"integrations":{"type":"array","description":"Details external trust sources which are integrated into the ecosystem. These can be either a different ecosystem or a [VICAL](https://learn.mattr.global/docs/digital-trust-service/vical-overview).","items":{"oneOf":[{"$ref":"#/components/schemas/MattrIntegration"},{"$ref":"#/components/schemas/VicalIntegration"}]}}}}}}},"responses":{"201":{"description":"Ecosystem created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ecosystem"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CREATE_START","ECOSYSTEM_CREATE_SUCCESS","ECOSYSTEM_CREATE_FAIL"]}},"/v1/ecosystems/sync":{"post":{"tags":["Ecosystems"],"summary":"Sync ecosystem","x-roles":["admin","dts-provider"],"description":"Synchronizes all configured consumptions and integrations by retrieving the most recent trust information.","operationId":"syncEcosystem","responses":{"202":{"description":"Ecosystem sync request accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantConfiguration":{"type":"object","description":"Details the different ecosystems that are consumed by this current ecosystem as external trust sources.","properties":{"ecosystems":{"type":"array","description":"A list of all consumed ecosystems.","items":{"type":"object","properties":{"url":{"type":"string","description":"URL where this ecosystem's trust information is retrieved from.","example":"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe","examples":["https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe"]}}}}}},"integrations":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MattrIntegration"},{"$ref":"#/components/schemas/VicalIntegration"}]}}}}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["ECOSYSTEM_TENANT_SYNC_ALL_START","ECOSYSTEM_TENANT_SYNC_ALL_SUCCESS","ECOSYSTEM_TENANT_SYNC_ALL_FAIL"]}},"/v1/config/ecosystems":{"get":{"tags":["Ecosystem Configuration"],"summary":"Retrieve ecosystem configuration","x-roles":["admin","dts-consumer"],"description":"Retrieves the tenant's ecosystem configuration.","operationId":"getEcosystemConfiguration","responses":{"200":{"description":"Ecosystem configuration retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemConfig"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CONFIG_RETRIEVE_START","ECOSYSTEM_CONFIG_RETRIEVE_SUCCESS","ECOSYSTEM_CONFIG_RETRIEVE_FAIL"]},"post":{"tags":["Ecosystem Configuration"],"summary":"Create ecosystem configuration","x-roles":["admin","dts-consumer"],"description":"Creates an ecosystem configuration for the tenant.","operationId":"createEcosystemConfiguration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemConfig"}}}},"responses":{"201":{"description":"Ecosystem configuration created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemConfig"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CONFIG_CREATE_START","ECOSYSTEM_CONFIG_CREATE_SUCCESS","ECOSYSTEM_CONFIG_CREATE_FAIL"]},"put":{"tags":["Ecosystem Configuration"],"summary":"Update ecosystem configuration","x-roles":["admin","dts-consumer"],"description":"Updates the tenant's ecosystem configuration.","operationId":"updateEcosystemConfiguration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemConfig"}}}},"responses":{"200":{"description":"Ecosystem configuration updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemConfig"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CONFIG_UPDATE_START","ECOSYSTEM_CONFIG_UPDATE_SUCCESS","ECOSYSTEM_CONFIG_UPDATE_FAIL"]},"delete":{"tags":["Ecosystem Configuration"],"summary":"Delete ecosystem configuration","x-roles":["admin","dts-consumer"],"description":"Deletes the tenant's ecosystem configuration.","operationId":"deleteEcosystemConfiguration","responses":{"204":{"description":"Ecosystem configuration deleted"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CONFIG_DELETE_START","ECOSYSTEM_CONFIG_DELETE_SUCCESS","ECOSYSTEM_CONFIG_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"tags":["Ecosystems"],"summary":"Retrieve ecosystem","x-roles":["admin","dts-provider"],"description":"Retrieves an ecosystem by its ID.","operationId":"getEcosystem","responses":{"200":{"description":"Ecosystem retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ecosystem"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RETRIEVE_START","ECOSYSTEM_RETRIEVE_SUCCESS","ECOSYSTEM_RETRIEVE_FAIL"]},"put":{"tags":["Ecosystems"],"summary":"Update ecosystem","x-roles":["admin","dts-provider"],"description":"Updates an ecosystem by its ID.","operationId":"updateEcosystem","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/name"},"integrations":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MattrIntegration"},{"$ref":"#/components/schemas/VicalIntegration"}]}}}}}}},"responses":{"200":{"description":"Ecosystem updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ecosystem"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_UPDATE_START","ECOSYSTEM_UPDATE_SUCCESS","ECOSYSTEM_UPDATE_FAIL"]},"delete":{"tags":["Ecosystems"],"summary":"Delete ecosystem","x-roles":["admin","dts-provider"],"description":"Deletes an ecosystem by its ID.","operationId":"deleteEcosystem","responses":{"204":{"description":"Ecosystem deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_DELETE_START","ECOSYSTEM_DELETE_SUCCESS","ECOSYSTEM_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/policies":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Policy"],"summary":"Publish policy","x-roles":["admin","dts-provider"],"description":"Publish a new version of the ecosystem policy. Only active and currently valid participants and IACA certificates are included in the policy.","operationId":"createEcosystemPolicy","responses":{"201":{"description":"Ecosystem policy published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePolicyResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_POLICY_CREATE_START","ECOSYSTEM_POLICY_CREATE_SUCCESS","ECOSYSTEM_POLICY_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/policies/public/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["Policy"],"summary":"Retrieve latest ecosystem policy","description":"Retrieves the latest ecosystem policy by providing the ecosystem ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getLatestEcosystemPolicy","parameters":[{"$ref":"#/components/parameters/ifNoneMatch"},{"$ref":"#/components/parameters/acceptEncoding"}],"responses":{"200":{"headers":{"ETag":{"description":"An Entity Tag (ETag) is a unique identifier assigned to a specific version of a resource. It allows clients to check if a resource has been modified since it was last retrieved.","schema":{"type":"string","format":"byte"},"example":"MTcwMTIyMDgzNzMzOA=="}},"description":"Latest ecosystem policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemPolicy"}}}},"304":{"$ref":"#/components/responses/304"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_POLICY_RETRIEVE_LATEST_START","ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS","ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/policy":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"deprecated":true,"security":[],"tags":["Policy"],"summary":"Retrieve ecosystem policy","description":"Retrieves an ecosystem policy by providing the ecosystem ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getEcosystemPolicy","parameters":[{"$ref":"#/components/parameters/ifNoneMatch"},{"$ref":"#/components/parameters/acceptEncoding"}],"responses":{"200":{"headers":{"ETag":{"description":"An Entity Tag (ETag) is a unique identifier assigned to a specific version of a resource. It allows clients to check if a resource has been modified since it was last retrieved.","schema":{"type":"string","format":"byte"},"example":"MTcwMTIyMDgzNzMzOA=="}},"description":"Ecosystem policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemPolicy"}}}},"304":{"$ref":"#/components/responses/304"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_POLICY_RETRIEVE_LATEST_START","ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS","ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/issuer-policies":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Issuer Policy"],"summary":"Publish issuer policy","x-roles":["admin","dts-provider"],"description":"Publish a new version of the ecosystem issuer policy. A participant is included only if it is active and has at least one issuer certificate that passes validation. Only the certificates that pass validation are included.","operationId":"createIssuerPolicy","responses":{"201":{"description":"Issuer policy published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerPolicy"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_CREATE_START","ECOSYSTEM_ISSUER_POLICY_CREATE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/issuer-policies/preview":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"tags":["Issuer Policy"],"summary":"Retrieve issuer policy preview","x-roles":["admin","dts-provider"],"description":"Retrieves an ecosystem issuer policy preview by providing the ecosystem's ID. A policy preview includes all the participants and their issuer certificates created in the ecosystem, including those that fail validation and would be excluded from a published policy. The validation result is provided for each certificate.","operationId":"getIssuerPolicyPreview","responses":{"200":{"description":"Issuer policy preview retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerPolicyPreview"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_PREVIEW_RETRIEVE_START","ECOSYSTEM_ISSUER_POLICY_PREVIEW_RETRIEVE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_PREVIEW_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/issuer-policies/public/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["Issuer Policy"],"summary":"Retrieve latest issuer policy","description":"Retrieves the latest published ecosystem issuer policy by providing the ecosystem ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getLatestIssuerPolicy","responses":{"200":{"description":"Latest issuer policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerPolicy"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_RETRIEVE_LATEST_START","ECOSYSTEM_ISSUER_POLICY_RETRIEVE_LATEST_SUCCESS","ECOSYSTEM_ISSUER_POLICY_RETRIEVE_LATEST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/issuer-policies/public/{id}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/issuerPolicyId"}],"get":{"security":[],"tags":["Issuer Policy"],"summary":"Retrieve issuer policy by ID","description":"Retrieves a specific published ecosystem issuer policy by providing the ecosystem ID and the issuer policy ID. The issuer policy ID is the `id` returned when a policy is published, and is also included in the response from the [Retrieve latest issuer policy](#operation/getLatestIssuerPolicy) endpoint.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getIssuerPolicyById","responses":{"200":{"description":"Issuer policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerPolicy"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_RETRIEVE_START","ECOSYSTEM_ISSUER_POLICY_RETRIEVE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/issuer-policies/{id}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/issuerPolicyId"}],"delete":{"tags":["Issuer Policy"],"summary":"Delete issuer policy","x-roles":["admin","dts-provider"],"description":"Deletes a specific published ecosystem issuer policy by providing the ecosystem ID and the issuer policy ID. The\nissuer policy ID is the `id` returned when a policy is published, and is also included in the response from the\n[Retrieve latest issuer policy](#operation/getLatestIssuerPolicy) endpoint.","operationId":"deleteIssuerPolicy","responses":{"204":{"description":"Issuer policy deleted"},"404":{"description":"Ecosystem not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_DELETE_START","ECOSYSTEM_ISSUER_POLICY_DELETE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/verifier-policies":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Verifier Policy"],"summary":"Publish verifier policy","x-roles":["admin","dts-provider"],"description":"Publish a new version of the ecosystem verifier policy. A participant is included only if it is active and has at least one verifier certificate that passes validation. Only the certificates that pass validation are included.","operationId":"createVerifierPolicy","responses":{"201":{"description":"Verifier policy published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierPolicy"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_CREATE_START","ECOSYSTEM_VERIFIER_POLICY_CREATE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/verifier-policies/preview":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"tags":["Verifier Policy"],"summary":"Retrieve verifier policy preview","x-roles":["admin","dts-provider"],"description":"Retrieves an ecosystem verifier policy preview by providing the ecosystem's ID. A policy preview includes all the participants and their verifier certificates created in the ecosystem, including those that fail validation and would be excluded from a published policy. The validation result is provided for each certificate.","operationId":"getVerifierPolicyPreview","responses":{"200":{"description":"Verifier policy preview retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierPolicyPreview"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_START","ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_PREVIEW_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/verifier-policies/public/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["Verifier Policy"],"summary":"Retrieve latest verifier policy","description":"Retrieves the latest published ecosystem verifier policy by providing the ecosystem ID.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getLatestVerifierPolicy","responses":{"200":{"description":"Latest verifier policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierPolicy"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_START","ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_LATEST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/verifier-policies/public/{id}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/verifierPolicyId"}],"get":{"security":[],"tags":["Verifier Policy"],"summary":"Retrieve verifier policy by ID","description":"Retrieves a specific published ecosystem verifier policy by providing the ecosystem ID and the verifier policy ID. The verifier policy ID is the `id` returned when a policy is published, and is also included in the response from the [Retrieve latest verifier policy](#operation/getLatestVerifierPolicy) endpoint.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getVerifierPolicyById","responses":{"200":{"description":"Verifier policy retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierPolicy"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_START","ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/verifier-policies/{id}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/verifierPolicyId"}],"delete":{"tags":["Verifier Policy"],"summary":"Delete verifier policy by ID","x-roles":["admin","dts-provider"],"description":"Deletes a specific published ecosystem verifier policy by providing the ecosystem ID and the verifier policy ID.\nThe verifier policy ID is the `id` returned when a policy is published, and is also included in the response\nfrom the [Retrieve latest verifier policy](#operation/getLatestVerifierPolicy) endpoint.","operationId":"deleteVerifierPolicyById","responses":{"204":{"description":"Verifier policy deleted"},"404":{"description":"Ecosystem not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_DELETE_START","ECOSYSTEM_VERIFIER_POLICY_DELETE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"tags":["Participants"],"summary":"Retrieve participants","x-roles":["admin","dts-provider"],"description":"Retrieves a list of participants from the requested ecosystem.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"operationId":"getEcosystemParticipants","responses":{"200":{"description":"Participants retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_START","ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_FAIL"]},"post":{"tags":["Participants"],"summary":"Create participant","x-roles":["admin","dts-provider"],"description":"Creates a participant in the requested ecosystem.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Participant"}}}},"operationId":"createEcosystemParticipant","responses":{"201":{"description":"Participant created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Participant"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CREATE_START","ECOSYSTEM_PARTICIPANT_CREATE_SUCCESS","ECOSYSTEM_PARTICIPANT_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/participantId"}],"get":{"tags":["Participants"],"summary":"Retrieve participant","x-roles":["admin","dts-provider"],"description":"Retrieves a participant from the requested ecosystem by its ID.","operationId":"getEcosystemParticipant","responses":{"200":{"description":"Participant retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Participant"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_RETRIEVE_START","ECOSYSTEM_PARTICIPANT_RETRIEVE_SUCCESS","ECOSYSTEM_PARTICIPANT_RETRIEVE_FAIL"]},"put":{"tags":["Participants"],"summary":"Update participant","x-roles":["admin","dts-provider"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Participant"}}}},"description":"Updates a participant in the requested ecosystem by its ID.","operationId":"updateEcosystemParticipant","responses":{"200":{"description":"Participant updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Participant"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_UPDATE_START","ECOSYSTEM_PARTICIPANT_UPDATE_SUCCESS","ECOSYSTEM_PARTICIPANT_UPDATE_FAIL"]},"delete":{"tags":["Participants"],"summary":"Delete participant","x-roles":["admin","dts-provider"],"description":"Deletes a participant in the requested ecosystem by its ID.","operationId":"deleteEcosystemParticipant","responses":{"204":{"description":"Participant deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_DELETE_START","ECOSYSTEM_PARTICIPANT_DELETE_SUCCESS","ECOSYSTEM_PARTICIPANT_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Participants contacts"],"summary":"Create a participant point of contact","x-roles":["admin","dts-provider"],"description":"Create a new point of contact for the specified participant. A maximum of 10 contacts can exist per participant.","operationId":"createParticipantContact","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactRequest"}}}},"responses":{"201":{"description":"Participant point of contact created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_START","ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_SUCCESS","ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_FAIL"]},"get":{"tags":["Participants contacts"],"summary":"Retrieve all participant points of contact","x-roles":["admin","dts-provider"],"description":"Retrieve all points of contact for given participant.","operationId":"retrieveParticipantContacts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Participant points of contact retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantContactResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_START","ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts/{contactId}":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/contactId"}],"get":{"tags":["Participants contacts"],"summary":"Retrieve a participant point of contact","x-roles":["admin","dts-provider"],"description":"Retrieve a specific point of contact for a given participant.","operationId":"retrieveParticipantContact","responses":{"200":{"description":"Participant point of contact retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_START","ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_SUCCESS","ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_FAIL"]},"delete":{"tags":["Participants contacts"],"summary":"Delete a participant point of contact","x-roles":["admin","dts-provider"],"description":"Delete a specific point of contact for a given participant.","operationId":"deleteParticipantContact","responses":{"204":{"description":"Participant point of contact deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_START","ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_SUCCESS","ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_FAIL"]},"put":{"tags":["Participants contacts"],"summary":"Update a participant point of contact","x-roles":["admin","dts-provider"],"description":"Update a specific point of contact for a given participant.","operationId":"updateParticipantContact","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactRequest"}}}},"responses":{"200":{"description":"Participant point of contact updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_START","ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_SUCCESS","ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Participants evidence"],"summary":"Upload PDF evidence","x-roles":["admin","dts-provider"],"description":"Upload a PDF file as evidence for the given participant. Maximum file size is 10MB.","operationId":"uploadPdfEvidence","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"fileDescription":{"type":"string"},"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Evidence PDF uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantEvidence"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_CREATE_FAIL"]},"get":{"tags":["Participants evidence"],"summary":"Retrieve all PDF evidence metadata","x-roles":["admin","dts-provider"],"description":"Retrieve metadata for all PDF evidence uploaded for given participant.","operationId":"retrievePdfEvidenceList","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"PDF evidence metadata retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantEvidence"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/evidenceId"}],"get":{"tags":["Participants evidence"],"summary":"Retrieve a PDF evidence metadata","x-roles":["admin","dts-provider"],"description":"Retrieve metadata for a given uploaded PDF evidence.","operationId":"retrievePdfEvidence","responses":{"200":{"description":"Evidence retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantEvidence"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_RETRIEVE_FAIL"]},"put":{"tags":["Participants evidence"],"summary":"Update PDF evidence metadata","x-roles":["admin","dts-provider"],"description":"Update metadata for a given uploaded PDF evidence.","operationId":"updatePdfEvidence","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileDescription":{"type":"string"}}}}}},"responses":{"200":{"description":"Evidence PDF metadata updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantEvidence"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_UPDATE_FAIL"]},"delete":{"tags":["Participants evidence"],"summary":"Delete PDF evidence","x-roles":["admin","dts-provider"],"description":"Delete metadata for a given uploaded PDF evidence and remove it from storage.","operationId":"deletePdfEvidence","responses":{"204":{"description":"PDF Evidence deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/evidence/{evidenceId}/download":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/evidenceId"}],"get":{"tags":["Participants evidence"],"summary":"Download PDF evidence","x-roles":["admin","dts-provider"],"description":"Retrieves a specific PDF evidence file.","operationId":"downloadPdfEvidence","responses":{"200":{"description":"PDF Evidence file retrieved","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_START","ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_SUCCESS","ECOSYSTEM_PARTICIPANT_EVIDENCE_DOWNLOAD_FAIL"]}},"/v1/ecosystems/{ecosystemId}/credentials":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Credential types"],"summary":"Create credential type","x-roles":["admin","dts-provider"],"description":"Creates a new credential type in the requested ecosystem.","operationId":"createEcosystemCredential","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}}},"required":true},"responses":{"201":{"description":"Credential type created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_CREDENTIAL_CREATE_START","ECOSYSTEM_CREDENTIAL_CREATE_SUCCESS","ECOSYSTEM_CREDENTIAL_CREATE_FAIL"]},"get":{"tags":["Credential types"],"summary":"Retrieve credential types","x-roles":["admin","dts-provider"],"description":"Retrieves a list of credential types from the requested ecosystem.","operationId":"getEcosystemCredentials","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Credential types retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_START","ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/credentials/{credentialId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/credentialId"}],"get":{"tags":["Credential types"],"summary":"Retrieve credential type","x-roles":["admin","dts-provider"],"description":"Retrieves a credential type from the requested ecosystem by its ID.","operationId":"getEcosystemCredential","responses":{"200":{"description":"Credential type retrieved","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_CREDENTIAL_RETRIEVE_START","ECOSYSTEM_CREDENTIAL_RETRIEVE_SUCCESS","ECOSYSTEM_CREDENTIAL_RETRIEVE_FAIL"]},"delete":{"tags":["Credential types"],"summary":"Delete credential type","x-roles":["admin","dts-provider"],"description":"Deletes a credential type from the requested ecosystem by its ID.","operationId":"deleteEcosystemCredential","responses":{"204":{"description":"Credential type deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_CREDENTIAL_DELETE_START","ECOSYSTEM_CREDENTIAL_DELETE_SUCCESS","ECOSYSTEM_CREDENTIAL_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/issuer/credentials":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/participantId"}],"post":{"tags":["Participants assignment"],"summary":"Create issuer assignment","x-roles":["admin","dts-provider"],"description":"Assigns a credential type to the requested participant in the requested ecosystem.","operationId":"createEcosystemIssuerPolicy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credentialId":{"type":"string","format":"uuid","example":"599bf148-d711-405a-a20b-9c8a87ac8850","examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]}}}}}},"responses":{"201":{"description":"Issuer policy created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_CREATE_START","ECOSYSTEM_ISSUER_POLICY_CREATE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/issuer/credentials/{credentialId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/credentialId"}],"delete":{"tags":["Participants assignment"],"summary":"Delete issuer assignment","x-roles":["admin","dts-provider"],"description":"Removes a credential type to the requested participant in the requested ecosystem.","operationId":"deleteEcosystemIssuerPolicy","responses":{"204":{"description":"Issuer policy deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_ISSUER_POLICY_DELETE_START","ECOSYSTEM_ISSUER_POLICY_DELETE_SUCCESS","ECOSYSTEM_ISSUER_POLICY_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/verifier/credentials":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/participantId"}],"post":{"tags":["Participants assignment"],"summary":"Create verifier assignment","x-roles":["admin","dts-provider"],"description":"Assigns a credential type to the requested participant in the requested ecosystem.","operationId":"createEcosystemVerifierPolicy","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credentialId":{"type":"string","format":"uuid","example":"599bf148-d711-405a-a20b-9c8a87ac8850","examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]}}}}}},"responses":{"201":{"description":"Verifier policy created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Credential"},{"$ref":"#/components/schemas/CredentialMobile"}]}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_CREATE_START","ECOSYSTEM_VERIFIER_POLICY_CREATE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/verifier/credentials/{credentialId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/credentialId"}],"delete":{"tags":["Participants assignment"],"summary":"Delete verifier assignment","x-roles":["admin","dts-provider"],"description":"Removes a credential type from the requested participant in the requested ecosystem..","operationId":"deleteEcosystemVerifierPolicy","responses":{"204":{"description":"Verifier policy deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_VERIFIER_POLICY_DELETE_START","ECOSYSTEM_VERIFIER_POLICY_DELETE_SUCCESS","ECOSYSTEM_VERIFIER_POLICY_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/issuer-certificates":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Participants issuer certificates"],"summary":"Create a participant issuer certificate","x-roles":["admin","dts-provider"],"description":"Create a new issuer certificate for the specified participant.\n\nThe certificatePem field cannot be modified once the certificate is created.\n\nTo maintain trust continuity across a certificate rotation, provide `linkCertificateInfo`\nto add this certificate as a successor to a previously uploaded certificate. Link\ncertificates can only be added when the certificate is created, not when it is updated.","operationId":"createParticipantIssuerCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerCertificateCreateRequest"}}}},"responses":{"201":{"description":"Participant issuer certificate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_CREATE_START","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["Participants issuer certificates"],"summary":"Retrieve all participant issuer certificates","x-roles":["admin","dts-provider"],"description":"Retrieve all issuer certificates for the specified participant.","operationId":"retrieveParticipantIssuerCertificates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Participant issuer certificates retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IssuerCertificateResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/issuer-certificates/{issuerCertificateId}":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/issuerCertificateId"}],"get":{"tags":["Participants issuer certificates"],"summary":"Retrieve a participant issuer certificate","x-roles":["admin","dts-provider"],"description":"Retrieve a specific issuer certificate for the specified participant.","operationId":"retrieveParticipantIssuerCertificate","responses":{"200":{"description":"Participant issuer certificate retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_RETRIEVE_FAIL"]},"put":{"tags":["Participants issuer certificates"],"summary":"Update a participant issuer certificate","x-roles":["admin","dts-provider"],"description":"Update a specific issuer certificate for the specified participant.","operationId":"updateParticipantIssuerCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerCertificateUpdateRequest"}}}},"responses":{"200":{"description":"Participant issuer certificate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_UPDATE_START","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["Participants issuer certificates"],"summary":"Delete a participant issuer certificate","x-roles":["admin","dts-provider"],"description":"Delete a specific issuer certificate for the specified participant.","operationId":"deleteParticipantIssuerCertificate","responses":{"204":{"description":"Participant issuer certificate deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_DELETE_START","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_PARTICIPANT_ISSUER_CERTIFICATE_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/verifier-certificates":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["Participants verifier certificates"],"summary":"Create a participant verifier certificate","x-roles":["admin","dts-provider"],"description":"Create a new verifier certificate for the specified participant.\n\nThe certificatePem field cannot be modified once the certificate is created.\n\nTo maintain trust continuity across a certificate rotation, provide `linkCertificateInfo`\nto add this certificate as a successor to a previously uploaded certificate. Link\ncertificates can only be added when the certificate is created, not when it is updated.","operationId":"createParticipantVerifierCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCertificateCreateRequest"}}}},"responses":{"201":{"description":"Participant verifier certificate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_CREATE_START","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["Participants verifier certificates"],"summary":"Retrieve all participant verifier certificates","x-roles":["admin","dts-provider"],"description":"Retrieve all verifier certificates for the specified participant.","operationId":"retrieveParticipantVerifierCertificates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Participant verifier certificates retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VerifierCertificateResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/participants/{participantId}/verifier-certificates/{verifierCertificateId}":{"parameters":[{"$ref":"#/components/parameters/participantId"},{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/verifierCertificateId"}],"get":{"tags":["Participants verifier certificates"],"summary":"Retrieve a participant verifier certificate","x-roles":["admin","dts-provider"],"description":"Retrieve a specific verifier certificate for the specified participant.","operationId":"retrieveParticipantVerifierCertificate","responses":{"200":{"description":"Participant verifier certificate retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_RETRIEVE_FAIL"]},"put":{"tags":["Participants verifier certificates"],"summary":"Update a participant verifier certificate","x-roles":["admin","dts-provider"],"description":"Update a specific verifier certificate for the specified participant.","operationId":"updateParticipantVerifierCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCertificateUpdateRequest"}}}},"responses":{"200":{"description":"Participant verifier certificate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifierCertificateResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_UPDATE_START","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["Participants verifier certificates"],"summary":"Delete a participant verifier certificate","x-roles":["admin","dts-provider"],"description":"Delete a specific verifier certificate for the specified participant.","operationId":"deleteParticipantVerifierCertificate","responses":{"204":{"description":"Participant verifier certificate deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_DELETE_START","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_PARTICIPANT_VERIFIER_CERTIFICATE_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/preview":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"tags":["Policy"],"summary":"Retrieve ecosystem policy preview","x-roles":["admin","dts-provider"],"description":"Retrieves an ecosystem policy preview by providing the Ecosystem's ID. A policy preview includes all the participants and credential types created in the ecosystem, excluding any participants with expired or inactive IACAs.","operationId":"getEcosystemPolicyPreview","parameters":[{"$ref":"#/components/parameters/acceptEncoding"}],"responses":{"200":{"description":"Ecosystem policy preview retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcosystemPolicyPreview"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_START","ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_SUCCESS","ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/vicals":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["VICAL"],"summary":"Create VICAL","x-roles":["admin","dts-provider"],"description":"Creates a Verified Issuer Certificate Authority List (VICAL) based on the policy of the requested ecosystem. Refer to VICAL to learn more about the [VICAL](https://learn.mattr.global/docs/digital-trust-service/vical-overview) purpose and data structure.","operationId":"createVical","responses":{"201":{"description":"VICAL created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vical"}}}},"500":{"$ref":"#/components/responses/500"}}}},"/v1/ecosystems/{ecosystemId}/vicals/public":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["VICAL"],"summary":"Retrieve all VICALs","description":"Retrieves all VICALs available in the requested ecosystem.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"operationId":"getVicals","responses":{"200":{"description":"VICALs retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VicalWithFilename"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/{ecosystemId}/vicals/public/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["VICAL"],"summary":"Retrieve latest VICAL","description":"Retrieves the latest VICAL from the requested ecosystem.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getLatestVical","responses":{"200":{"description":"VICAL retrieved","headers":{"Content-Type":{"description":"The media type of the file","schema":{"type":"string","example":"application/cbor","examples":["application/cbor"]}},"Content-Disposition":{"description":"Indicates file attachment","schema":{"type":"string","example":"attachment; filename=\"vical-2024-07-28-1722164473000.cbor\"","examples":["attachment; filename=\"vical-2024-07-28-1722164473000.cbor\""]}},"Content-Length":{"description":"The size of the file in bytes","schema":{"type":"number","example":1843,"examples":[1843]}}},"content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/{ecosystemId}/vicals/public/{vicalIssueId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/vicalIssueId"}],"get":{"security":[],"tags":["VICAL"],"summary":"Retrieve specific VICAL","description":"Retrieves a specific VICAL from the requested ecosystem by providing the VICAL version identifier.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getVical","responses":{"200":{"description":"VICAL retrieved","headers":{"Content-Type":{"description":"The media type of the file","schema":{"type":"string","example":"application/cbor","examples":["application/cbor"]}},"Content-Disposition":{"description":"Indicates file attachment","schema":{"type":"string","example":"attachment; filename=\"vical-2024-07-28-1722164473000.cbor\"","examples":["attachment; filename=\"vical-2024-07-28-1722164473000.cbor\""]}},"Content-Length":{"description":"The size of the file in bytes","schema":{"type":"number","example":1843,"examples":[1843]}}},"content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/{ecosystemId}/vicals/{vicalIssueId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/vicalIssueId"}],"delete":{"tags":["VICAL"],"summary":"Delete specific VICAL","x-roles":["admin","dts-provider"],"description":"Deletes a specific VICAL from the requested ecosystem by providing the VICAL version identifier.\nDeleting a VICAL also deletes the issuer policy published from it, if one exists. This action\ncannot be undone.\n\nA `404` is only returned when the ecosystem does not exist. Deleting a `vicalIssueId` that does\nnot exist within an existing ecosystem still returns `204`.","operationId":"deleteVical","responses":{"204":{"description":"VICAL deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"description":"Ecosystem not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"x-analytic-events":["ECOSYSTEM_VICAL_DELETE_START","ECOSYSTEM_VICAL_DELETE_SUCCESS","ECOSYSTEM_VICAL_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/vicals/configuration":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"put":{"tags":["VICAL Configuration"],"summary":"Update VICAL configuration","x-roles":["admin","dts-provider"],"description":"Update the VICAL configuration for the requested ecosystem","operationId":"updateVicalConfiguration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VicalConfigurationData"}}}},"responses":{"200":{"description":"VICAL configuration updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VicalConfigurationData"},{"type":"object","properties":{"autoPublish":{"type":"object","properties":{"configuredAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"The date and time when the auto-publish was configured. Only returned when `enabled` is `true`.","examples":["2025-07-01T00:00:00.000Z"]}}}}}]}}}},"400":{"$ref":"#/components/responses/400"}}},"get":{"tags":["VICAL Configuration"],"summary":"Retrieve VICAL configuration","x-roles":["admin","dts-provider"],"description":"Retrieve the VICAL configuration from the requested ecosystem","operationId":"getVicalConfiguration","responses":{"200":{"description":"VICAL configuration retrieved","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VicalConfigurationData"},{"type":"object","properties":{"autoPublish":{"type":"object","properties":{"configuredAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"The date and time when the auto-publish was configured. Only returned when `enabled` is `true`.","examples":["2025-07-01T00:00:00.000Z"]}}}}}]}}}},"404":{"$ref":"#/components/responses/404"}}},"delete":{"tags":["VICAL Configuration"],"summary":"Delete VICAL configuration","x-roles":["admin","dts-provider"],"description":"Delete the VICAL configuration for the requested ecosystem","operationId":"deleteVicalConfiguration","responses":{"204":{"description":"VICAL configuration deleted"},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/certificates/ca":{"post":{"tags":["DTS root CA certificates"],"summary":"Create a DTS root CA certificate","x-roles":["admin","dts-provider"],"description":"Creates a DTS root CA certificate which is used to sign DTS intermediate and/or signer certificates.\n- A maximum of three DTS root CA certificates can be created per tenant.","operationId":"createDtsCaCertificate","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DtsCaCreateRequestManaged"},{"$ref":"#/components/schemas/DtsCaCreateRequestUnmanaged"}]}}}},"responses":{"201":{"description":"DTS root CA certificate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Maximum number of DTS CA certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_START","ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["DTS root CA certificates"],"summary":"Retrieve all DTS root CA certificates","x-roles":["admin","dts-provider"],"description":"Retrieves all DTS root CA certificates.","operationId":"getDtsCaCertificates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"DTS root CA certificates retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtsCaResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/certificates/ca/{dtsCaCertificateId}":{"parameters":[{"$ref":"#/components/parameters/dtsCaCertificateId"}],"delete":{"tags":["DTS root CA certificates"],"summary":"Delete a DTS root CA certificate","x-roles":["admin","dts-provider"],"description":"Deletes a DTS root CA certificate.","operationId":"deleteDtsCaCertificate","responses":{"204":{"description":"DTS root CA certificate deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_START","ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_FAIL"]},"put":{"tags":["DTS root CA certificates"],"summary":"Update a DTS root CA certificate","x-roles":["admin","dts-provider"],"description":"Updates a DTS root CA certificate.","operationId":"updateDtsCaCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsCaUpdateRequest"}}}},"responses":{"200":{"description":"DTS root CA certificate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_START","ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_FAIL"]},"get":{"tags":["DTS root CA certificates"],"summary":"Retrieve a DTS root CA certificate","x-roles":["admin","dts-provider"],"description":"Retrieves a DTS root CA certificate.","operationId":"getDtsCaCertificate","responses":{"200":{"description":"DTS root CA certificate retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsCaResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_FAIL"]}},"/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/crl":{"parameters":[{"$ref":"#/components/parameters/dtsCaCertificateId"}],"get":{"security":[],"tags":["DTS root CA certificates"],"summary":"Retrieve a DTS root CA certificate revocation list","description":"Retrieves the revocation list for a given DTS root CA certificate.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getDtsCaCertificateRevocationList","responses":{"200":{"description":"DTS root CA certificate revocation list retrieved","content":{"application/json":{"schema":{"type":"string","format":"byte"}}}},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/public/certificates/ca":{"get":{"security":[],"tags":["DTS root CA certificates"],"summary":"Retrieve all public DTS root CA certificates","description":"Retrieves all public DTS root CA certificates.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getDtsCaCertificatePublic","responses":{"200":{"description":"Public DTS root CA certificates retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsCaPublicResponse"}}}}}}},"/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate":{"parameters":[{"$ref":"#/components/parameters/dtsCaCertificateId"}],"post":{"tags":["DTS intermediate CA certificates"],"summary":"Create a DTS intermediate CA certificate","x-roles":["admin","dts-provider"],"description":"Creates a DTS intermediate CA certificate, which sits between the DTS root CA certificate and the signer certificate to sign DTS signer certificates.\n\nDTS intermediate CA certificates are only relevant when using the 3-tier certificate model, where a DTS root CA signs an intermediate CA, which in turn signs the signer certificate. They are only supported for unmanaged (external) DTS root CA certificates that have `useIntermediateCa` set to `true`. For an explanation of the 2-tier and 3-tier models and guidance on choosing between them, refer to the [DTS certificates overview](https://learn.mattr.global/docs/digital-trust-service/certificates-overview#certificate-models-2-tier-and-3-tier).","operationId":"createDtsIntermediateCaCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["certificatePem","usages"],"properties":{"certificatePem":{"type":"string","description":"DTS intermediate CA certificate encoded in PEM format"},"usages":{"type":"array","minItems":1,"description":"The intended usages for this intermediate CA. Must contain at least one value.","items":{"type":"string","enum":["VICAL","RICAL"]}}}}}}},"responses":{"201":{"description":"DTS intermediate CA certificate created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsIntermediateCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_CREATE_START","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["DTS intermediate CA certificates"],"summary":"Retrieve all DTS intermediate CA certificates under a root CA","x-roles":["admin","dts-provider"],"description":"Retrieves all DTS intermediate CA certificates issued under the specified DTS root CA.","operationId":"getDtsIntermediateCaCertificates","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"DTS intermediate CA certificates retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtsIntermediateCaResponse"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate/{dtsIntermediateCaCertificateId}":{"parameters":[{"$ref":"#/components/parameters/dtsCaCertificateId"},{"$ref":"#/components/parameters/dtsIntermediateCaCertificateId"}],"delete":{"tags":["DTS intermediate CA certificates"],"summary":"Delete a DTS intermediate CA certificate","x-roles":["admin","dts-provider"],"description":"Deletes a DTS intermediate CA certificate.","operationId":"deleteDtsIntermediateCaCertificate","responses":{"204":{"description":"DTS intermediate CA certificate deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_DELETE_START","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_DELETE_FAIL"]},"put":{"tags":["DTS intermediate CA certificates"],"summary":"Update a DTS intermediate CA certificate","x-roles":["admin","dts-provider"],"description":"Updates a DTS intermediate CA certificate.","operationId":"updateDtsIntermediateCaCertificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsIntermediateCaUpdateRequest"}}}},"responses":{"200":{"description":"DTS intermediate CA certificate updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsIntermediateCaResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_UPDATE_START","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_UPDATE_FAIL"]},"get":{"tags":["DTS intermediate CA certificates"],"summary":"Retrieve a DTS intermediate CA certificate","x-roles":["admin","dts-provider"],"description":"Retrieves a DTS intermediate CA certificate.","operationId":"getDtsIntermediateCaCertificate","responses":{"200":{"description":"DTS intermediate CA certificate retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DtsIntermediateCaResponse"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_DTS_INTERMEDIATE_CA_CERTIFICATE_RETRIEVE_FAIL"]}},"/v1/ecosystems/certificates/vical-signers":{"post":{"tags":["VICAL signers"],"summary":"Create a VICAL signer","x-roles":["admin","dts-provider"],"description":"Creates a VICAL signer.\n- Only available in implementations using unmanaged (external) DTS root CA certificates.\n- A maximum of five VICAL signers can be created per tenant.","operationId":"createVicalSigner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VicalSignerCreateRequest"}}}},"responses":{"201":{"description":"VICAL signer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVicalSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Maximum number of VICAL signer certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_START","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["VICAL signers"],"summary":"Retrieve all VICAL signers","x-roles":["admin","dts-provider"],"description":"Retrieves all VICAL signers.","operationId":"getVicalSigners","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"VICAL signers retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UpdateVicalSignerResponse"},{"$ref":"#/components/schemas/CreateVicalSignerResponse"}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/certificates/vical-signers/{vicalSignerId}":{"parameters":[{"$ref":"#/components/parameters/vicalSignerId"}],"put":{"tags":["VICAL signers"],"summary":"Update a VICAL signer","x-roles":["admin","dts-provider"],"description":"Updates a VICAL signer by:\n- Providing a VICAL Signer Certificate (VSC) in PEM format that matches its Certificate Signing Request (CSR).\n- Activating or deactivating the VICAL signer. Only VICAL signers with a valid `certificatePem` can be activated.\n- The `certificatePem` field becomes immutable after it's updated for the first time.\n\n\nOnly available in implementations using unmanaged (external) DTS root CA certificates.\n","operationId":"updateVicalSigner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VicalSignerUpdateRequest"}}}},"responses":{"200":{"description":"VICAL signer updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVicalSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_START","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["VICAL signers"],"summary":"Delete a VICAL signer","x-roles":["admin","dts-provider"],"description":"Deletes a VICAL signer.\n\n\nOnly available in implementations using unmanaged (external) DTS root CA certificates.\n","operationId":"deleteVicalSigner","responses":{"204":{"description":"VICAL signer deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_START","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_FAIL"]},"get":{"tags":["VICAL signers"],"summary":"Retrieve a VICAL signer","x-roles":["admin","dts-provider"],"description":"Retrieves a VICAL signer.","operationId":"getVicalSignerCertificate","responses":{"200":{"description":"VICAL signer retrieved","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateVicalSignerResponse"},{"$ref":"#/components/schemas/CreateVicalSignerResponse"}]}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"post":{"tags":["RICAL"],"summary":"Create RICAL","x-roles":["admin","dts-provider"],"description":"Creates a Reader Identity Certificate Authority List (RICAL) based on the policy of the requested ecosystem.\n\nA [RICAL configuration](#operation/updateRicalConfiguration) is required in order for RICALs to be created.","operationId":"createRical","responses":{"201":{"description":"RICAL created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rical"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"x-analytic-events":["ECOSYSTEM_RICAL_CREATE_START","ECOSYSTEM_RICAL_CREATE_SUCCESS","ECOSYSTEM_RICAL_CREATE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals/public":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["RICAL"],"summary":"Retrieve all RICALs","description":"Retrieves all RICALs available in the requested ecosystem.\n\nThe response is a JSON list of the published RICALs and their version identifiers. To download an actual RICAL file (a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5), call the [Retrieve specific RICAL](#operation/getRical) or [Retrieve latest RICAL](#operation/getLatestRical) endpoint.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"operationId":"getRicals","responses":{"200":{"description":"RICALs retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RicalWithFilename"}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_RETRIEVE_LIST_START","ECOSYSTEM_RICAL_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_RICAL_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals/public/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["RICAL"],"summary":"Retrieve latest RICAL","description":"Retrieves the latest RICAL from the requested ecosystem.\n\nThe response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getLatestRical","responses":{"200":{"description":"RICAL retrieved","headers":{"Content-Type":{"description":"The media type of the file","schema":{"type":"string","example":"application/cbor","examples":["application/cbor"]}},"Content-Disposition":{"description":"Indicates file attachment","schema":{"type":"string","example":"attachment; filename=\"rical-2024-07-28-1722164473000.cbor\"","examples":["attachment; filename=\"rical-2024-07-28-1722164473000.cbor\""]}},"Content-Length":{"description":"The size of the file in bytes","schema":{"type":"number","example":1843,"examples":[1843]}}},"content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_RETRIEVE_LATEST_START","ECOSYSTEM_RICAL_RETRIEVE_LATEST_SUCCESS","ECOSYSTEM_RICAL_RETRIEVE_LATEST_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals/public/{ricalIssueId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/ricalIssueId"}],"get":{"security":[],"tags":["RICAL"],"summary":"Retrieve specific RICAL","description":"Retrieves a specific RICAL from the requested ecosystem by providing the RICAL version identifier.\n\nThe response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getRical","responses":{"200":{"description":"RICAL retrieved","headers":{"Content-Type":{"description":"The media type of the file","schema":{"type":"string","example":"application/cbor","examples":["application/cbor"]}},"Content-Disposition":{"description":"Indicates file attachment","schema":{"type":"string","example":"attachment; filename=\"rical-2024-07-28-1722164473000.cbor\"","examples":["attachment; filename=\"rical-2024-07-28-1722164473000.cbor\""]}},"Content-Length":{"description":"The size of the file in bytes","schema":{"type":"number","example":1843,"examples":[1843]}}},"content":{"application/cbor":{"schema":{"type":"string","format":"binary"}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_RETRIEVE_START","ECOSYSTEM_RICAL_RETRIEVE_SUCCESS","ECOSYSTEM_RICAL_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals/{ricalIssueId}":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/ricalIssueId"}],"delete":{"tags":["RICAL"],"summary":"Delete specific RICAL","x-roles":["admin","dts-provider"],"description":"Deletes a specific RICAL from the requested ecosystem by providing the RICAL version identifier.\nDeleting a RICAL also deletes the verifier policy published from it, if one exists. This action\ncannot be undone.\n\nA `404` is only returned when the ecosystem does not exist. Deleting a `ricalIssueId` that does\nnot exist within an existing ecosystem still returns `204`.","operationId":"deleteRical","responses":{"204":{"description":"RICAL deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"description":"Ecosystem not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}}},"x-analytic-events":["ECOSYSTEM_RICAL_DELETE_START","ECOSYSTEM_RICAL_DELETE_SUCCESS","ECOSYSTEM_RICAL_DELETE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/ricals/configuration":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"put":{"tags":["RICAL Configuration"],"summary":"Update RICAL configuration","x-roles":["admin","dts-provider"],"description":"Update the RICAL configuration for the requested ecosystem.\n\nA RICAL configuration is required in order for RICALs to be created.","operationId":"updateRicalConfiguration","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RicalConfigurationData"}}}},"responses":{"200":{"description":"RICAL configuration updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RicalConfigurationData"},{"type":"object","properties":{"autoPublish":{"type":"object","properties":{"configuredAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"The date and time when the auto-publish was configured. Only returned when `enabled` is `true`.","examples":["2025-07-01T00:00:00.000Z"]}}}}}]}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_START","ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_SUCCESS","ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_FAIL"]},"get":{"tags":["RICAL Configuration"],"summary":"Retrieve RICAL configuration","x-roles":["admin","dts-provider"],"description":"Retrieve the RICAL configuration from the requested ecosystem.","operationId":"getRicalConfiguration","responses":{"200":{"description":"RICAL configuration retrieved","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RicalConfigurationData"},{"type":"object","properties":{"autoPublish":{"type":"object","properties":{"configuredAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"The date and time when the auto-publish was configured. Only returned when `enabled` is `true`.","examples":["2025-07-01T00:00:00.000Z"]}}}}}]}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_START","ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_SUCCESS","ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_FAIL"]},"delete":{"tags":["RICAL Configuration"],"summary":"Delete RICAL configuration","x-roles":["admin","dts-provider"],"description":"Delete the RICAL configuration for the requested ecosystem.","operationId":"deleteRicalConfiguration","responses":{"204":{"description":"RICAL configuration deleted"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_CONFIGURATION_DELETE_START","ECOSYSTEM_RICAL_CONFIGURATION_DELETE_SUCCESS","ECOSYSTEM_RICAL_CONFIGURATION_DELETE_FAIL"]}},"/v1/ecosystems/certificates/rical-signers":{"post":{"tags":["RICAL signers"],"summary":"Create a RICAL signer","x-roles":["admin","dts-provider"],"description":"Creates a RICAL signer.\n- Only available in implementations using unmanaged (external) DTS root CA certificates.\n- A maximum of five RICAL signers can be created per tenant.\n\nProvide either `caId` or `intermediateCaId`.","operationId":"createRicalSigner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RicalSignerCreateRequest"}}}},"responses":{"201":{"description":"RICAL signer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRicalSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"409":{"description":"Maximum number of RICAL signer certificates reached. Please delete an existing certificate before creating a new one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-analytic-events":["ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_CREATE_START","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_CREATE_SUCCESS","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_CREATE_FAIL"]},"get":{"tags":["RICAL signers"],"summary":"Retrieve all RICAL signers","x-roles":["admin","dts-provider"],"description":"Retrieves all RICAL signers.","operationId":"getRicalSigners","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"RICAL signers retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UpdateRicalSignerResponse"},{"$ref":"#/components/schemas/CreateRicalSignerResponse"}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}}}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_START","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL"]}},"/v1/ecosystems/certificates/rical-signers/{ricalSignerId}":{"parameters":[{"$ref":"#/components/parameters/ricalSignerId"}],"put":{"tags":["RICAL signers"],"summary":"Update a RICAL signer","x-roles":["admin","dts-provider"],"description":"Updates a RICAL signer by:\n- Providing a RICAL Signer Certificate in PEM format that matches its Certificate Signing Request (CSR).\n- Activating or deactivating the RICAL signer. Only RICAL signers with a valid `certificatePem` can be activated.\n- The `certificatePem` field becomes immutable after it's updated for the first time.\n\n\nOnly available in implementations using unmanaged (external) DTS root CA certificates.\n","operationId":"updateRicalSigner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RicalSignerUpdateRequest"}}}},"responses":{"200":{"description":"RICAL signer updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRicalSignerResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_UPDATE_START","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESS","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_UPDATE_FAIL"]},"delete":{"tags":["RICAL signers"],"summary":"Delete a RICAL signer","x-roles":["admin","dts-provider"],"description":"Deletes a RICAL signer.\n\nDeleting a RICAL signer does not affect any RICALs it has already signed — those remain valid. It only means this signer can no longer be used to sign new RICALs.\n\n\nOnly available in implementations using unmanaged (external) DTS root CA certificates.\n","operationId":"deleteRicalSigner","responses":{"204":{"description":"RICAL signer deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_DELETE_START","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_DELETE_SUCCESS","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_DELETE_FAIL"]},"get":{"tags":["RICAL signers"],"summary":"Retrieve a RICAL signer","x-roles":["admin","dts-provider"],"description":"Retrieves a RICAL signer.","operationId":"getRicalSignerCertificate","responses":{"200":{"description":"RICAL signer retrieved","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateRicalSignerResponse"},{"$ref":"#/components/schemas/CreateRicalSignerResponse"}]}}}},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_START","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS","ECOSYSTEM_RICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL"]}},"/v1/ecosystems/{ecosystemId}/vicals/public/certificates/ca/latest":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"}],"get":{"security":[],"tags":["DTS root CA certificates"],"summary":"Retrieve DTS root CA certificate","description":"Retrieves the latest DTS root CA certificate. This can be used by relying parties to verify a signed VICAL.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","deprecated":true,"operationId":"getLatestVicalCaCertificate","responses":{"200":{"description":"DTS root CA certificate retrieved"},"404":{"$ref":"#/components/responses/404"}}}},"/v1/ecosystems/{ecosystemId}/vicals/public/certificates/ca/{caCertificateId}/crl":{"parameters":[{"$ref":"#/components/parameters/ecosystemId"},{"$ref":"#/components/parameters/caCertificateId"}],"get":{"security":[],"tags":["DTS root CA certificates"],"summary":"Retrieve DTS root CA certificate revocation list","deprecated":true,"description":"Retrieves revocation list for a given DTS root CA certificate.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.","operationId":"getVicalCertificateRevocationList","responses":{"200":{"description":"Revocation list retrieved"},"404":{"$ref":"#/components/responses/404"}}}},"/v1/webhooks":{"post":{"operationId":"createWebhook","tags":["Webhooks"],"summary":"Create Webhook","x-roles":["admin","issuer","managed-issuer"],"description":"Creates a new webhook for this tenant.","requestBody":{"description":"The webhook payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"},"examples":{"Create a Webhook":{"value":{"events":["OpenIdCredentialIssued"],"url":"https://example.com"}}}}}},"responses":{"201":{"description":"Webhook created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["WEBHOOK_CREATE_START","WEBHOOK_CREATE_SUCCESS","WEBHOOK_CREATE_FAIL"]},"get":{"operationId":"getWebhooks","tags":["Webhooks"],"summary":"Retrieve all Webhooks","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieves a list of webhooks configured on the tenant.","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/cursor"}],"responses":{"200":{"description":"Webhooks retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhooksResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["WEBHOOK_RETRIEVE_LIST_START","WEBHOOK_RETRIEVE_LIST_SUCCESS","WEBHOOK_RETRIEVE_LIST_FAIL"]}},"/v1/webhooks/{webhookId}":{"get":{"operationId":"getWebhook","tags":["Webhooks"],"summary":"Retrieve Webhook","x-roles":["admin","issuer","managed-issuer"],"description":"Retrieve a specific Webhook by providing its ID.","parameters":[{"name":"webhookId","in":"path","description":"The requested Webhook ID.","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true}],"responses":{"200":{"description":"Webhook retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookResponse"}}}},"400":{"$ref":"#/components/responses/400"}},"x-analytic-events":["WEBHOOK_RETRIEVE_START","WEBHOOK_RETRIEVE_SUCCESS","WEBHOOK_RETRIEVE_FAIL"]},"put":{"operationId":"updateWebhook","tags":["Webhooks"],"summary":"Update Webhook","x-roles":["admin","issuer","managed-issuer"],"parameters":[{"name":"webhookId","in":"path","description":"Webhook ID","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true}],"description":"Updates an existing Webhook by providing its ID.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}},"description":"Update Webhook"},"responses":{"200":{"description":"Webhook updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["WEBHOOK_UPDATE_START","WEBHOOK_UPDATE_SUCCESS","WEBHOOK_UPDATE_FAIL"]},"delete":{"operationId":"deleteWebhook","tags":["Webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"Webhook ID","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true}],"summary":"Delete Webhook","x-roles":["admin","issuer","managed-issuer"],"description":"Deletes a Webhook by providing its ID.","responses":{"204":{"description":"Webhook deleted"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"}},"x-analytic-events":["WEBHOOK_DELETE_START","WEBHOOK_DELETE_SUCCESS","WEBHOOK_DELETE_FAIL"]}},"/v1/webhooks/jwks":{"get":{"security":[],"operationId":"getWebhookJwks","tags":["Webhooks"],"summary":"Retrieve Webhook JWKs","description":"Retrieves a list of Webhook JWKs (JSON Web Keys) from the tenant. These keys can be used to verify the HTTP signature and validate the integrity and authorship of generated Webhooks.\n\nThis endpoint is intended for public consumption, and as such does not require authentication.\n","responses":{"200":{"description":"Webhook JWKs retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhooksJwksResponse"}}}}}}},"/oauth/token":{"servers":[{"url":"https://auth.au01.mattr.global"}],"post":{"summary":"Create API Auth Token","operationId":"authToken","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenErrorResponse"},"examples":{"Invalid credentials":{"value":{"error":"access_denied","error_description":"Unauthorized"}}}}}}},"description":"Authorization endpoint for gaining token used for API requests requiring `bearerAuth`.\n\nYou will be provided the required `client_id` and `client_secret` as part of onboarding.\n\n\nThe returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](https://learn.mattr.global/docs/platform-management/access-control) for more information.\n","security":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"},"examples":{"Request":{"value":{"client_id":"htf792W4p4MedZbnoWAs51EfqUt4d2","client_secret":"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G","audience":"https://learn.vii.au01.mattr.global","grant_type":"client_credentials"}}}}}},"tags":["Security"],"x-codeSamples":[{"lang":"curl","source":"curl --request POST \\\n --url https://auth.mattr.global/oauth/token/ \\\n --header 'Content-Type: application/json' \\\n --data '{\"client_id\": \"KWdv9qo9Vnl9rrCRB7sfGKFTp4uO09im\",\n \"client_secret\": \"ztJe2GVpOb1_rUo9Vnl9rrCRB7sfGKFTp4uO0DOfLnA5FSz96wbrzgJMQ\",\n \"audience\": \"https://learn.vii.au01.mattr.global\",\n \"grant_type\": \"client_credentials\"\n }'\n"}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"bearerAuthOpenIdCredentials":{"type":"http","scheme":"bearer","description":"OID4VCI access token presented by a holder's wallet. Use the format: `Authorization: Bearer `.\n\nThe wallet obtains this token from your tenant's [token endpoint](/docs/api-reference/platform/credential-issuance/postOauthToken) during a credential issuance flow. This is not the tenant management token used by operations that require `bearerAuth`.\n"}},"schemas":{"OAuthTokenResponse":{"title":"OAuthTokenResponse","type":"object","properties":{"access_token":{"type":"string","description":"Must be used as a bearer token for all subsequent requests to protected resources on your tenant.","example":"s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9","examples":["s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9"]},"expires_in":{"type":"number","description":"Token expiry time (in seconds).","example":14400,"examples":[14400]},"token_type":{"type":"string","example":"Bearer","examples":["Bearer"]}},"required":["access_token","expires_in","token_type"]},"TokenErrorResponse":{"title":"TokenErrorResponse","type":"object","properties":{"error":{"type":"string"},"error_description":{"type":"string"}}},"OAuthTokenRequest":{"title":"OAuthTokenRequest","type":"object","properties":{"client_id":{"type":"string","description":"Use the `client_id` value provided with your tenant details, or retrieved when you created a tenant on the Self Service Portal.","example":"htf792W4p4MedZbnoWAs51EfqUt4d2","examples":["htf792W4p4MedZbnoWAs51EfqUt4d2"]},"client_secret":{"type":"string","description":"Use the `client_secret` value provided with your tenant details, or retrieved when you created a tenant on the Self Service Portal.","example":"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G","examples":["d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G"]},"audience":{"type":"string","description":"Use your tenant URL.","example":"https://learn.vii.au01.mattr.global","examples":["https://learn.vii.au01.mattr.global"]},"grant_type":{"type":"string","description":"Use `client_credentials`.","example":"client_credentials","examples":["client_credentials"]}},"required":["client_id","client_secret","audience","grant_type"]},"CustomDomainResponse":{"type":"object","properties":{"name":{"type":"string","example":"Example Corp","examples":["Example Corp"]},"logoUrl":{"type":"string","example":"https://cdn.example.com/logo.icon","examples":["https://cdn.example.com/logo.icon"]},"domain":{"type":"string","example":"example.com","examples":["example.com"]},"verificationToken":{"type":"string","description":"This value must be added to your domain DNS entry TXT record. Refer to [Verify domain ownership](https://learn.mattr.global/docs/platform-management/custom-domain-overview#verify-domain-ownership) for more information.","example":"8c6f36c1-91ff-439d-a518-48cf7ef421ef","examples":["8c6f36c1-91ff-439d-a518-48cf7ef421ef"]},"isVerified":{"type":"boolean","description":"This will indicate `false` until the domain has been [verified](https://learn.mattr.global/docs/platform-management/custom-domain-overview#verify-domain-ownership). MATTR VII will only use the custom domain after it has been [verified](https://learn.mattr.global/docs/platform-management/custom-domain-guide#verify-custom-domain) and this field indicates `true`.","example":false,"examples":[false]},"verifiedAt":{"type":"string","description":"Indicates when the custom domain was [verified](https://learn.mattr.global/docs/platform-management/custom-domain-overview#verify-domain-ownership). This field is only included in the response when `isVerified` is `true`."}},"required":["name","logoUrl","domain","verificationToken","isVerified"],"title":"CustomDomainResponse"},"NotFoundError":{"title":"NotFoundError","description":"The specified resource was not found.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","required":["msg","param","location"],"properties":{"value":{"type":"string","description":"The value that was provided"},"msg":{"type":"string","example":"Invalid value","description":"Description of why the request is invalid","examples":["Invalid value"]},"param":{"type":"string","example":"id","description":"The parameter that is invalid","examples":["id"]},"location":{"type":"string","example":"body","description":"The location in either body, query, path or params","examples":["body"]}}}}}},"CreateCustomDomain":{"type":"object","title":"CreateCustomDomain","description":"","properties":{"name":{"type":"string","description":"Insert a name for the custom domain that will be displayed to digital wallet holders when they receive credential offers or verification requests from this tenant."},"logoUrl":{"type":"string","description":"Insert a URL for a square logo that will be displayed to digital wallet holders when they receive credential offers or verification requests from your MATTR VII tenant:\n* URL must be publicly available.\n* Must be a square image, recommended 64x64 px in size\n* **png** and **jpg** files are supported.\n* The recommended maximum size is 15 KB."},"domain":{"type":"string","description":"Insert the full custom domain, leaving out the protocol (e.g. https://)."}},"required":["name","logoUrl","domain"]},"UpdateCustomDomain":{"title":"UpdateCustomDomain","allOf":[{"type":"object","properties":{"id":{"type":"string"}}},{"$ref":"#/components/schemas/CreateCustomDomain"}]},"ValidationError":{"title":"ValidationError","description":"The request was malformed or missing required parameters.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","required":["msg"],"properties":{"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array"}],"description":"The value that was provided"},"msg":{"type":"string","example":"Invalid value","description":"Description of why the request is invalid","examples":["Invalid value"]},"param":{"type":"string","example":"id","description":"The parameter that is invalid","examples":["id"]},"location":{"type":"string","example":"body","description":"The location in either body, query, path or params","examples":["body"]}}}}}},"ErrorResponse":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"The value that was provided"},"msg":{"type":"string","example":"Invalid value","description":"Description of why the request is invalid","examples":["Invalid value"]},"param":{"type":"string","example":"id","description":"The parameter that is invalid","examples":["id"]},"location":{"type":"string","example":"body","description":"The location in either body, query, path or params","examples":["body"]}}}}},"title":"ErrorResponse"},"CredentialStatus":{"type":"object","description":"Credential status location information","properties":{"id":{"type":"string","description":"Unique ID for the credential status","example":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1","examples":["https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1"]},"type":{"type":"string","description":"Indicates that the status contains revocation information","example":"RevocationList2020Status","examples":["RevocationList2020Status"]},"revocationListIndex":{"type":"integer","example":1,"description":"The location within the revocation list for the credential","examples":[1]},"revocationListCredential":{"type":"string","description":"The location of the revocation list","example":"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3","examples":["https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3"]}},"title":"CredentialStatus"},"ED25519Signature2018":{"type":"object","properties":{"type":{"type":"string","example":"Ed25519Signature2018","examples":["Ed25519Signature2018"]},"created":{"type":"string","format":"date-time","example":"2020-05-02T12:06:29Z","examples":["2020-05-02T12:06:29Z"]},"jws":{"type":"string","description":"Compact form of JWS","example":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","examples":["EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"]},"proofPurpose":{"type":"string","example":"assertionMethod","examples":["assertionMethod"]},"verificationMethod":{"type":"string","example":"did:web:organization.com","examples":["did:web:organization.com"]}},"title":"ED25519Signature2018"},"VerifiableCredential":{"type":"object","properties":{"@context":{"type":"array","example":["https://www.w3.org/2018/credentials/v1","https://www.w3.org/2018/credentials/examples/v1"],"items":{"type":"string","minLength":1,"example":"\"https://www.w3.org/2018/credentials/v1\", \"https://www.w3.org/2018/credentials/examples/v1\"","examples":["\"https://www.w3.org/2018/credentials/v1\", \"https://www.w3.org/2018/credentials/examples/v1\""]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:VerifiableCredential:properties:@context:example"]},"type":{"type":"array","example":["VerifiableCredential","AlumniCredential"],"items":{"type":"string","minLength":1,"example":"\"AlumniCredential\", \"VerifiableCredential\"","examples":["\"AlumniCredential\", \"VerifiableCredential\""]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:VerifiableCredential:properties:type:example"]},"issuer":{"description":"Includes Issuer id (DID), domain name and optional branding properties.","oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"did:web:organization.com","examples":["did:web:organization.com"]},"name":{"type":"string","example":"Example University","examples":["Example University"]},"logoUrl":{"type":"string","example":"https://example.edu/img/logo.png","description":"The location of the logo image. The supported formats are jpg, png, and svg.","examples":["https://example.edu/img/logo.png"]},"iconUrl":{"type":"string","example":"https://example.edu/img/icon.png","description":"The location of the icon image. The supported formats are jpg, png, and svg.","examples":["https://example.edu/img/icon.png"]}}},{"type":"string"}]},"credentialBranding":{"type":"object","description":"Includes optional credential branding properties.","properties":{"backgroundColor":{"type":"string","example":"#B00AA0","description":"The background colour used for the credential card. The format is \"#rrggbb\" where \"rrggbb\" is a hex RGB triplet, such as \"#FFCC00\".","examples":["#B00AA0"]},"watermarkImageUrl":{"type":"string","example":"https://example.edu/img/watermark.png","description":"The location of the watermark image. The supported formats are jpg, png, and svg.","examples":["https://example.edu/img/watermark.png"]}}},"issuanceDate":{"type":"string","format":"date-time","example":"2020-05-02T12:06:29.156Z","examples":["2020-05-02T12:06:29.156Z"]},"credentialStatus":{"$ref":"#/components/schemas/CredentialStatus"},"credentialSubject":{"type":"object","example":{"givenName":"Jamie","familyName":"Doe","alumniOf":"Example University"},"properties":{"givenName":{"type":"string","example":"Jamie","examples":["Jamie"]},"familyName":{"type":"string","example":"Doe","examples":["Doe"]},"alumniOf":{"type":"string","example":"Example University","examples":["Example University"]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:VerifiableCredential:properties:credentialSubject:example"]},"proof":{"$ref":"#/components/schemas/ED25519Signature2018"},"name":{"type":"string","example":"Alumni Credential","description":"Name of the credential (requires v2 data model)","examples":["Alumni Credential"]},"description":{"type":"string","example":"This credential shows that the person has attended the mentioned university.","description":"Description of the credential (requires v2 data model)","examples":["This credential shows that the person has attended the mentioned university."]}},"required":["@context","type","issuanceDate","credentialSubject","proof"],"title":"VerifiableCredential"},"GetDidConfigJsonldResponse":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/VerifiableCredential"}}},"title":"GetDidConfigJsonldResponse"},"DidMetadataKey":{"type":"object","properties":{"kmsKeyId":{"type":"string","description":"Unique identifier of this key in the Key Management System (KMS)","example":"ad8facc7-e7f6-4af6-9baa-2f7abd71c928","examples":["ad8facc7-e7f6-4af6-9baa-2f7abd71c928"]},"didDocumentKeyId":{"type":"string","description":"Unique identifier of this key in the DID document.","example":"did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH#z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH","examples":["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH#z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"]}},"title":"DidMetadataKey"},"DidDocument":{"type":"object","title":"did","description":"DID URI."},"DidMetadata":{"type":"object","required":["keys"],"properties":{"registered":{"type":"number","description":"Timestamp of when the DID was registered (Epoch Unix timestamp).","example":1583233799656,"examples":[1583233799656]},"keys":{"type":"array","description":"An array of keys that describe the relationship between keys listed in the DID document and keys that exist in a connected Key Management System (KMS).","items":{"$ref":"#/components/schemas/DidMetadataKey"}},"initialDidDocument":{"type":"object","description":"The DID document that this DID URI should resolve to.","items":{"$ref":"#/components/schemas/DidDocument"}}},"title":"DidMetadata"},"GetDidsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"type":"object","required":["did","localMetadata"],"properties":{"did":{"type":"string","example":"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr","examples":["did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr"]},"localMetadata":{"$ref":"#/components/schemas/DidMetadata"}}}}},"title":"GetDidsResponse"},"CreateDidDocument":{"type":"object","properties":{"method":{"type":"string","description":"Used to determine the type of DID to be created based on its [DID method](https://learn.mattr.global/docs/concepts/dids#methods).","enum":["key","web"]},"options":{"type":"object","description":"To define a key type for a did:key or to define a domain for did:web","minItems":1,"properties":{"keyType":{"type":"string","description":"$198","example":"Bls12381G2","examples":["Bls12381G2"]},"url":{"type":"string","description":"Define the domain that will host the DID document. This would likely be your tenant's URL. Refer to [hosting](https://learn.mattr.global/docs/concepts/dids#hosting) for more information about hosting your `did:web`, and to our [did:web for Custom domains tutorial](https://learn.mattr.global/docs/platform-management/custom-domain-guide#create-a-new-didweb-to-identify-the-custom-domain-optional) if you are planning to self-host your DID document.","example":"learn.vii.au01.mattr.global","examples":["learn.vii.au01.mattr.global"]}}}},"required":["method"],"description":"","title":"CreateDidDocument"},"CreateDidResponse":{"type":"object","properties":{"registrationStatus":{"type":"string","example":"COMPLETED","description":"This status will update from PROCESSING to COMPLETED once publicly resolvable. For `did:web` this means the DID document must be available on the `url` defined when it was created.","examples":["COMPLETED"]},"did":{"type":"string","example":"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr","description":"DID URI.","examples":["did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr"]},"metadata":{"$ref":"#/components/schemas/DidMetadata"}},"title":"CreateDidResponse"},"GetDidResponse":{"type":"object","properties":{"did":{"$ref":"#/components/schemas/DidDocument"},"registrationStatus":{"type":"string","description":"This status will update from `PROCESSING` to `COMPLETED` once publicly resolvable. For `did:web` this means the DID document must be available on the url defined when it was created."},"localMetadata":{"$ref":"#/components/schemas/DidMetadata"}},"title":"GetDidResponse"},"CompactCredentialSignRequest":{"title":"CompactCredentialSignRequest","type":"object","description":"CompactCredentialSignRequest","required":["iss"],"additionalProperties":{"example":"...","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"examples":["..."]},"properties":{"iss":{"type":"string","example":"did:web:organization.com","description":"Use the DID that identifies the credential's issuer, which attests the claims in the credential. This must be a publicly available and resolvable `did:web` for the credential to be valid and verifiable.","examples":["did:web:organization.com"]},"nbf":{"type":"number","example":1645743759,"description":"Not before. When set, credential verification will fail if the current time is earlier than the `nbf` value, expressed as a Unix timestamp.","examples":[1645743759]},"exp":{"type":"number","example":1646743759,"description":"Expiry. When set, credential verification will fail if the current time is later than the `exp` value, expressed as a Unix timestamp.","examples":[1646743759]},"iat":{"type":"number","example":1645743759,"description":"Issued at, indicates credential issuance timestamp, expressed as a Unix timestamp.","examples":[1645743759]},"aud":{"type":"string","description":"Audience."},"sub":{"type":"string","description":"Subject."},"type":{"type":"string"}}},"SignCompactCredentialRequest":{"title":"SignCompactCredentialRequest","type":"object","required":["payload"],"properties":{"payload":{"$ref":"#/components/schemas/CompactCredentialSignRequest"},"revocable":{"type":"boolean","default":false,"description":"When set to `true`, the signed credential can later be revoked. When set to `false`, the credential cannot be revoked."},"isRevoked":{"type":"boolean","default":false,"description":"When set to `true`, the signed credential is issued as revoked, and must be unrevoked to become valid. If `isRevoked` is provided (e.g. set to either `true` or `false`), `revocable` must be set to `true`."}},"description":"Sign CWT credential Request"},"CompactCredentialSignResponse":{"title":"CompactCredentialSignResponse","type":"object","description":"CompactCredentialSignResponse","example":{"iss":"did:web:organization.com","nbf":1645743759,"exp":1646743759,"iat":1645743759,"jti":"6tVMmKodQNaLywW6NGA2aA","type":"CredentialType","property1":"...","property2":"..."},"required":["iss","jti"],"additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"properties":{"iss":{"type":"string"},"jti":{"type":"string"},"nbf":{"type":"number"},"exp":{"type":"number"},"iat":{"type":"number"},"aud":{"type":"string"},"sub":{"type":"string"},"type":{"type":"string"},"status":{"type":"object","properties":{"url":{"type":"string"},"index":{"type":"number"}}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CompactCredentialSignResponse:example"]},"SignCompactCredentialResponse":{"title":"SignCompactCredentialResponse","type":"object","required":["id","encoded","decoded"],"properties":{"id":{"type":"string","description":"Unique credential identifier. This is identical to the `jti` claim, which is the CBOR Web Token (CWT) identifier."},"encoded":{"type":"string","description":"URL Encoded CWT credential payload","example":"CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ","examples":["CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ"]},"decoded":{"$ref":"#/components/schemas/CompactCredentialSignResponse"}},"description":"Sign CWT credential response"},"VerifyCompactCredentialResponse":{"title":"VerifyCompactCredentialResponse","type":"object","description":"VerifyCompactCredentialResponse","properties":{"verified":{"type":"boolean"},"decoded":{"$ref":"#/components/schemas/CompactCredentialSignResponse"},"error":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}},"required":["type","message"]}},"required":["verified","decoded"]},"GenerateQrCodeRequest":{"title":"GenerateQrCodeRequest","type":"object","properties":{"payload":{"type":"string","description":"String representation of the encoded CWT credential.","example":"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...","examples":["CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L..."]},"width":{"type":"number","description":"Optionally specify the desired width of the output QR code. When no width is specified MATTR VII will generate a QR code with an optimised width based on the size of the payload. Maximal value is 1000px.","example":250,"examples":[250]}},"required":["payload"]},"credentialConfigurationClaimMappings":{"type":"object","description":"$199","example":{"firstName":{"mapFrom":"claims.given_name","required":true},"address":{"mapFrom":"claims.address.formatted"},"picture":{"mapFrom":"claims.picture","defaultValue":"http://example.edu/img/placeholder.png"},"badge":{"defaultValue":"http://example.edu/img/badge.png"},"providerSubjectId":{"mapFrom":"authenticationProvider.subjectId"}},"additionalProperties":{"type":"object","properties":{"mapFrom":{"type":"string","description":"The path of the property in the user `claims` object."},"required":{"type":"boolean","description":"Indicates whether value of the property must be resolvable. If set to true and does not map to a value, issuance will fail."},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array"},{"type":"object"}],"description":"Default value to be used when unable to resolve from the supplied context object. Required when `mapFrom` is not defined."}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:credentialConfigurationClaimMappings:example"]},"CredentialConfiguration":{"type":"object","properties":{"type":{"description":"Used to differentiate between different CWT/Semantic CWT credential configurations on your tenant. Thus, its value must:\n- Be unique across all CWT/Semantic CWT credential configurations on your tenant.\n- Not be VerifiableCredential.","type":"string","minLength":1,"maxLength":1024,"example":"CourseCredential","examples":["CourseCredential"]},"claimMappings":{"$ref":"#/components/schemas/credentialConfigurationClaimMappings"},"revocable":{"type":"boolean","default":true,"description":"When set to true (default), the created credential can later be revoked. When set to false, the credential cannot be revoked."},"claimSourceId":{"type":"string","format":"uuid","description":"References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential."},"expiresIn":{"type":"object","description":"Used to determine when will issued credentials expire. Can include any combination of `years`, `months`, `weeks`, `days`, `hours`, `minutes` and `seconds`.","properties":{"years":{"type":"number","example":1,"examples":[1]},"months":{"type":"number","example":12,"examples":[12]},"weeks":{"type":"number","example":52,"examples":[52]},"days":{"type":"number","example":365,"examples":[365]},"hours":{"type":"number","example":24,"examples":[24]},"minutes":{"type":"number","example":1440,"examples":[1440]},"seconds":{"type":"number","example":3600,"examples":[3600]}}}},"required":["claimMappings"]},"CredentialConfigurationResponse":{"required":["id","type","revocable"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Uniquely identifies this credential configuration. Can be used to create an offer based on this credential configuration, or to retrieve, update or remove the credential configuration.","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]}}},{"$ref":"#/components/schemas/CredentialConfiguration"}],"title":"CredentialConfigurationResponse"},"GetCredentialConfigurationsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CredentialConfigurationResponse"}}},"title":"GetCredentialConfigurationsResponse"},"CredentialConfigurationRequest":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CredentialConfiguration"}],"title":"CreateCredentialConfigurationRequest"},"CompactSemanticCredentialSignRequest":{"title":"CompactSemanticCredentialSignRequest","type":"object","description":"CompactSemanticCredentialSignRequest","required":["iss","vc"],"properties":{"iss":{"type":"string","example":"did:web:organization.com","description":"Use the DID that identifies the credential's issuer, which attests the claims in the credential. This must be a publicly available and resolvable `did:web` for the credential to be valid and verifiable.","examples":["did:web:organization.com"]},"nbf":{"type":"number","example":1645743759,"description":"Not before. Credential verification will fail if the current time is earlier than the `nbf` value, expressed as a Unix timestamp. `nbf` is required by the W3C VC data model. If not provided in the request, current time at issuance is used.","examples":[1645743759]},"exp":{"type":"number","example":1645743759,"description":"Expiry. When set, credential verification will fail if the current time is later than the `exp` value, expressed as a Unix timestamp.","examples":[1645743759]},"iat":{"type":"number","example":1645743759,"description":"Issued at, indicates credential issuance timestamp, expressed as a Unix timestamp.","examples":[1645743759]},"aud":{"type":"string","example":"...","description":"Audience.","examples":["..."]},"sub":{"type":"string","example":"...","description":"Subject identifier. As Semantic CWT credentials are _bearer credentials_, including a subject identifier is not required.","examples":["..."]},"vc":{"type":"object","description":"Represents a W3C Verifiable Credential data model credential.","required":["credentialSubject","type"],"properties":{"@context":{"type":"string","example":"https://www.w3.org/2018/credentials/examples/v1","description":"Must be a publicly available and resolvable schema.","examples":["https://www.w3.org/2018/credentials/examples/v1"]},"type":{"type":"string","example":"AlumniCredential","description":"Must be a single credential type.","examples":["AlumniCredential"]},"credentialSubject":{"type":"object","description":"Contains all the claims attested in the credential. Must comply with the referenced context schema.","additionalProperties":{"example":"...","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"examples":["..."]}}}}}},"SignCompactSemanticCredentialRequest":{"title":"SignCompactSemanticCredentialRequest","type":"object","required":["payload"],"properties":{"payload":{"$ref":"#/components/schemas/CompactSemanticCredentialSignRequest"},"revocable":{"type":"boolean","default":false,"description":"When set to `true`, the created credential can later be revoked. When set to `false`, the credential cannot be revoked."},"isRevoked":{"type":"boolean","default":false,"description":"When set to `true`, the signed credential is issued as revoked, and must be unrevoked to become valid. If `isRevoked` is provided (e.g. set to either `true` or `false`), `revocable` must be set to `true`."}},"description":"Sign Semantic CWT credential Request"},"CompactSemanticCredentialSignResponse":{"title":"CompactSemanticCredentialSignResponse","type":"object","description":"CompactSemanticCredentialSignResponse","required":["iss","nbf","jti","vc"],"properties":{"iss":{"type":"string","example":"did:web:example.com","description":"This DID identifies the credential's issuer, which attests the claims in the credential. Must be a publicly available and resolvable `did:web` for the credential to be valid and verifiable.","examples":["did:web:example.com"]},"jti":{"type":"string","example":"...","description":"This JWT ID identifies this credential and is identical to the `id` element. When `revocable` is set to `true`, this value is persisted on the tenant to enable revoking this specific credential.","examples":["..."]},"nbf":{"type":"number","example":1645743759,"description":"Not before. Credential verification will fail if the current time is earlier than the `nbf` value, expressed as a Unix timestamp.","examples":[1645743759]},"exp":{"type":"number","example":1645743759,"description":"Expiry. When set, credential verification will fail if the current time is later than the `exp` value, expressed as a Unix timestamp.","examples":[1645743759]},"iat":{"type":"number","example":1645743759,"description":"Issued at, indicates credential issuance timestamp, expressed as a Unix timestamp.","examples":[1645743759]},"aud":{"type":"string","example":"...","description":"Audience.","examples":["..."]},"sub":{"type":"string","example":"...","description":"Subject identifier. As Semantic CWT credentials are _bearer credentials_, including a subject identifier is not required.","examples":["..."]},"vc":{"type":"object","description":"Represents a W3C Verifiable Credential data model credential.","required":["@context","type","credentialSubject"],"properties":{"@context":{"type":"array","description":"Must be a publicly available and resolvable schema.","items":{"type":"string"},"example":["https://www.w3.org/2018/credentials/v1","https://www.w3.org/2018/credentials/examples/v1"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CompactSemanticCredentialSignResponse:properties:vc:properties:@context:example"]},"type":{"type":"array","description":"Must be a single credential type.","items":{"type":"string"},"example":["VerifiableCredential","AlumniCredential"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CompactSemanticCredentialSignResponse:properties:vc:properties:type:example"]},"credentialSubject":{"type":"object","description":"Contains all the claims attested in the credential. Must comply with the referenced context schema.","additionalProperties":{"example":"...","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"examples":["..."]}}}},"status":{"type":"object","description":"If `revocable` was set to `true` in the request, this object is used to provide information required for revocation.","properties":{"url":{"type":"string","example":"...","description":"Every revocable credential will reference a Revocation List that is automatically created and held on the issuer's tenant. This list can be used by external verifiers to validate the credential status. This property references the Revocation List which holds the revocation status for this specific credential.","examples":["..."]},"index":{"type":"number","example":123,"description":"This indicates the index of this specific credential within the revocation list.","examples":[123]}}}}},"SignCompactSemanticCredentialResponse":{"title":"SignCompactSemanticCredentialResponse","type":"object","required":["id","encoded","decoded"],"properties":{"id":{"type":"string","description":"Unique credential identifier. This is identical to the `jti` claim, which is the CBOR Web Token (CWT) identifier."},"encoded":{"type":"string","description":"The base32 encoded string representation of the Semantic CWT credential. CSC stands for COSE_SIGN Compact format. You will use this element to convert the credential into a format that can be shared with a holder.","example":"CSS:/1/BASE_32_ENCODED_PAYLOAD","examples":["CSS:/1/BASE_32_ENCODED_PAYLOAD"]},"decoded":{"$ref":"#/components/schemas/CompactSemanticCredentialSignResponse"}},"description":"Sign Semantic CWT credential response"},"VerifyCompactSemanticCredentialResponse":{"title":"VerifyCompactSemanticCredentialResponse","type":"object","description":"VerifyCompactSemanticCredentialResponse","required":["verified"],"properties":{"verified":{"type":"boolean"},"decoded":{"$ref":"#/components/schemas/CompactSemanticCredentialSignResponse"},"error":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}},"required":["type","message"]}}},"CompactSemanticCredentialConfiguration":{"type":"object","properties":{"type":{"description":"Used to differentiate between different CWT/Semantic CWT credentials configurations on your tenant. Thus, its value must:\n- Be unique across all CWT/Semantic CWT credentials configurations on your tenant.\n- Not be VerifiableCredential.","minLength":1,"maxLength":1024,"example":"CourseCredential","examples":["CourseCredential"]},"claimMappings":{"$ref":"#/components/schemas/credentialConfigurationClaimMappings"},"revocable":{"type":"boolean","default":true,"description":"When set to `true` (default), the created credential can later be revoked. When set to `false`, the credential cannot be revoked."},"claimSourceId":{"type":"string","format":"uuid","description":"References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential."},"expiresIn":{"type":"object","description":"Used to determine when will issued credentials expire. Can include any combination of `years`, `months`, `weeks`, `days`, `hours`, `minutes` and `seconds`.","properties":{"years":{"type":"number","example":1,"examples":[1]},"months":{"type":"number","example":12,"examples":[12]},"weeks":{"type":"number","example":52,"examples":[52]},"days":{"type":"number","example":365,"examples":[365]},"hours":{"type":"number","example":24,"examples":[24]},"minutes":{"type":"number","example":1440,"examples":[1440]},"seconds":{"type":"number","example":3600,"examples":[3600]}}}},"required":["claimMappings"]},"CompactSemanticCredentialConfigurationResponse":{"required":["id","type","revocable"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Uniquely identifies this credential configuration. Can be used to create an offer based on this credential configuration, or to retrieve, update or remove the credential configuration.","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]}}},{"$ref":"#/components/schemas/CompactSemanticCredentialConfiguration"}],"title":"CompactSemanticCredentialConfigurationResponse"},"GetCompactSemanticCredentialConfigurationsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompactSemanticCredentialConfigurationResponse"}}},"title":"GetCompactSemanticCredentialConfigurationsResponse"},"CompactSemanticCredentialConfigurationRequest":{"required":["type"],"allOf":[{"$ref":"#/components/schemas/CompactSemanticCredentialConfiguration"}],"title":"CreateCompactSemanticCredentialConfigurationRequest"},"PDFTemplateResponse":{"type":"object","x-examples":{},"title":"PDFTemplateResponse","properties":{"id":{"type":"string","description":"This is a unique identifier for this PDF template. You will use it as the `templateId` when formatting a CWT credential as a PDF.","example":"4eea7654-d4c5-4eba-bd7a-5ca334d54725","examples":["4eea7654-d4c5-4eba-bd7a-5ca334d54725"]},"name":{"type":"string","example":"Certificate of participation","description":"Template name.","examples":["Certificate of participation"]},"fileName":{"type":"string","example":"certificate_of_participation","description":"File name for credentials formatted using this template.","examples":["certificate_of_participation"]},"fonts":{"type":"array","description":"Includes any custom fonts in this template.","example":[{"name":"PublicSans-Regular","fileName":"fonts/PublicSans-Regular.ttf"}],"items":{"type":"object","properties":{"name":{"type":"string"},"fileName":{"type":"string"}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:PDFTemplateResponse:properties:fonts:example"]},"metadata":{"type":"object","properties":{"title":{"type":"string","example":"","examples":[""]}}},"fields":{"type":"array","description":"Includes the different elements in this PDF template and what fields in the credential they are mapped from.","example":[{"key":"familyName","value":"{{payload.sub_claims.familyName}}","isRequired":true,"alternativeText":"{{payload.sub_claims.familyName}}","fontName":"PublicSans-Regular"}],"items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"isRequired":{"type":"boolean"},"alternativeText":{"type":"string"},"fontName":{"type":"string"}},"required":["key","value","alternativeText"]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:PDFTemplateResponse:properties:fields:example"]}}},"PDFTemplatesResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"0ecdcb57-ef2b-4aa1-be34-695c2d9d9486","examples":["0ecdcb57-ef2b-4aa1-be34-695c2d9d9486"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PDFTemplateResponse"}}},"title":"PDFTemplateResponse","description":""},"CreatePDFRequest":{"type":"object","properties":{"templateId":{"type":"string","description":"Use the `ID` element of the PDF template to be used to format this credential.","example":"4eea7654-d4c5-4eba-bd7a-5ca334d54725","minLength":1,"examples":["4eea7654-d4c5-4eba-bd7a-5ca334d54725"]},"payload":{"type":"string","description":"String payload representation of the encoded CWT credential.","example":"{payload}","minLength":1,"maxLength":1024,"examples":["{payload}"]}},"title":"CreatePDFResponse"},"DigitalPassType":{"description":"Digital pass type","type":"string","enum":["apple","google"],"title":"DigitalPassType"},"ApplePassTemplateResponse":{"type":"object","properties":{"id":{"type":"string","example":"3812166c-ac9f-4e4e-96dd-c1336b5be378","description":"This is a unique identifier for this Apple digital pass template. You will use it as the `templateId` when formatting a CWT credential as an Apple Pass.","examples":["3812166c-ac9f-4e4e-96dd-c1336b5be378"]},"passType":{"$ref":"#/components/schemas/DigitalPassType"},"name":{"type":"string","example":"Certificate of participation","examples":["Certificate of participation"]},"metadata":{"type":"object","properties":{"fileName":{"type":"string","example":"certificate_of_participation.pkpass","examples":["certificate_of_participation.pkpass"]},"teamIdentifier":{"type":"string","example":"GH5P43ABC","examples":["GH5P43ABC"]},"passTypeIdentifier":{"type":"string","example":"pass.myproject.participation.pk","examples":["pass.myproject.participation.pk"]}}}},"title":"ApplePassTemplateResponse"},"ApplePassTemplatesResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplePassTemplateResponse"}}},"title":"ApplePassTemplatesResponse"},"ApplePassTemplateRequest":{"type":"object","properties":{"template":{"type":"string","format":"binary","description":"Includes your template files."},"name":{"type":"string","description":"Insert a name to identify this Apple digital pass template.","example":"Certificate of participation","minLength":1,"maxLength":1024,"examples":["Certificate of participation"]},"fileName":{"type":"string","description":"Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.","example":"certificate_of_participation.pkpass","minLength":1,"maxLength":100,"examples":["certificate_of_participation.pkpass"]},"teamIdentifier":{"type":"string","description":"The Team ID for the Apple Developer Program account that registered the pass type identifier.","example":"GH5P43ABC","examples":["GH5P43ABC"]},"passTypeIdentifier":{"type":"string","description":"The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.","example":"pass.myproject.participation.pk","examples":["pass.myproject.participation.pk"]},"wwdr":{"type":"string","description":"Apple G1 or G4 worldwide developer relations intermediate certificate."},"signerCert":{"type":"string","description":"Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7)."},"signerKey":{"type":"string","description":"The encrypted key of the Apple pass signer certificate."},"signerKeyPassphrase":{"type":"string","description":"Passphrase for the encrypted key."}},"required":["name","template","fileName","teamIdentifier","passTypeIdentifier","wwdr","signerCert","signerKey","signerKeyPassphrase"],"title":"ApplePassTemplateRequest"},"GooglePassTemplateResponse":{"type":"object","properties":{"id":{"type":"string","example":"3812166c-ac9f-4e4e-96dd-c1336b5be378","description":"This is a unique identifier for this Google Pass template. You will use it as the `templateId` when formatting a CWT credential as a Google Pass.","examples":["3812166c-ac9f-4e4e-96dd-c1336b5be378"]},"passType":{"$ref":"#/components/schemas/DigitalPassType"},"name":{"type":"string","example":"Certificate of participation","examples":["Certificate of participation"]},"metadata":{"type":"object","properties":{"issuerId":{"type":"string","example":"3388000000012346000","examples":["3388000000012346000"]},"serviceAccountClientEmail":{"type":"string","example":"app-user@myproject.iam.gserviceaccount.com","examples":["app-user@myproject.iam.gserviceaccount.com"]},"payPassId":{"type":"string","example":"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463","examples":["3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"]}}}},"title":"GooglePassTemplateResponse"},"GooglePassTemplatesResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/GooglePassTemplateResponse"}}},"title":"GooglePassTemplatesResponse","description":""},"GooglePassTemplateRequest":{"type":"object","properties":{"template":{"type":"string","format":"binary","description":"Includes your template files."},"name":{"type":"string","description":"Insert a name to identify this Google Pass template.","example":"Certificate of participation","minLength":1,"maxLength":1024,"examples":["Certificate of participation"]},"issuerId":{"type":"string","description":"Google Wallet Pass signer issuer ID.","example":"3388000000012346000","examples":["3388000000012346000"]},"serviceAccountClientEmail":{"type":"string","description":"Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.","example":"app-user@myproject.iam.gserviceaccount.com","examples":["app-user@myproject.iam.gserviceaccount.com"]},"serviceAccountPrivateKey":{"type":"string","description":"Private key PEM of the Google Cloud Platform service account."}},"required":["name","template","issuerId","serviceAccountClientEmail","serviceAccountPrivateKey"],"title":"GooglePassTemplateRequest"},"CreateDigitalPassRequest":{"format":"object","properties":{"templateId":{"type":"string","description":"Use the `id` of the template to be used to format this credential.","example":"3812166c-ac9f-4e4e-96dd-c1336b5be378","minLength":1,"examples":["3812166c-ac9f-4e4e-96dd-c1336b5be378"]},"payload":{"type":"string","description":"String payload representation of the encoded CWT credential.","example":"{payload}","examples":["{payload}"]}},"title":"CreateDigitalPassRequest","description":""},"CreateApplePassResponse":{"type":"string","description":"The generated Apple Pass `.pkpass` file.","title":"CreateApplePassResponse","format":"binary"},"CreateGooglePassResponse":{"description":"The URL to retrieve the Google Pass from.","format":"object","properties":{"redirectTo":{"type":"string","description":"Redirect URL to download the Google Pass to the Google Wallet.","example":"https://pay.google.com/gp/v/save/{jwt}","examples":["https://pay.google.com/gp/v/save/{jwt}"]}},"title":"CreateGooglePassResponse"},"IacaCertificateData":{"title":"IacaCertificateData","type":"object","required":["notAfter","notBefore","country","commonName"],"properties":{"notAfter":{"type":"string","format":"date-time","example":"2034-09-26T00:00:00.000Z","description":"IACA's expiry date (defaults to 10 years from issuance if not provided in the request).","examples":["2034-09-26T00:00:00.000Z"]},"notBefore":{"type":"string","format":"date-time","example":"2023-09-26T00:00:00.000Z","description":"IACA’s active from date.","examples":["2023-09-26T00:00:00.000Z"]},"country":{"type":"string","example":"US","description":"ISO 3166-1 alpha-2 Country code, based on the IACA creation request.","examples":["US"]},"commonName":{"type":"string","default":"{tenantDomain} IACA","description":"IACA's name, based on the IACA creation request.","example":"{tenant-subdomain}.vii.mattr.global IACA","examples":["{tenant-subdomain}.vii.mattr.global IACA"]},"stateOrProvinceName":{"type":"string","description":"State or province code as per [ISO 3166-2](https://www.iso.org/standard/72483.html), based on the request body.","example":"US-AL","examples":["US-AL"]}}},"IacaResponse":{"title":"IacaResponse","type":"object","required":["id","active","certificatePem","certificateData","certificateFingerprint"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the created IACA."},"active":{"type":"boolean","example":true,"description":"Indicates whether the IACA is active or not. Only active IACAs can be used to sign mDocs.","examples":[true]},"certificatePem":{"type":"string","example":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","description":"Certificate PEM format.","examples":["-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n"]},"certificateData":{"$ref":"#/components/schemas/IacaCertificateData"},"certificateFingerprint":{"type":"string","example":"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311","description":"Hash that includes all certificate data and its signature.","examples":["3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311"]},"isManaged":{"type":"boolean","example":true,"description":"Indicates whether the private key for this certificate is managed by MATTR (`true`) or out of band by the customer as an external IACA (`false`).","examples":[true]}}},"CreateManagedIacaRequest":{"title":"Managed IACA","type":"object","properties":{"commonName":{"type":"string","default":"{tenantDomain} IACA","description":"This optional parameter indicates the common name of the IACA certificate. When specified, the value must be a valid `PrintableString` and cannot be an empty string. If not provided and a custom domain is configured and verified, the custom domain is used followed by the word `IACA`. If no custom domain is configured, the tenant subdomain is used instead.","example":"{tenant-subdomain}.vii.mattr.global IACA","examples":["{tenant-subdomain}.vii.mattr.global IACA"]},"country":{"type":"string","example":"US","description":"This optional parameter indicates the issuer country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid [Alpha 2 country code](https://www.iso.org/glossary-for-iso-3166.html) as per [ISO 3166-1](https://www.iso.org/standard/72482.html).","examples":["US"]},"notBefore":{"type":"string","example":"2024-09-26","description":"This _optional_ parameter is used to set the date and time when the IACA becomes valid and can be used to sign mDocs. This can be used alongside the `active` field to support [IACA rotation](/docs/concepts/chain-of-trust#certificates-rotation) by creating inactive IACAs and distributing them to relying parties in advance. * Must not be in the past. * Must be before `notAfter`.","examples":["2024-09-26"]},"notAfter":{"type":"string","example":"2034-09-26","description":"This _optional_ parameter is used to set the date and time when the IACA expires. - If not provided, calculated as `notBefore` + 10 years. - If not provided and `notBefore` is not provided, calculated as time of creation + 10 years. - Maximum value is 20 years from creation. - Must be after `notBefore`, if provided.","examples":["2034-09-26"]},"stateOrProvinceName":{"type":"string","description":"This optional parameter indicates the issuer state or province. When specified, the value must be uppercase and a valid state/province code as per [ISO 3166-2](https://www.iso.org/standard/72483.html).","example":"US-AL","examples":["US-AL"]}}},"CreateUnmanagedIacaRequest":{"title":"Unmanaged (external) IACA","type":"object","properties":{"certificatePem":{"type":"string","description":"IACA certificate in PEM format. The certificate must be valid and not expired.","example":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n"]}}},"CreateIacaRequest":{"oneOf":[{"$ref":"#/components/schemas/CreateManagedIacaRequest"},{"$ref":"#/components/schemas/CreateUnmanagedIacaRequest"}],"title":"CreateIacaRequest"},"UpdateIacaRequest":{"title":"UpdateIacaRequest","type":"object","required":["active"],"properties":{"active":{"type":"boolean","example":true,"description":"Indicates whether the IACA is active or not. Only active IACAs can be used to sign mDocs.","examples":[true]}}},"DocumentSignerCsrResponse":{"title":"Document Signer without certificate","type":"object","description":"Document signer before a certificate has been uploaded. Includes a Certificate Signing Request (CSR).","required":["id","iacaId","active","csrPem"],"properties":{"id":{"type":"string","format":"uuid","description":"Each Document Signer created on MATTR VII will have a unique identifier which must be provided when using this Document Signer to sign an mDoc."},"iacaId":{"type":"string","format":"uuid","description":"Unique identifier of the IACA used to sign the Document Signer."},"active":{"type":"boolean","description":"Indicates the Document Signer status. Only active Document Signers (`true`) can be used to sign mDocs."},"csrPem":{"type":"string","description":"The X.509 Certificate Signing Request (CSR) in PEM format, base64 encoded. Use this CSR to generate a valid certificate, then update the document signer with the resulting certificate.","example":"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"]}}},"DocumentSignerCertificateData":{"title":"DocumentSignerCertificateData","type":"object","required":["notAfter","notBefore","country","commonName"],"properties":{"notAfter":{"type":"string","format":"date-time","example":"2034-09-26T00:00:00.000Z","description":"Timestamp after which this certificate can no longer be used.","examples":["2034-09-26T00:00:00.000Z"]},"notBefore":{"type":"string","format":"date-time","example":"2023-09-30T00:00:00.000Z","description":"Timestamp from which this certificate becomes active.","examples":["2023-09-30T00:00:00.000Z"]},"country":{"type":"string","example":"US","description":"ISO 3166-1 alpha-2 Country code.","examples":["US"]},"stateOrProvinceName":{"type":"string","example":"US-AL","description":"State or province code as per [ISO 3166-2](https://www.iso.org/standard/72483.html).","examples":["US-AL"]},"commonName":{"type":"string","default":"{tenantDomain} Document Signer","example":"{tenant-subdomain}.vii.mattr.global Document Signer","description":"Certificate's common name.","examples":["{tenant-subdomain}.vii.mattr.global Document Signer"]}}},"DocumentSignerCertificateResponse":{"title":"Document Signer with certificate","type":"object","description":"Document signer after a certificate has been uploaded. Includes the uploaded certificate in PEM format, as well as the certificate's fingerprint and data.","required":["id","iacaId","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Each Document Signer created on MATTR VII will have a unique identifier which must be provided when using this Document Signer to sign an mDoc."},"iacaId":{"type":"string","format":"uuid","description":"Unique identifier of the IACA used to sign the Document Signer."},"active":{"type":"boolean","description":"Indicates the Document Signer status. Only active Document Signers (`true`) can be used to sign mDocs."},"certificatePem":{"type":"string","description":"Document Signer Certificate (DSC) in PEM format.","example":"-----BEGIN CERTIFICATE-----\\r\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\r\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\r\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\r\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\r\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\r\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\r\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\r\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\r\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\r\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\r\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\r\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\r\\nIavC\\r\\n-----END CERTIFICATE-----\\r\\n","examples":["-----BEGIN CERTIFICATE-----\\r\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\r\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\r\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\r\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\r\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\r\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\r\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\r\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\r\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\r\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\r\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\r\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\r\\nIavC\\r\\n-----END CERTIFICATE-----\\r\\n"]},"certificateFingerprint":{"type":"string","description":"Document Signer Certificate (DSC) Hash that includes all certificate data and its signature.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"$ref":"#/components/schemas/DocumentSignerCertificateData"}}},"ListDocumentSignersResponse":{"title":"ListDocumentSignersResponse","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentSignerCsrResponse"},{"$ref":"#/components/schemas/DocumentSignerCertificateResponse"}]}},"nextCursor":{"type":"string"}}},"CreateDocumentSignerRequest":{"title":"CreateDocumentSignerRequest","type":"object","required":["iacaId"],"properties":{"iacaId":{"type":"string","format":"uuid","description":"Internal identifier of the IACA used to sign this document signer:\n- Must be an unmanaged (external) IACA.\n"}}},"DocumentSignerResponse":{"oneOf":[{"$ref":"#/components/schemas/DocumentSignerCsrResponse"},{"$ref":"#/components/schemas/DocumentSignerCertificateResponse"}],"title":"DocumentSignerResponse"},"UpdateDocumentSignerRequest":{"title":"UpdateDocumentSignerRequest","type":"object","required":["active"],"properties":{"active":{"description":"This required parameter defines the status of the created Document Signer. Only active Document Signers can be used to sign mDocs.","type":"boolean"},"certificatePem":{"description":"Document Signer Certificate (DSC) in PEM format. The certificate must be:\n- Valid\n- Not expired\n- Compliant with the details provided in the Certificate Signing Request returned when the Document Signer was created\nRefer to [Certificate requirements](https://learn.mattr.global/docs/issuance/certificates/overview#certificate-requirements) in the external certificates documentation for a full list of requirements detailed in the CSR.\n","type":"string","example":"-----BEGIN CERTIFICATE-----\\r\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\r\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\r\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\r\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\r\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\r\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\r\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\r\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\r\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\r\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\r\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\r\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\r\\nIavC\\r\\n-----END CERTIFICATE-----\\r\\n","examples":["-----BEGIN CERTIFICATE-----\\r\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\r\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\r\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\r\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\r\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\r\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\r\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\r\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\r\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\r\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\r\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\r\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\r\\nIavC\\r\\n-----END CERTIFICATE-----\\r\\n"]}}},"DocumentSignerRevokeRequest":{"type":"object","description":"Empty request body for document signer revocation"},"DocumentSignerRevokeResponse":{"type":"object","properties":{"revoked":{"type":"boolean","description":"Indicates whether this document signer has been revoked","example":true,"examples":[true]},"revocationDate":{"type":"string","description":"ISO 8601 timestamp indicating when the Document Signer was revoked","example":"2025-10-31T23:59:59Z","examples":["2025-10-31T23:59:59Z"]}},"required":["revoked","revocationDate"]},"StatusListSignerCreateResponse":{"type":"object","required":["id","active","iacaId","csrPem"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this status list."},"iacaId":{"type":"string","format":"uuid","description":"Identifies the IACA used to sign this status list signer."},"active":{"type":"boolean","description":"Indicates whether or not this signer can currently be used to sign status lists. Status list signers can only be set to active after a valid certificate is provided.","example":false,"examples":[false]},"csrPem":{"type":"string","description":"The X.509 Certificate Signing Request (CSR) in PEM format, base64 encoded. Use this CSR to generate a valid certificate, then update the status list signer with the resulting certificate.","example":"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----"]}}},"StatusListSignerUpdateResponse":{"type":"object","required":["id","iacaId","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this status list."},"iacaId":{"type":"string","format":"uuid","description":"Identifies the IACA used to sign this status list signer."},"active":{"type":"boolean","description":"Indicates whether or not this signer can currently be used to sign status lists.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"Status list signer certificate in PEM format. This will match the PEM referenced in the status list token."},"certificateFingerprint":{"type":"string","example":"475DA948E4BA44D9B5BC31AB4B8006113FD5F538","examples":["475DA948E4BA44D9B5BC31AB4B8006113FD5F538"]},"certificateData":{"type":"object","description":"Metadata about the status list signer certificate.","properties":{"notBefore":{"type":"string","description":"Timestamp from which this certificate becomes active.","format":"date-time"},"notAfter":{"type":"string","description":"Timestamp indicating when this certificate expires.","format":"date-time"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 Country code."},"stateOrProvinceName":{"type":"string","description":"State or province code as per [ISO 3166-2](https://www.iso.org/standard/72483.html)."},"organisationName":{"type":"string","description":"Optional organization identifier."}},"required":["notBefore","notAfter","country","commonName"]}}},"StatusListSignerResponse":{"oneOf":[{"$ref":"#/components/schemas/StatusListSignerCreateResponse"},{"$ref":"#/components/schemas/StatusListSignerUpdateResponse"}]},"StatusListSignersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StatusListSignerResponse"}}}},"StatusListSignerCreateRequest":{"type":"object","properties":{"iacaId":{"type":"string","format":"uuid","description":"Internal identifier of the IACA used to sign this status list signer:\n- Must be the same IACA used to sign credentials that are included in a status list signed by this status list signer.\n- Must be an unmanaged (external) IACA.\n"}},"required":["iacaId"]},"StatusListSignerUpdateRequest":{"type":"object","properties":{"active":{"type":"boolean","description":"Status list signer status. Must be set to `true` for this status list signer to be available for signing status lists."},"certificatePem":{"type":"string","description":"Status list signer certificate in PEM format. The certificate must be:\n- Valid\n- Not expired\n- Compliant with the details provided in the Certificate Signing Request returned when the status list signer was created\n"}}},"StatusListSignerRevokeRequest":{"type":"object","description":"Empty request body for status list signer revocation"},"StatusListSignerRevokeResponse":{"type":"object","properties":{"revoked":{"type":"boolean","description":"Indicates whether this status list signer has been revoked","example":true,"examples":[true]},"revocationDate":{"type":"string","description":"Timestamp in ISO 8601 format (UTC) indicating when this status list signer was revoked","example":"2025-10-31T23:59:59Z","examples":["2025-10-31T23:59:59Z"]}},"required":["revoked","revocationDate"]},"ClaimMapFrom":{"type":"string","description":"Path to the mapped claim in the configured claims source:\n- When using a URL as a claims namespace identifier, use bracket notation to access the claim value (e.g. mapFrom: \"claims['https://example.com/claim-name']\").\n- `mapForm` is optional when `defaultValue` is provided, as the latter will be used for all issued credentials. This is referred to as a **static claim**.","example":"claims.given_name","examples":["claims.given_name"]},"ClaimRequired":{"type":"boolean","description":"Indicates whether the claim is required (`true`) or not (`false`). When a required claim is not available, credential issuance will fail.","default":false},"ClaimDefaultValue":{"description":"Indicates what value is used if `required` is set to `false` (field is optional) and no value is provided by the claims source. When `defaultValue` is provided, `mapFrom` and `type` are optional.","type":"string"},"ClaimDisplayEntry":{"title":"ClaimDisplayEntry","type":"object","description":"A single localized display label for a claim, as defined in [OID4VCI §B.2](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-claims-description-for-issu).","properties":{"name":{"type":"string","description":"Human-readable label for the claim in the specified locale.","example":"Given Name","examples":["Given Name"]},"locale":{"type":"string","description":"BCP47 language tag identifying the language for this display entry (e.g. `en-US`, `fr-CA`). Must be unique within the `display` array for a given claim.","example":"en-US","examples":["en-US"]}}},"ClaimDisplayEntries":{"title":"ClaimDisplayEntries","type":"array","description":"Optional list of localized display labels for the claim, as defined in [OID4VCI §B.2](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-claims-description-for-issu).\n- Each entry pairs an optional `name` (display label) with an optional `locale` ([BCP47](https://www.rfc-editor.org/rfc/rfc5646.html) language tag).\n- Duplicate `locale` values within the same claim's `display` array are not permitted.\n- When configured, these entries are forwarded into the issuer metadata at `/.well-known/openid-credential-issuer`.","minItems":1,"items":{"$ref":"#/components/schemas/ClaimDisplayEntry"},"example":[{"name":"Given Name","locale":"en-US"},{"name":"Vorname","locale":"de-DE"}],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ClaimDisplayEntries:example"]},"ClaimMappings":{"title":"ClaimMappings","type":"object","description":"This is where you specify how to map claims (user attributes) into issued credentials.","example":{"org.iso.18013.5.1":{"given_name":{"mapFrom":"claims.given_name","required":true,"type":"string","display":[{"name":"Given Name","locale":"en-US"},{"name":"Vorname","locale":"de-DE"}]},"birth_date":{"mapFrom":"claims.date_of_birth","required":true,"type":"dateTime"}}},"properties":{"additionalProperties":{"title":"namespace","description":"Each object corresponds to a claims source and is referenced as a `namespace`.","type":"object","properties":{"additionalProperties":{"title":"claim","description":"Each object corresponds to a claim in the issued credential, and contains fields that control the mapping logic.","oneOf":[{"type":"object","title":"Boolean","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (boolean).\n* Mapped value must be a boolean.\n* Mapped to `bool` CBOR data type in the signed credential.\n* Optional when `defaultValue` is provided.","enum":["boolean"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Number","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (number). \n* Mapped value must be a number.\n* Mapped to `uint` CBOR data type in the signed credential.\n* Optional when `defaultValue` is provided.","enum":["number"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"String","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (string). \n* Mapped value must be a string.\n* Mapped to `tstr` CBOR data type in the signed credential.\n* Optional when `defaultValue` is provided.","enum":["string"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Binary","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (binary).\n* Mapped value must be a string in `base64` string format. \n* Mapped to `bstr` CBOR data type in the signed credential.\n* This type must be used for any images signed as part of the credential.\n* Maximum supported image size is 500KB.\n* Recommended image size is below 50KB for optimal performance.","enum":["binary"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Date","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (date). \n* Mapped value must be a string in `YYYY-MM-DD` format. \n* Mapped to the `1004` CBOR tag as a `full-date` CBOR data type in the signed credential.","enum":["date"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Date/Time","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (date/time).\n* Mapped value must be a string in YYYY-MM-DD HH:MM:SS format ([ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) compliant). \n* Mapped to the `0` CBOR tag as a `tdate` CBOR data type in the signed credential.","enum":["dateTime"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Array","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (array). \n* Mapped value must be an array. \n* Array elements are mapped to the following CBOR data types in the signed credential:\n * number => `uint`\n * string => `tstr`\n * array => CBOR array []\n * map => CBOR map {}","enum":["array"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"Object","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (object). \n* Mapped value must be an object. \n* Passed object must be a valid JSON structure.\n* Object items are mapped to the following CBOR data types in the signed credential:\n * number => `uint`\n * string => `tstr`\n * array => CBOR array []\n * map => CBOR map {}","enum":["object"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}},{"type":"object","title":"ISO 18013-5 Driving Privileges","properties":{"mapFrom":{"$ref":"#/components/schemas/ClaimMapFrom"},"type":{"type":"string","description":"* Claim data type (Driving Privileges). \n* Mapped value must be a compliant `org.iso.18013.5.1.driving_privileges` object as per ISO 18013-5.\n* Mapped to a CBOR data type compliant with org.iso.18013.5.1.","enum":["org.iso.18013.5.1.driving_privileges"]},"required":{"$ref":"#/components/schemas/ClaimRequired"},"defaultValue":{"$ref":"#/components/schemas/ClaimDefaultValue"},"display":{"$ref":"#/components/schemas/ClaimDisplayEntries"}}}]}}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ClaimMappings:example"]},"MobileCredentialConfiguration":{"type":"object","properties":{"type":{"description":"Used to differentiate between different mDocs configurations on your tenant. Thus, its value must:\n- Be unique across all mDocs configurations on your tenant.\n- Not be `VerifiableCredential`.\n- When set to `org.iso.18013.5.*.mDL` (where `*` is a positive integer), MATTR VII recognizes that this is attempt to create an mDL credential configuration and will fail if the validity period is set to 427 days or more.","type":"string","minLength":1,"maxLength":1024,"example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"claimMappings":{"$ref":"#/components/schemas/ClaimMappings"},"claimSourceId":{"type":"string","format":"uuid","description":"References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential."},"expiresIn":{"type":"object","description":"$19a","properties":{"years":{"type":"number"},"months":{"type":"number","example":1,"examples":[1]},"weeks":{"type":"number"},"days":{"type":"number"},"hours":{"type":"number"},"minutes":{"type":"number"},"seconds":{"type":"number"}}},"validFrom":{"type":"object","description":"$19b","properties":{"mapFrom":{"type":"string"}}},"validUntil":{"type":"object","description":"$19c","properties":{"mapFrom":{"type":"string"}}}}},"MobileCredentialConfigurationResponse":{"required":["id","type","expiresIn","claimMappings"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Uniquely identifies the created credential configuration. This identifier can be used to create an offer based on this credential configuration, or to retrieve, update or remove the credential configuration.","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]},"branding":{"type":"object","description":"Credential branding information.\n\nBranding is written into each credential issued from this configuration, in a custom `_branding` extension element to ISO/IEC 18013-5 that is not standardized. Holder and verifier applications need to be built to read it, which MATTR SDKs and MATTR GO do out of the box.","example":{"name":"Credential name","description":"Credential Description","backgroundColor":"#FFFFFF","watermarkImage":"data:image/png;base64,{image-data}","issuerLogo":"data:image/png;base64,{image-data}","issuerIcon":"data:image/svg+xml;base64,{image-data}"},"properties":{"name":{"description":"This string is displayed on the top part of the credential in the holder's digital wallet.","type":"string"},"description":{"description":"This string is displayed below the name field on the credential in the holder's digital wallet.","type":"string"},"backgroundColor":{"description":"Color hex code used for the credential background color in the holder's digital wallet.","type":"string"},"watermarkImage":{"description":"Watermarks are displayed included as a pattern on the credential in the holder's digital wallet. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 245x150 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- If no watermark image is provided, a wave pattern is applied to the credentials by default.\n- The recommended maximum size is 150 KB.","type":"string"},"issuerLogo":{"description":"The issuer logo is displayed on the bottom part of the credential in the holder's digital wallet. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 140x42 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- Transparencies are allowed for **svg** and **png** files.\n- The recommended maximum size is 50 KB.\n- If no logo is provided, the first letter of the issuer name is displayed instead.","type":"string"},"issuerIcon":{"description":"The issuer icon is displayed next to the issuer's logo on the bottom part of the credential in the holder's digital wallet. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 32x32 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- Transparencies are allowed for **svg** and **png** files.\n- The recommended maximum size is 15 KB.","type":"string"}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:MobileCredentialConfigurationResponse:allOf:0:properties:branding:example"]},"includeStatus":{"type":"boolean","default":false,"example":true,"description":"When set to `true`, issued mDocs will include a 'status' field, which can be subsequently changed to 'valid', 'invalid', or 'suspended'.","examples":[true]}}},{"$ref":"#/components/schemas/MobileCredentialConfiguration"}],"title":"MobileCredentialConfigurationResponse"},"GetMobileCredentialConfigurationsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MobileCredentialConfigurationResponse"}}},"title":"GetMobileCredentialConfigurationsResponse"},"MobileCredentialConfigurationRequest":{"required":["type","expiresIn","claimMappings"],"allOf":[{"$ref":"#/components/schemas/MobileCredentialConfiguration"},{"type":"object","properties":{"branding":{"type":"object","description":"Used to apply branding to issued credentials.\n\nBranding is written into each issued credential, in a private `_branding` field of the Mobile Security Object (MSO) that is covered by the issuer's signature. It is therefore available to the holder offline, and it travels with the credential when it is presented. It is also fixed at issuance, so updating branding here does not change credentials that have already been issued.\n\n`_branding` is a custom extension element to ISO/IEC 18013-5 rather than a standardized feature, so holder and verifier applications need to be built to read it. MATTR SDKs and MATTR GO handle this out of the box. If you are working with other solutions, confirm that they read `_branding` before you rely on it for display. Applications that do not recognize the field ignore it.","example":{"name":"Credential name","description":"Credential Description","backgroundColor":"#FFFFFF","watermarkImage":"data:image/png;base64,{image-data}","issuerLogo":"https://example-path-to-image-data.com","issuerIcon":"data:image/svg+xml;base64,{image-data}"},"properties":{"name":{"description":"Insert a meaningful name for the credential. This string is displayed on the top part of the credential in the holder's digital wallet.","type":"string"},"description":{"description":"Insert a meaningful description for the credential. This string is displayed below the name field on the credential in the holder's digital wallet.","type":"string"},"backgroundColor":{"description":"Insert a color hex code to use for the credential background color in the holder's digital wallet.","type":"string"},"watermarkImage":{"description":"Watermarks are displayed included as a pattern on the credential in the holder's digital wallet. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 245x150 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- If no watermark image is provided, a wave pattern is applied to the credentials by default.\n- The recommended maximum size is 150 KB.","type":"string"},"issuerLogo":{"description":"The issuer logo is displayed on the bottom part of the credential in the holder's digital wallet. When not provided, the issuer's name and `issuerIcon` are used instead. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 140x42 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- Transparencies are allowed for **svg** and **png** files.\n- The recommended maximum size is 50 KB.\n- If no logo is provided, the first letter of the issuer name is displayed instead.","type":"string"},"issuerIcon":{"description":"The issuer icon is displayed next to the issuer's name when the credential is offered to the holder. It is also displayed next to the issuer's name on the bottom part of the credential when `issuerLogo` is not provided. When `issuerIcon` is not provided, the first letter from the issuer name is used instead. You can provide either a URL to the image, or a Data URI (base64 encoded) with the following requirements:\n- URL/URI must be publicly available.\n- File must be 32x32 px in size.\n- **svg** and **png** files are supported. We recommend using **svg** files to allow proper scaling across the UI and enable optimal performance.\n- Transparencies are allowed for **svg** and **png** files.\n- The recommended maximum size is 15 KB.","type":"string"}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:MobileCredentialConfigurationRequest:allOf:1:properties:branding:example"]},"includeStatus":{"type":"boolean","default":false,"description":"When set to `true`, issued mDocs are [revocable](/docs/issuance/revocation/overview). They include a `status` object, which refers a [Status list](/docs/issuance/revocation/overview#status-list) where the mDoc status is indicated. Revocable mDocs are issued as **valid** by default, but this status can later be changed to **invalid** or **suspended**.","example":true,"examples":[true]}}}],"title":"CreateMobileCredentialConfigurationRequest"},"MobileCredentialStatus":{"title":"MobileCredentialStatus","type":"object","required":["status"],"properties":{"status":{"description":"mDoc status. Available values depend on the Status List configuration format:\n\n**Draft 14 of the IETF Token Status List specification (1-bit)**: `valid`, `invalid`\n\n**Deprecated Legacy format (2-bit)**: `valid`, `invalid`, `suspended`","type":"string","enum":["valid","suspended","invalid"],"example":"valid","examples":["valid"]}}},"timeToLiveDuration":{"type":"object","description":"Defines how long relying parties can cache Status list tokens of this docType before it is recommended to retrieve a new Status list token from the tenant. Cannot exceed `expiryDuration`.","example":{"days":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:timeToLiveDuration:example"]},"expiryDuration":{"type":"object","description":"Defines how long relying parties can cache Status list tokens of this docType before they expire. Once a Status list token expires, relying parties can no longer use it to check credentials status and must retrieve a new one from the tenant. Regardless of the value of this parameter, Status list tokens expiry cannot exceed the validity of the IACA that is used to sign the Status list token.","example":{"days":2},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:expiryDuration:example"]},"CreateStatusListConfigurationResponse":{"required":["id","docType","timeToLiveDuration","expiryDuration"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Uniquely identifies the created Status list configuration.","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]},"docType":{"type":"string","description":"The unique docType the created Status list configuration is associated with.","example":"Drivers License","examples":["Drivers License"]},"timeToLiveDuration":{"$ref":"#/components/schemas/timeToLiveDuration"},"expiryDuration":{"$ref":"#/components/schemas/expiryDuration"}}}]},"GetStatusListConfigurationsResponse":{"title":"GetCredentialConfigurationsResponse","type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateStatusListConfigurationResponse"}}}},"StatusListConfiguration":{"type":"object","properties":{"docType":{"description":"Status list configurations are unique per docType on your tenant. This value must match the type set when [creating an mDoc credential configuration](/docs/issuance/credential-configuration/api-reference/mdocs#create-an-mdocs-credential-configuration).","type":"string","minLength":1,"maxLength":1024,"example":"DriverLicense","examples":["DriverLicense"]},"timeToLiveDuration":{"$ref":"#/components/schemas/timeToLiveDuration"},"expiryDuration":{"$ref":"#/components/schemas/expiryDuration"}}},"StatusListConfigurationRequest":{"title":"StatusListConfigurationRequest","required":["docType","timeToLiveDuration","expiryDuration"],"allOf":[{"$ref":"#/components/schemas/StatusListConfiguration"},{"type":"object"}]},"StatusListConfigurationUpdateRequest":{"properties":{"timeToLiveDuration":{"$ref":"#/components/schemas/timeToLiveDuration"},"expiryDuration":{"$ref":"#/components/schemas/expiryDuration"}}},"StatusListResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this status list."},"iacaId":{"type":"string","format":"uuid","description":"Identifies the IACA used as the root certificate for credentials in this status list."},"statusListConfigurationId":{"type":"string","format":"uuid","description":"Identifies the status list configuration that determines the status list validity period."},"listSize":{"type":"integer","description":"The maximum number of credentials that can be added to this list before a new status list must be created.","example":100000,"examples":[100000]},"list":{"type":"string","example":"0oRZAu6jEHRtYXR0ci1zdGF0dXNs...","description":"The base-64 encoded token of this status list.","examples":["0oRZAu6jEHRtYXR0ci1zdGF0dXNs..."]}}},"StatusListsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StatusListResponse"}}}},"DistributionStatusListsResponseLatest":{"type":"object","description":"Draft 14 of the IETF Token Status List specification format where `status_lists` is an array of URL strings","required":["status_lists"],"properties":{"status_lists":{"type":"array","description":"All Status list URLs available on this tenant (Draft 14 of the IETF Token Status List specification format)","items":{"type":"string","example":"https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}/token","description":"URL of a Status list token","examples":["https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}/token"]}}}},"DistributionStatusListsResponseLegacy":{"type":"object","description":"Legacy response format where `status_lists` is an array of objects, each containing a `uri` field that points to the Status list token URL.","required":["status_lists"],"properties":{"status_lists":{"type":"array","description":"All Status lists available on this tenant (legacy format)","items":{"type":"object","required":["uri"],"properties":{"uri":{"type":"string","example":"https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}/token","description":"URL of a Status list token","examples":["https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}/token"]}}}}}},"DistributionStatusListsResponse":{"type":"object","description":"Response format depends on the Status List configuration format (Draft 14 of the IETF Token Status List specification vs legacy)","anyOf":[{"$ref":"#/components/schemas/DistributionStatusListsResponseLatest"},{"$ref":"#/components/schemas/DistributionStatusListsResponseLegacy"}]},"TrustedIssuer":{"required":["id","certificatePem","certificateData"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier representing this trusted issuer.","example":"ed74319e-72a6-4401-b3a5-94e980fbebea","examples":["ed74319e-72a6-4401-b3a5-94e980fbebea"]},"certificatePem":{"type":"string","description":"PEM certificate containing trusted issuer data.","example":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n"]},"certificateData":{"type":"object","description":"JSON representation of certificate validity and identifying info.","properties":{"notAfter":{"type":"string","format":"date-time","description":"Timestamp after which the certificate cannot be used to issue valid mDocs.","example":"2033-09-08T23:34:22.000Z","examples":["2033-09-08T23:34:22.000Z"]},"notBefore":{"type":"string","format":"date-time","description":"Timestamp before which the certificate cannot be used to issue valid mDocs.","example":"2023-09-11T23:34:22.000Z","examples":["2023-09-11T23:34:22.000Z"]},"country":{"type":"string","description":"Country code from the certificate subject's RelativeDistinguishedName.","example":"NZ","examples":["NZ"]},"commonName":{"type":"string","description":"Common Name from the certificate subject's RelativeDistinguishedName.","example":"Example IACA","examples":["Example IACA"]},"stateOrProvinceName":{"type":"string","description":"State or province code from the certificate subject's RelativeDistinguishedName. Only returned when the certificate includes it.","example":"NZ-AUK","examples":["NZ-AUK"]},"organisationName":{"type":"string","description":"Organization name from the certificate subject's RelativeDistinguishedName. Only returned when the certificate includes it.","example":"Example Inc.","examples":["Example Inc."]}}}}}]},"GetTrustedIssuersResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/TrustedIssuer"}}},"title":"GetTrustedIssuersResponse"},"TrustedIssuerRequest":{"required":["certificatePem"],"allOf":[{"type":"object","properties":{"certificatePem":{"type":"string","description":"Certificate PEM containing trusted issuer data. This PEM can represent a future-dated IACA to support seamless rotation.","example":"-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\r\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\r\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\r\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\r\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\r\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\r\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\r\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\r\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\r\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\r\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\r\nvkM=\r\n-----END CERTIFICATE-----\r\n"]}}}]},"VerifierCACertificateResponse":{"type":"object","title":"VerifierCACertificateResponse","description":"Response payload for verifier root CA certificate","properties":{"id":{"type":"string","description":"Unique identifier for this Verifier root CA certificate."},"certificatePem":{"type":"string","description":"DTS root CA certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"Hash that includes all the Verifier root CA certificate data and its signature.","example":"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0","examples":["a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore","organisationName"],"properties":{"commonName":{"type":"string","description":"The common name of the Verifier root CA certificate.","example":"Example Verifier","examples":["Example Verifier"]},"country":{"type":"string","description":"The country associated with the Verifier root CA certificate.","example":"US","examples":["US"]},"notAfter":{"type":"string","format":"date-time","description":"The Verifier root CA certificate's expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"The Verifier root CA certificate's validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}},"active":{"type":"boolean","default":true,"description":"Indicates if the Verifier root CA certificate is active. Only active Verifier root CA certificates can be used to sign other intermediate certificates."},"isManaged":{"type":"boolean","description":"Indicates whether the private key for this Verifier root CA certificate is managed by MATTR (`true`) or out of band by the customer as an external certificate (`false`)."}}},"VerifierCACertificateManagedRequest":{"title":"Managed Verifier root CA certificate","type":"object","description":"Request payload for managed verifier root CA certificate","properties":{"commonName":{"type":"string","default":"{tenantDomain} Verifier","description":"Used to define the common name of the created verifier root CA certificate. Used to establish trust with the verifier by wallets that implement certificate-based trust.\n- When provided, the value must be a valid `PrintableString` and cannot be an empty string.\n- If not provided and a custom domain is configured and verified, the custom domain is used followed by the word `Verifier`.\n- If no custom domain is configured, the tenant subdomain is used instead.\n"},"country":{"type":"string","description":"Indicates the verifier's country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid [Alpha 2 country code](https://www.iso.org/glossary-for-iso-3166.html) as per [ISO 3166-1](https://www.iso.org/standard/72482.html)."},"notBefore":{"type":"string","format":"date-time","description":"Used to set the date and time when the Verifier root CA certificate becomes valid and can be used to sign other intermediate certificates.\n- Must not be in the past.\n- Must be before `notAfter`.\n"},"notAfter":{"type":"string","format":"date-time","description":"Used to set the date and time when the Verifier root CA certificate expires.\n- If not provided, calculated as `notBefore` + 20 years.\n- If not provided and `notBefore` is not provided, calculated as time of creation + 20 years.\n- Maximum value is 20 years from creation.\n- Must be after `notBefore`, if provided.\n"}}},"VerifierCACertificateUnmanagedRequest":{"title":"Unmanaged Verifier root CA certificate","type":"object","required":["certificatePem"],"description":"Request payload for unmanaged verifier root CA certificate","properties":{"certificatePem":{"type":"string","description":"Verifier root CA certificate in PEM format. The certificate must be valid and not expired."}}},"VerifierCACertificateUpdateRequest":{"type":"object","required":["active"],"description":"Request payload for updating a verifier root CA certificate.","properties":{"active":{"type":"boolean","default":true,"description":"Indicates if the Verifier root CA certificate is active. Only active certificates can be used to sign other intermediate certificates."}}},"VerifierSignerCaType":{"type":"string","description":"Specifies the type of certificate authority for the verifier root certificate. \n- Set to `mattr` if the certificate is managed by MATTR.\n- Set to `apple` if it is an Apple Business Connect certificate.\n- Set to `external` if the certificate is managed outside of MATTR (e.g., using your own PKI).\n","enum":["mattr","apple","external"]},"SubjectAlternativeName":{"type":"object","required":["type","value"],"properties":{"type":{"type":"integer","description":"[Numeric identifier](https://datatracker.ietf.org/doc/html/rfc5280?utm_source=chatgpt.com#section-4.2.1.6) of the SAN type. For Apple Business Connect certificates, the identifier will be 2 (DNS name).\n"},"value":{"type":"string","description":"The Subject Alternative Name (SAN) value corresponding to the specified type. This should be a domain where you intend to use Verify with Wallet for the Web."}}},"UpdateVerificationRequestSignerResponse":{"title":"Verification request signer with certificate","description":"Verification request signer after a Verification Request Signer Certificate (VRSC) has been uploaded. Includes the uploaded certificate in PEM format, \nas well as the certificate's fingerprint and data. Each `caType` has different rules:\n- `mattr` - MATTR manages the verifier signer and it cannot be updated. \n- `apple` - the `certificatePem` must be a certificate that Apple Business Connect issued using this verifier signer's `csrPem`. \n- `caType` - the `certificatePem` can be from any issuer but needs to match the public key specified in `csrPem`.\n","type":"object","required":["id","caType","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Each Verification request signer will have a unique identifier which must be provided when using this Verification request signer to sign a Verification request.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"caType":{"$ref":"#/components/schemas/VerifierSignerCaType"},"active":{"type":"boolean","description":"Indicates if the Verification request signer is active. Only active Verification request signers can be used to sign Verification requests.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"Verification Request Signer Certificate (VRSC) in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"VRSC Hash that includes all certificate data and its signature.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore"],"properties":{"commonName":{"type":"string","description":"The common name of the VRSC.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"The country associated with the VRSC.","example":"US","examples":["US"]},"notAfter":{"type":"string","format":"date-time","description":"VRSC expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"VRSC validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]},"subjectAlternativeNames":{"type":"array","description":"Required when caType is set to \"apple\" (Apple Business Connect). Specifies the domains where Verify with Wallet for the Web can be used. Each entry must be a fully qualified domain name (FQDN) covered by the Apple-issued certificate.","items":{"$ref":"#/components/schemas/SubjectAlternativeName"}}}}}},"CreateVerificationRequestSignerResponse":{"title":"Verification request signer without certificate","description":"Verification request signer before a Verification Request Signer Certificate (VRSC) has been uploaded. Includes the Certificate Signing Request (CSR).","type":"object","required":["id","caType","csrPem","caId","active"],"properties":{"id":{"type":"string","format":"uuid","description":"Each Verification request signer will have a unique identifier which must be provided when using this Verification request signer to sign a verification request.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"csrPem":{"type":"string","description":"The X.509 Certificate Signing Request (CSR) in PEM format, base64 encoded. Use this CSR to generate a valid certificate, then update the Verification request signer with the resulting certificate. If `caType` is `apple`, upload the `csrPem` to Apple Business Connect to issue a `certificatePem`.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----"]},"caId":{"type":"string","format":"uuid","description":"Unique identifier of the Verifier root CA certificate used to sign the Verification request signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"active":{"type":"boolean","description":"Indicates if the Verifier request signer is active. \n- Only active Verification request signers can be used to sign Verification requests.\n- Verification request signers are created as inactive by default.\n","enum":[false],"example":false,"examples":[false]},"caType":{"$ref":"#/components/schemas/VerifierSignerCaType"}}},"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a paginated list.","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"ExternalVerificationRequestSignerCreateRequest":{"description":"Request payload for creating a Verification request signer using an unmanaged (external) Verifier root CA certificate.","type":"object","required":["caId"],"properties":{"caId":{"type":"string","format":"uuid","description":"Internal identifier of the Verifier root CA certificate that will be used for signing the Verification request signer.\n- Must be an unmanaged (external) Verifier root CA certificate.\n","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"caType":{"type":"string","description":"Indicates the source of the verifier root CA certificate. Set to `external` if the verifier root CA certificate is managed outside of MATTR (e.g., using your own PKI).","enum":["external"]}}},"AppleVerificationRequestSignerCreateRequest":{"description":"Request payload for creating a Verification request signer that uses an Apple Business Connect root CA. The CSR produced from this request must be uploaded to Apple Business Connect. Apple then issues a certificate that you upload to MATTR VII to associate with the signer.","type":"object","required":["caType","emailAddress","country","stateOrProvinceName","organizationName","commonName"],"properties":{"caType":{"type":"string","description":"Source of the verifier root CA certificate. Set to `apple` when the root CA is issued and managed by Apple Business Connect.\n\nApple Business Connect support is a tech preview; functionality may be limited and subject to change.\n","enum":["apple"]},"emailAddress":{"type":"string","format":"email","description":"Email address for the domain or IT administrator.","example":"user@example.com","examples":["user@example.com"]},"country":{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2).","example":"US","examples":["US"]},"stateOrProvinceName":{"type":"string","description":"State, province, or region where the company is registered.","example":"California","examples":["California"]},"organizationName":{"type":"string","description":"Legal name of the company.","example":"MATTR Learn","examples":["MATTR Learn"]},"commonName":{"type":"string","description":"Fully qualified domain name (FQDN) hosting the verifier application.","example":"my-verifier.example.com","examples":["my-verifier.example.com"]}}},"VerificationRequestSignerCreateRequest":{"oneOf":[{"$ref":"#/components/schemas/ExternalVerificationRequestSignerCreateRequest"},{"$ref":"#/components/schemas/AppleVerificationRequestSignerCreateRequest"}]},"verifierSignerId":{"description":"Unique identifier of the Verification Request Signer Certificate (VRSC).","type":"string","format":"uuid","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"VerificationRequestSignerUpdateRequest":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicates if the Verification request signer is active. Only active Verification request signers can be used for signing verification requests.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"Verification Request Signer Certificate (VRSC) in PEM format. If `caType` is `apple`, then this certificate must be issued by Apple Business Connect.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]}}},"VerifierApplicationDisplay":{"type":"object","description":"Controls the appearance of the iframe modal displayed in cross-device presentation workflows.\n\nUse `displayMode` to choose between a `full` branded request web view and a `simple` QR code only view:\n\n- When `displayMode` is `full`, `logoImage` and `headerText` are required.\n- When `displayMode` is `simple`, only `qrCodeInstructions` and `awaitingPresentationText` can be set. Any full-only field (`logoImage`, `headerText`, `bodyText`, `privacyPolicyUrl`, `primaryColorHex`, `privacyPolicyLinkText`) is rejected.\n\nIf you omit `displayMode`, MATTR VII infers it:\n\n- Providing both `logoImage` and `headerText` infers `full`.\n- Any other combination infers `simple`.\n- Omitting the `display` object entirely also renders the simple QR code only view.\n\nThe response always includes an explicit `displayMode`.","properties":{"displayMode":{"type":"string","enum":["full","simple"],"description":"Selects the request web view rendered for cross-device presentations. `full` renders the branded web view. `simple` renders a QR code only view.\n\nOptional. When omitted, MATTR VII infers the mode from the other fields (`full` when `logoImage` and `headerText` are both present, otherwise `simple`) and returns the inferred value in the response. We recommend setting `displayMode` explicitly.","example":"full","examples":["full"]},"logoImage":{"type":"object","description":"Logo to be displayed on the top left corner of the iframe modal. Required when `displayMode` is `full`. Not permitted when `displayMode` is `simple`.","properties":{"url":{"type":"string","description":"URL of logo image.","example":"https://example-logo-image-url.com","examples":["https://example-logo-image-url.com"]},"altText":{"type":"string","description":"Alt text for logo image.","example":"Logo image","examples":["Logo image"]}},"required":["url","altText"]},"headerText":{"type":"string","description":"Header text displayed in the iframe modal. Required when `displayMode` is `full`. Not permitted when `displayMode` is `simple`.","example":"Share your information.","examples":["Share your information."]},"bodyText":{"type":"string","description":"Optional body text displayed in the iframe modal, explaining the context in which the credentials will be shared. Only permitted when `displayMode` is `full`.","example":"Please scan the QR code to the right to provide information required for this interaction.","examples":["Please scan the QR code to the right to provide information required for this interaction."]},"privacyPolicyUrl":{"type":"string","description":"Optional privacy policy URL to include in the iframe modal. Only permitted when `displayMode` is `full`.","example":"https://example-privacy-policy.com","examples":["https://example-privacy-policy.com"]},"primaryColorHex":{"type":"string","description":"Optional hex rgb triplet to indicate the primary color of the iframe modal. Defaults to \"#E7E7E7\" when omitted. Only permitted when `displayMode` is `full`.","example":"#FFFFFF","examples":["#FFFFFF"]},"privacyPolicyLinkText":{"type":"string","description":"Optional custom text for the privacy policy link displayed in the iframe modal. Requires `privacyPolicyUrl` to be set. Defaults to \"View Privacy Policy\" when omitted. Only permitted when `displayMode` is `full`.","example":"Read our privacy policy","examples":["Read our privacy policy"]},"qrCodeInstructions":{"type":"string","description":"Optional custom instructions displayed beneath the QR code in the cross-device iframe modal. Defaults to \"Scan QR code with the digital wallet that holds your information\" when omitted. Permitted in both `full` and `simple` modes.","example":"Scan this QR code with your mobile wallet app","examples":["Scan this QR code with your mobile wallet app"]},"awaitingPresentationText":{"type":"string","description":"Optional custom text displayed after the QR code has been scanned, while awaiting the presentation. Defaults to \"QR scanned, waiting for information...\" when omitted. Permitted in both `full` and `simple` modes.","example":"QR scanned, waiting for your information","examples":["QR scanned, waiting for your information"]}}},"WebVerifierApplication":{"type":"object","title":"Web Verifier Application","description":"Configuration for an mDocs online verifier web application. Either OID4VP or Digital Credentials API configuration must be provided.","properties":{"type":{"type":"string","enum":["web"],"description":"Defines the type of the verifier application."},"domain":{"type":"string","description":"Fully qualified domain name of verifier application that can create an online presentation session. This ensures the verifier tenant only accepts requests from known and trusted applications. Note that `localhost` is not supported. Use local tunneling services for testing.","example":"example-verifier-web-application.com","examples":["example-verifier-web-application.com"]},"additionalDomains":{"type":"array","description":"List of fully qualified domain names of additional verifier applications who can create an online presentation session.","example":["example-verifier-web-application.com"],"minItems":1,"items":{"type":"string","example":"example-verifier-web-application.com","examples":["example-verifier-web-application.com"]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebVerifierApplication:properties:additionalDomains:example"]},"openid4vpConfiguration":{"type":"object","description":"Configuration settings that enable verification using OID4VP.\n\nAt least one of `openid4vpConfiguration` or `dcApiConfiguration` must be provided.\n","properties":{"supportedModes":{"type":"string","description":"Indicates whether a verifier supports only a same-device flow, a cross-device flow, or both. This enables the relying party to adjust verification workflows based on their own business logic and security requirements.","default":"all","enum":["all","sameDevice","crossDevice"]},"redirectUris":{"type":"array","example":["https://example-verifier-web-application.com/presentation/callback"],"minItems":1,"description":"This is the location the user is redirected to when completing a same-device presentation flow. This can be any URI, including custom URI schemes.\n- The domain must match one of the domains specified in the `domain` or `additionalDomains` fields.\n- Wildcard path fragments are supported (e.g. `https://www.example.com/*/callback`) only in the path component.\n","items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebVerifierApplication:properties:openid4vpConfiguration:properties:redirectUris:example"]},"display":{"$ref":"#/components/schemas/VerifierApplicationDisplay"}},"required":["redirectUris"]},"dcApiConfiguration":{"type":"object","description":"Configuration settings that enable verification using the Digital Credentials API.\n\nAt least one of `openid4vpConfiguration` or `dcApiConfiguration` must be provided.\n\n\nDC API support is currently offered as a **tech preview**. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.\n\n","required":["supportedBrowserPlatforms"],"properties":{"supportedBrowserPlatforms":{"type":"object","description":"Specifies which platforms are supported.\n\nAt least one platform must be enabled.","properties":{"desktop":{"type":"boolean","description":"Desktop browser."},"mobile":{"type":"boolean","description":"Mobile browser."}},"example":{"desktop":true,"mobile":true},"required":["desktop","mobile"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebVerifierApplication:properties:dcApiConfiguration:properties:supportedBrowserPlatforms:example"]}}},"resultAvailableInFrontChannel":{"type":"boolean","description":"Indicates whether or not the verification result should be returned directly to the verifier application (`true`) or only via a configured back-end (`false`). Refer to the [detailed workflow](https://learn.mattr.global/docs/verification/remote-web-verifiers/workflow#the-mattr-vii-verifier-tenant-returns-the-verification-results) for more information.","default":true}},"required":["domain","type"]},"teamId":{"type":"string","description":"Team ID of the iOS app.","example":"A2B3C4D5E6","examples":["A2B3C4D5E6"]},"IosVerifierApplication":{"type":"object","title":"iOS Verifier Application","description":"Configuration for an mDocs online verifier iOS application.","properties":{"type":{"type":"string","enum":["ios"],"description":"Defines the type of the verifier application."},"bundleId":{"type":"string","description":"Bundle ID of the iOS app.","example":"com.example-verifier-ios-application","examples":["com.example-verifier-ios-application"]},"openid4vpConfiguration":{"type":"object","properties":{"redirectUri":{"type":"string","example":"https://example-verifier-web-application.com/presentation/callback","description":"This is the location the user is redirected to when completing the presentation flow. This can be any URI, including custom URI schemes.","examples":["https://example-verifier-web-application.com/presentation/callback"]}},"required":["redirectUri"]},"resultAvailableInFrontChannel":{"type":"boolean","description":"Indicates whether or not the verification result should be returned directly to the web application (`true`) or only via a configured back-end (`false`). Refer to the [detailed workflow](https://learn.mattr.global/docs/verification/remote-web-verifiers/workflow#the-mattr-vii-verifier-tenant-returns-the-verification-results) for more information.","default":true},"teamId":{"$ref":"#/components/schemas/teamId"},"maxTimeOfflineInSecs":{"type":"integer","minimum":86400,"default":604800,"maximum":2592000,"description":"Maximum number of seconds the SDK can operate offline before requiring a new license token.\n- Cannot be less than 1 day (86400 seconds).\n- Cannot exceed 30 days (2592000 seconds).\n- Default is 7 days (604800 seconds).\n","example":86400,"examples":[86400]},"appAttest":{"type":"object","description":"App Attest configuration for the iOS verifier application.","properties":{"required":{"type":"boolean","description":"Whether App Attest is required during registration and token renewal.\n- When `true`, the verifier application instance must provide a valid attestation during registration and token renewal, and the platform will verify the attestation with Apple’s App Attest service to ensure the legitimacy of the request.\n- When `false`, the verifier application instance can register and renew tokens using just an authentication assertion without attestation.\n","example":true,"examples":[true]},"environment":{"type":"string","enum":["development","production"],"description":"The App Attest environment. Apple recommends using the development environment for testing and switching to production for apps in distribution. The platform will verify attestations with the corresponding Apple environment based on this configuration.","example":"production","examples":["production"]}},"required":["required","environment"]}},"required":["bundleId","type","teamId"]},"AndroidVerifierApplication":{"type":"object","title":"Android Verifier Application","description":"Configuration for an mDocs online verifier Android application.","properties":{"type":{"type":"string","enum":["android"],"description":"Defines the type of the verifier application."},"packageName":{"type":"string","description":"Package name of the Android application that will interact with this verifier application.","example":"com.example-verifier-android-application","examples":["com.example-verifier-android-application"]},"packageSigningCertificateThumbprints":{"type":"array","description":"- SHA-256 hex-encoded fingerprints of the signing key certificates that were used to sign the Android Package Kit (APK) or app bundle.\n- This ensures the verifier tenant only accepts requests from known and trusted applications.\n- Any verification requests will fail if the certificate thumbprint does not match. Refer to [Android app signing](https://learn.mattr.global/docs/verification/signing-verification-requests/android-app-signing) for more information.\n","items":{"type":"string"},"example":["1232584B6F6A892D356899FB9576C5F226A179E6199F2B7A1D837B5C234C5A8E"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AndroidVerifierApplication:properties:packageSigningCertificateThumbprints:example"]},"openid4vpConfiguration":{"type":"object","description":"Configuration settings that enable verification using OID4VP.\n\nBoth `openid4vpConfiguration` and `dcApiConfiguration` are optional. Omit both to configure a MATTR VII backend for in-person (proximity) verification only.\n","properties":{"redirectUri":{"type":"string","example":"https://example-verifier-android-application.com/presentation/callback","description":"This is the location the user is redirected to when completing the presentation flow. This can be any URI, including custom URI schemes.","examples":["https://example-verifier-android-application.com/presentation/callback"]}},"required":["redirectUri"]},"dcApiConfiguration":{"description":"Configuration settings that enable verification using the Digital Credentials API.\n\nBoth `openid4vpConfiguration` and `dcApiConfiguration` are optional. Omit both to configure a MATTR VII backend for in-person (proximity) verification only.\n\n\nDC API support is currently offered as a **tech preview**. As such, functionality may be limited, may not work in all scenarios, and could change or break without prior notice.\n\n","type":"object","properties":{"enabled":{"type":"boolean"}}},"resultAvailableInFrontChannel":{"type":"boolean","description":"Indicates whether or not the verification result should be returned directly to the Android application (`true`) or only via a configured back-end (`false`). Refer to the [detailed workflow](https://learn.mattr.global/docs/verification/remote-web-verifiers/workflow#the-mattr-vii-verifier-tenant-returns-the-verification-results) for more information.","default":true},"maxTimeOfflineInSecs":{"type":"integer","minimum":86400,"default":604800,"maximum":2592000,"description":"Maximum number of seconds the SDK can operate offline before requiring a new license token.\n- Cannot be less than 1 day (86400 seconds).\n- Cannot exceed 30 days (2592000 seconds).\n- Default is 7 days (604800 seconds).\n","example":86400,"examples":[86400]},"keyAttestation":{"type":"object","description":"Key Attestation configuration for the Android verifier application.","properties":{"required":{"type":"boolean","description":"Determines whether Key Attestation is required during registration and token renewal.\n- When `true`, the verifier application instance must provide a valid attestation during registration and token renewal, and the platform will verify the attestation to ensure the legitimacy of the request.\n- When `false`, the verifier application instance can register and renew tokens using just an authentication assertion without attestation.\n","example":true,"examples":[true]}},"required":["required"]}},"required":["type","packageName","packageSigningCertificateThumbprints"]},"VerifierApplicationResponse":{"type":"object","title":"VerifierApplicationResponse","description":"Verifier application response.","properties":{"id":{"type":"string","description":"Unique identifier corresponding to the verifier application.","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"name":{"type":"string","description":"Unique name to identify the verifier application.","example":"Example Verifier Web Application","examples":["Example Verifier Web Application"]},"resultAvailableInFrontChannel":{"type":"boolean","description":"Indicates whether or not the verification result should be returned directly to the web application (`true`) or only via a configured back-end (`false`). Refer to the [detailed workflow](https://learn.mattr.global/docs/verification/remote-web-verifiers/workflow#the-mattr-vii-verifier-tenant-returns-the-verification-results) for more information.","default":true}},"required":["id","name"],"oneOf":[{"$ref":"#/components/schemas/WebVerifierApplication"},{"$ref":"#/components/schemas/IosVerifierApplication"},{"$ref":"#/components/schemas/AndroidVerifierApplication"}]},"VerifierApplicationRequest":{"type":"object","description":"Configuration for an mDocs online verifier application.","properties":{"name":{"type":"string","description":"Unique name to identify the verifier application.","example":"Example Verifier Web Application","examples":["Example Verifier Web Application"]}},"required":["name"],"oneOf":[{"$ref":"#/components/schemas/WebVerifierApplication"},{"$ref":"#/components/schemas/IosVerifierApplication"},{"$ref":"#/components/schemas/AndroidVerifierApplication"}]},"VerifierApplicationInstanceResponse":{"type":"object","title":"Verifier Application Instance Response","description":"Verifier application instance response.","properties":{"id":{"type":"string","description":"Unique identifier of the registered verifier application instance.","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"appAttestationType":{"type":"string","description":"The type of attestation used during registration of the verifier application instance.","enum":["none","app_attestation","key_attestation"],"example":"key_attestation","examples":["key_attestation"]},"registeredAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the verifier application instance was registered.","example":"2023-10-05T14:48:00.000Z","examples":["2023-10-05T14:48:00.000Z"]},"licenseExpiresAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the license for the verifier application instance expires.","example":"2024-10-05T14:48:00.000Z","examples":["2024-10-05T14:48:00.000Z"]},"lastAttestedAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the verifier application instance was last attested.","example":"2023-12-01T10:30:00.000Z","examples":["2023-12-01T10:30:00.000Z"]},"externalReferenceId":{"type":"string","description":"Optional external reference identifier associated with the verifier application instance.","example":"external-ref-12345","examples":["external-ref-12345"]},"deviceDetails":{"type":"object","description":"Details about the device on which the verifier application instance is registered.","properties":{"deviceModel":{"type":"string","description":"Model of the device.","example":"iPhone 12","examples":["iPhone 12"]},"deviceMake":{"type":"string","description":"Manufacturer of the device.","example":"Apple","examples":["Apple"]},"osVersion":{"type":"string","description":"Operating system version of the device.","example":"iOS 14.4","examples":["iOS 14.4"]}},"required":["deviceModel","deviceMake","osVersion"]},"sdkDetails":{"type":"object","description":"Details about the SDK used by the verifier application instance.","properties":{"sdkVersion":{"type":"string","description":"Version of the SDK.","example":"1.2.3","examples":["1.2.3"]}},"required":["sdkVersion"]}},"required":["id","appAttestationType","registeredAt","licenseExpiresAt","deviceDetails","sdkDetails"]},"WalletProviderResponse":{"type":"object","title":"WalletProviderResponse","description":"Response payload for verifier wallet provider","properties":{"id":{"type":"string","description":"Unique system generated id to use as a reference for this wallet.","example":"e63a2e46-5afa-48f9-bcc2-2114cf5f331b","examples":["e63a2e46-5afa-48f9-bcc2-2114cf5f331b"]},"name":{"type":"string","description":"Unique identifier for the wallet. This field is compared against the wallet identifier defined in the request by the [Verifier Web SDK](https://api-reference-sdk.mattr.global/verifier-sdk-web/latest/index.html#md:request-credentials-to-support-both-same-device-and-cross-device).","example":"Example wallet provider","examples":["Example wallet provider"]},"openid4vpConfiguration":{"type":"object","properties":{"authorizationEndpoint":{"description":"Url scheme used to invoke this wallet. It is named `authorizationEndpoint` because the wallet acts as an Authorisation server as per the [OAuth 2.0 framework](https://datatracker.ietf.org/doc/html/rfc6749).","type":"string","example":"com-example.wallet://","examples":["com-example.wallet://"]}},"required":["authorizationEndpoint"]}},"required":["id","name","openid4vpConfiguration"]},"WalletProviderRequest":{"type":"object","title":"WalletProviderRequest","description":"Request payload for verifier wallet provider","properties":{"name":{"type":"string","description":"Unique identifier for the wallet. This field is compared against the wallet identifier defined in the request by the [Verifier Web SDK](https://api-reference-sdk.mattr.global/verifier-sdk-web/latest/index.html#md:request-credentials-to-support-both-same-device-and-cross-device). Value must be unique amongst configured wallet providers on your tenant.","example":"Example wallet provider","examples":["Example wallet provider"]},"openid4vpConfiguration":{"type":"object","properties":{"authorizationEndpoint":{"description":"Url scheme used to invoke this wallet. It is named `authorizationEndpoint` because the wallet acts as an Authorisation server as per the [OAuth 2.0 framework](https://datatracker.ietf.org/doc/html/rfc6749).","type":"string","example":"com-example.wallet://","examples":["com-example.wallet://"]}},"required":["authorizationEndpoint"]}},"required":["name","openid4vpConfiguration"]},"PresentationSuccessResult":{"type":"object","additionalProperties":false,"description":"Successful presentation result when the holder completed the presentation workflow. May include verified credentials, credential errors for credentials not provided, or claim errors for specific claims that failed verification.","required":["sessionId","challenge","credentialQuery"],"properties":{"sessionId":{"type":"string","description":"The unique identifier for this verification session."},"challenge":{"type":"string","description":"The challenge used to verify response authenticity. Validate this matches the challenge generated before starting the session."},"state":{"type":"string","description":"Caller-supplied correlation reference. Only present for web presentation sessions where a `state` value was provided at session creation."},"credentialQuery":{"type":"array","description":"The original request defining what credentials and claims were requested.","items":{"type":"object"}},"credentials":{"type":"array","description":"Array of verified credentials with their claims and verification status. May be absent if no credentials were provided.","items":{"type":"object","properties":{"docType":{"type":"string","description":"The credential type (e.g., org.iso.18013.5.1.mDL for a mobile driver's license)."},"validityInfo":{"type":"object","description":"Credential validity period timestamps.","properties":{"signed":{"type":"string","description":"Timestamp when the credential was signed."},"validFrom":{"type":"string","description":"Timestamp from which the credential is valid."},"validUntil":{"type":"string","description":"Timestamp until which the credential is valid."},"expectedUpdate":{"type":"string","description":"Expected timestamp for the next credential update."}}},"claims":{"type":"object","description":"Verified claims organized by namespace. For an mDL, claims appear under the org.iso.18013.5.1 namespace."},"claimErrors":{"type":"object","description":"Errors for individual claims that couldn't be verified or were not returned, organized by namespace."},"branding":{"type":"object","properties":{"name":{"type":"string","example":"Example Branding","examples":["Example Branding"]},"description":{"type":"string","example":"Example Branding Description","examples":["Example Branding Description"]},"backgroundColor":{"type":"string","example":"#FFFFFF","examples":["#FFFFFF"]},"watermarkImage":{"type":"object","properties":{"format":{"type":"string","example":"svg","examples":["svg"]},"data":{"type":"string","example":"aWNvbg==","examples":["aWNvbg=="]}}},"issuerLogo":{"type":"object","properties":{"format":{"type":"string","example":"svg","examples":["svg"]},"data":{"type":"string","example":"aWNvbg==","examples":["aWNvbg=="]}}},"issuerIcon":{"type":"object","properties":{"format":{"type":"string","example":"svg","examples":["svg"]},"data":{"type":"string","example":"aWNvbg==","examples":["aWNvbg=="]}}}}},"issuerInfo":{"type":"object","description":"Information about the credential issuer.","properties":{"commonName":{"type":"string","description":"Common name of the issuer."},"trustedIssuerId":{"type":"string","description":"Identifier of the trusted issuer."}}},"verificationResult":{"type":"object","description":"Verification status for this credential.","properties":{"verified":{"type":"boolean","description":"Indicates if verification succeeded for this credential."},"reason":{"type":"object","description":"Explanation of verification failure (only present when verified is false).","properties":{"type":{"type":"string","description":"Type of verification failure (e.g., MobileCredentialInvalid)."},"message":{"type":"string","description":"Human-readable description of the verification failure."}}}}},"ecosystemValidation":{"type":"object","properties":{"validated":{"type":"boolean"},"policyVersion":{"type":"string"},"failReasons":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}},"error":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}}}}}}}},"credentialErrors":{"type":"array","description":"Errors for credentials that couldn't be returned (e.g., if the holder doesn't have a matching credential).","items":{"type":"object","properties":{"docType":{"type":"string","description":"The credential type that was requested but not provided."},"errorCode":{"type":"string","description":"Error code indicating why the credential wasn't returned (e.g., notReturned)."}}}}}},"PresentationFailureResult":{"type":"object","additionalProperties":false,"description":"Failed presentation result when the holder was unable to complete the presentation workflow (e.g., wallet unavailable, session aborted, response errors).","required":["sessionId","challenge","credentialQuery","error"],"properties":{"sessionId":{"type":"string","description":"The unique identifier for this verification session."},"challenge":{"type":"string","description":"The challenge used to verify the response."},"state":{"type":"string","description":"Caller-supplied correlation reference. Only present for web presentation sessions where a `state` value was provided at session creation."},"credentialQuery":{"type":"array","description":"The original request defining what credentials and claims were requested.","items":{"type":"object"}},"error":{"type":"object","description":"Details about why the presentation failed.","properties":{"type":{"type":"string","description":"Error type - WalletUnavailable, SessionAborted, ResponseError, VerificationError, or Unknown."},"message":{"type":"string","description":"Human-readable description of the error."}}}}},"merchantId":{"type":"string","description":"The [merchantIdentifier](https://developer.apple.com/documentation/passkit/pkidentityrequest/merchantidentifier) used by PassKit to retrieve credential data.","example":"com.domain.subdomain","examples":["com.domain.subdomain"]},"AppleIdentityAccessCertificateSigningResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier corresponding to the Apple Identity Access CSR.","example":"fd44e792-45ac-11f0-bef8-bb24f133065e","examples":["fd44e792-45ac-11f0-bef8-bb24f133065e"]},"teamId":{"$ref":"#/components/schemas/teamId"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"csrPem":{"type":"string","description":"Certificate Signing Request (CSR) in PEM format."}},"required":["id","teamId","merchantId","csrPem"]},"AppleIdentityAccessCertificateSigningRequest":{"type":"object","properties":{"teamId":{"$ref":"#/components/schemas/teamId"},"merchantId":{"$ref":"#/components/schemas/merchantId"}},"required":["teamId","merchantId"]},"TrustedIssuersResponse":{"type":"object","title":"TrustedIssuersResponse","description":"Response payload for trusted issuer","properties":{"iacas":{"type":"array","description":"List of trusted IACAs.","items":{"type":"object","properties":{"certificate":{"type":"string","description":"Trusted IACA certificate."}}}}}},"WebSemanticCredentialSignRequest":{"title":"SignWebSemanticCredentialRequest","type":"object","required":["payload"],"properties":{"payload":{"type":"object","properties":{"name":{"type":"string","example":"Course credential","description":"Insert a meaningful name for the credential. This string is displayed on the top part of the credential in the holder's digital wallet. Maximum length is 18 characters, and additional characters will not be displayed.","examples":["Course credential"]},"description":{"type":"string","description":"Insert a meaningful description for the credential. This string is displayed below the `name` field on the credential in the holder's digital wallet. Maximum length is 38 characters, and additional characters will not be displayed.","example":"This credential shows that the person has attended the mention course and attained the relevant awards.","examples":["This credential shows that the person has attended the mention course and attained the relevant awards."]},"@context":{"type":"array","description":"Optional array of contexts that can be used to expand credential claims and convey their meaning. As part of the credential creation MATTR VII will auto-inject the following contexts, which reference the W3C Verifiable Credential definitions:\n- https://www.w3.org/2018/credentials/v1\n- https://mattr.global/contexts/vc-extensions/v2\n- https://w3id.org/vc-revocation-list-2020/v1 (only for revocable credentials).\nIf you require introducing a different context for your production implementation, please contact us. Referenced contexts must be whitelisted or credential issuance will fail. In-line context definitions would also result in an error.","minLength":1,"example":["https://optionalschema.example/"],"items":{"type":"string","minLength":0},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticCredentialSignRequest:properties:payload:properties:@context:example"]},"type":{"description":"This array of credential types indicates what sort of information a credential holds. This is a unique identifier used to differentiate between various JSON credential types. MATTR VII automatically injects `VerifiableCredential` as the first value of this array, and you must include at least one additional value in the request payload.","type":"array","example":["EducationalOccupationalCredential","AlumniCredential"],"items":{"type":"string","minLength":1,"description":"Describes the additional specific types of the claimed data, must be within the scope of @context, resulting credential will always include VerifiableCredential."},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticCredentialSignRequest:properties:payload:properties:type:example"]},"credentialSubject":{"type":"object","description":"Each value is a claim defined by one of the JSON-LD schemas.","minItems":1,"example":{"id":"did:example:abcdb1f712ebc6f1c276e12ec21","givenName":"Jamie","familyName":"Doe","alumniOf":"Example University"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticCredentialSignRequest:properties:payload:properties:credentialSubject:example"]},"credentialBranding":{"type":"object","description":"Includes optional credential branding properties. Refer to [this video](https://www.youtube.com/watch?v=Tu8ApHBWG90) for branding best practices.","properties":{"backgroundColor":{"type":"string","example":"#B00AA0","description":"Insert a color hex code to use for the credential background color in the holder's digital wallet.","examples":["#B00AA0"]},"watermarkImageUrl":{"type":"string","example":"https://example.edu/img/watermark.png","description":"Insert a URL for a watermark image to be included as a pattern on the credential in the holder's digital wallet:\n- URL must be publicly available.\n- Must be 245x150 px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended.","examples":["https://example.edu/img/watermark.png"]}}},"issuer":{"type":"object","description":"Includes Issuer id (DID) and domain name.","required":["id","name"],"properties":{"id":{"type":"string","example":"did:issuer:abcdb1f712ebc6f1c276e12ec21","description":"Use the DID that identifies the credential's issuer, which attests the claims in the credential. This must be a publicly available and resolvable `did:web` for the credential to be valid and verifiable.","examples":["did:issuer:abcdb1f712ebc6f1c276e12ec21"]},"name":{"type":"string","description":"Insert a meaningful name to indicate the issuer. This string is used when the credential is offered to the holder. It is also used on the bottom part of the credential when `logoURL` is not provided.","example":"ABC University","examples":["ABC University"]},"logoUrl":{"type":"string","description":"Insert a URL for a logo that is displayed on the bottom part of the credential. If no logo is provided, the issuer's `name` and `iconURL` are used instead. The logo must meet the following criteria:\n- URL must be publicly available.\n- Must be 140x42 px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended. Raster images, whilst supported, are currently displayed at 1x resolution and may look pixelated on some devices.\n- Transparencies are allowed for **svg** or **png** images.\n- If no logo is provided, the first letter of the issuer name is displayed instead.\n- The recommended maximum size is 50 KB.","example":"https://example.edu/img/logo.png","examples":["https://example.edu/img/logo.png"]},"iconUrl":{"type":"string","example":"https://example.edu/img/icon.png","description":"Insert a URL for an icon that is displayed next to the issuer's name when the credential is offered to the holder. It is also displayed next to the issuer's name on the bottom part of the credential when `logoURL` is not provided. When `iconURL` is not provided, the first letter from `name` is used instead. The icon must meet the following criteria:\n- URL must be publicly available.\n- Must be 32x32 px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended. Raster images, whilst supported, are currently displayed at 1x resolution and may look pixelated on some devices.\n- Transparencies are allowed for svg or png images.\n- The recommended maximum size is 15 KB.","examples":["https://example.edu/img/icon.png"]}}},"expirationDate":{"type":"string","example":"2024-02-01T08:12:38.156Z","description":"Insert the credential expiration date, after which it will not be considered valid and cannot be verified. Expiration date can not be in the past or before `issuanceDate`. When not specified, the credential will not have an expiration date and never expire.","examples":["2024-02-01T08:12:38.156Z"]},"issuanceDate":{"type":"string","description":"The timestamp at which the credential becomes valid. This can be used to issue future-dated credentials. Must not be in the past or after `expirationDate`, when the latter is specified. When not specified, `issuanceDate` will default to the current time.","example":"2023-02-01T08:12:38.156Z","examples":["2023-02-01T08:12:38.156Z"]}},"required":["type","claims","issuer","credentialSubject"]},"proofType":{"description":"This is an _optional_ field which defines the cryptographic algorithm used to sign the credential. The credential Issuer's DID must contain a key that supports the corresponding signing capability. If no `proofType` is provided, the credential will be signed using the key that is available in the Issuer's DID:\n- If a `Bls12381G2` key is available, the credential will be signed with a `BbsSignature2022` proof. Credentials signed with this proof type support selective disclosure.\n- If a `Bls12381G2` key is unavailable but a `Ed25519` key is available, the credential will be signed with a `Ed25519Signature2018 proof`. Credentials signed with this proof type **do not** support selective disclosure.\n- If none of the two suitable keys are available, the request will be rejected and the credential will not be created.","type":"string","enum":["Ed25519Signature2018","BbsSignature2022"],"example":"Ed25519Signature2018","examples":["Ed25519Signature2018"]},"tag":{"type":"string","description":"Insert a case sensitive tag to reference this credential. The gets stored as part of the credential metadata and can be used to search for it in the credential registry.","example":"identifier123","minLength":1,"maxLength":1024,"examples":["identifier123"]},"persist":{"type":"boolean","description":"When set to `true`, both the credential and the credential metadata are stored in the credential registry. When set to `false`, only the following metadata is stored in the credential registry:\n- `id`\n- `tag`\n- `credentialStatus`\n- `issuanceDate`\n\n\nCredentials by nature tend to hold Personally Identifying Information (PII). Before storing credential data, familiarize yourself with compliance to any PII restrictions that may apply to your use-case.\n","default":false},"revocable":{"type":"boolean","description":"When set to `true`, the created credential can later be revoked. When set to `false`, the credential cannot be revoked. When set to `true`, `https://w3id.org/vc-revocation-list-2020/v1` is injected into the credential `@context` object when it is issued. This references the JSON-LD definition of the `credentialStatus` object.","default":false}},"description":"Sign JSON credential request"},"WebSemanticVerifiableCredential":{"type":"object","properties":{"@context":{"type":"array","description":"As part of the credential creation MATTR VII will auto-inject the following contexts, which reference the W3C Verifiable Credential definitions:\n- https://www.w3.org/2018/credentials/v1\n- https://mattr.global/contexts/vc-extensions/v2\n- https://w3id.org/vc-revocation-list-2020/v1 (only for revocable credentials).\nIf you require introducing a different context for your production implementation, please [contact us](mailto:dev-support@mattr.global). Referenced contexts must be whitelisted or credential issuance will fail. In-line context definitions would also result in an error.","example":["https://www.w3.org/2018/credentials/v1","https://mattr.global/contexts/vc-extensions/v2","https://w3id.org/vc-revocation-list-2020/v1","https://optionalschema.example/"],"items":{"type":"string","minLength":1},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticVerifiableCredential:properties:@context:example"]},"type":{"type":"array","example":["VerifiableCredential","AlumniCredential"],"items":{"type":"string","minLength":1,"example":"\"AlumniCredential\", \"VerifiableCredential\"","examples":["\"AlumniCredential\", \"VerifiableCredential\""]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticVerifiableCredential:properties:type:example"]},"issuer":{"description":"Includes issuer id (did) and its domain (inside name parameter)","oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string","example":"did:web:organization.com","examples":["did:web:organization.com"]},"name":{"type":"string","example":"Example University","examples":["Example University"]}}}]},"issuanceDate":{"type":"string","format":"date-time","example":"2020-05-02T12:06:29.156Z","examples":["2020-05-02T12:06:29.156Z"]},"credentialStatus":{"$ref":"#/components/schemas/CredentialStatus"},"credentialSubject":{"type":"object","example":{"givenName":"Jamie","familyName":"Doe","alumniOf":"Example University"},"properties":{"givenName":{"type":"string","example":"Jamie","examples":["Jamie"]},"familyName":{"type":"string","example":"Doe","examples":["Doe"]},"alumniOf":{"type":"string","example":"Example University","examples":["Example University"]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticVerifiableCredential:properties:credentialSubject:example"]},"proof":{"$ref":"#/components/schemas/ED25519Signature2018"},"name":{"type":"string","example":"Alumni Credential","description":"Name of the credential (requires v2 data model)","examples":["Alumni Credential"]},"description":{"type":"string","example":"This credential shows that the person has attended the mentioned university.","description":"Description of the credential (requires v2 data model)","examples":["This credential shows that the person has attended the mentioned university."]}},"required":["type","issuanceDate","credentialSubject","proof"],"title":"WebSemanticVerifiableCredential"},"WebSemanticCredentialSignResponse":{"title":"SignWebSemanticCredentialResponse","type":"object","x-examples":{},"properties":{"id":{"type":"string","example":"873277c0-a162-11ea-8a1d-a111119347e6","description":"Unique identifier of the new JSON credential.","examples":["873277c0-a162-11ea-8a1d-a111119347e6"]},"credential":{"$ref":"#/components/schemas/WebSemanticVerifiableCredential"},"tag":{"type":"string","example":"identifier123","description":"Credential tag, as inserted in the request. Can be used to search the credential registry.","examples":["identifier123"]},"credentialStatus":{"$ref":"#/components/schemas/CredentialStatus"},"issuanceDate":{"type":"string","example":"2020-05-02T12:06:29.156Z","examples":["2020-05-02T12:06:29.156Z"]}},"required":["id","credential","issuanceDate"],"description":"Sign JSON credential response"},"GetCredentialResponse":{"type":"object","x-examples":{},"title":"WebManifestResponse","properties":{"id":{"type":"string","example":"873277c0-a162-11ea-8a1d-a111119347e6","examples":["873277c0-a162-11ea-8a1d-a111119347e6"]},"credential":{"$ref":"#/components/schemas/VerifiableCredential"},"tag":{"type":"string","example":"identifier123","examples":["identifier123"]},"credentialStatus":{"$ref":"#/components/schemas/CredentialStatus"},"issuanceDate":{"type":"string","example":"2020-05-02T12:06:29.156Z","examples":["2020-05-02T12:06:29.156Z"]}},"required":["id","issuanceDate"]},"GetCredentialsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/GetCredentialResponse"}}},"title":"GetCredentialsResponse"},"VerifyWebSemanticCredentialRequest":{"title":"VerifyWebSemanticCredentialRequest","type":"object","description":"VerifyWebSemanticCredentialRequest","required":["payload"],"properties":{"payload":{"allOf":[{"$ref":"#/components/schemas/WebSemanticVerifiableCredential"}],"description":"Replace with the contents of the credential object from the response obtained when creating a JSON credential. Make sure you only include the contents of the `credential` object and not the entire response."},"assertExpiry":{"type":"boolean","description":"When set to `true`, verification will fail when expiration date has passed. This field is deprecated in favour of `assertValidUntil`, and will be disabled from September 2024.","default":true,"deprecated":true},"checkRevocation":{"type":"boolean","description":"When set to `true`, verification will fail when the credential has been revoked.","default":true},"assertValidFrom":{"type":"boolean","description":"When set to `true`, verification will fail when `issuanceDate` has not been reached.","default":true},"assertValidUntil":{"type":"boolean","description":"When set to `true`, verification will fail when `expirationDate` has passed. When specified, this overrides the deprecated `assertExpiry` property.","default":false}}},"VerifyWebSemanticCredentialResponse":{"title":"VerifyWebSemanticCredentialResponse","type":"object","description":"VerifyWebSemanticCredentialResponse","required":["verified"],"properties":{"verified":{"type":"boolean","description":"Indicates whether the verification status is `true` or `false`. For responses that show the verified status to be `false`, a further error body is returned with more details about the error:\n- The credential has been revoked.\n- The Issuer DID cannot be resolved.\n- The issuer public key is invalid.\n- The credential JSON-LD context is invalid.\n- The credential signature is invalid."},"reason":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"}},"required":["type","message"]}}},"RevocationStatusResponse":{"type":"object","properties":{"isRevoked":{"type":"boolean","description":"Indicates whether the credential is revoked (`true`) or not (`false`).","example":false,"examples":[false]}},"required":["isRevoked"],"description":"","title":"RevocationStatusResponse"},"SetRevocationStatus":{"type":"object","properties":{"isRevoked":{"type":"boolean","description":"Indicates whether the credential is revoked (`true`) or not (`false`).","example":false,"examples":[false]}},"required":["isRevoked"],"description":"","title":"SetRevocationStatus"},"CreatePayloadRequest":{"description":"Create a payload","type":"object","properties":{"from":{"type":"string","minLength":1,"description":"The sender's DID URL, obtained from the `id` field of the first `keyAgreement` entry of the DID document. This must be a DID with a key type suitable for messaging (not a BLS key type).","example":"did:web:organization.com","examples":["did:web:organization.com"]},"to":{"type":"array","description":"The intended recipients DID URL.","items":{"type":"string"},"example":["did:key:subjectDid1","did:key:subjectDid2","did:key:subjectDid3"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreatePayloadRequest:properties:to:example"]}},"required":["from","to"],"title":"CreatePayloadRequest"},"RevocationStatusNotification":{"title":"RevocationStatusNotification","type":"object","properties":{"id":{"type":"string","minLength":1},"type":{"type":"string","minLength":1},"to":{"type":"array","items":{"required":["string"],"properties":{}},"example":["did:key:subjectDid1","did:key:subjectDid2","did:key:subjectDid3"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:RevocationStatusNotification:properties:to:example"]},"from":{"type":"string","minLength":1,"example":"did:web:organization.com","examples":["did:web:organization.com"]},"created_time":{"type":"number"},"body":{"type":"object","properties":{"revocationListCredential":{"type":"string","minLength":1},"revocationListIndex":{"type":"string","minLength":1},"isRevoked":{"type":"boolean"}},"required":["revocationListCredential","revocationListIndex","isRevoked"]}},"required":["id","type","to","from","created_time","body"]},"CreatePresentationQueryByExample":{"type":"object","x-examples":{},"title":"CreatePresentationQueryByExample","properties":{"type":{"type":"string","example":"QueryByExample","description":"Indicates what type of query method would be used by presentation requests created from this presentation template. For basic presentation templates you must use `QueryByExample`.","examples":["QueryByExample"]},"credentialQuery":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","minProperties":1,"properties":{"required":{"type":"boolean","description":"When set to `true`, the verification workflow will fail if a matching credential is not provided in the verifiable presentation response. You can only change this to `false` when your templates has multiple `credentialQuery` objects."},"reason":{"type":"string","description":"This value is displayed in the mobile wallet to provide the holder with context around why a credential is being requested. Ensure that this is written exactly as you would like it to appear to the user."},"example":{"type":"array","items":{"type":"object","properties":{"@context":{"type":"array","description":"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.","items":{}},"type":{"description":"The credential type that the mobile wallet will use to return matching credentials. Upon the holder's consent, the wallet would only return credentials that match this type and have been issued by the issuers included in the `trustedIssuer` object. When you include multiple credential types, the wallet will only return credentials that match **all** of the included types.","oneOf":[{"type":"string","example":"AlumniCredential","examples":["AlumniCredential"]},{"type":"array","example":["[AlumniCredential]"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreatePresentationQueryByExample:properties:credentialQuery:items:properties:example:items:properties:type:oneOf:1:example"]}]},"trustedIssuer":{"type":"array","description":"This array is used to determine what credential issuers to accept in this verification workflow.","items":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates whether this issuer is required for a credential to be accepted in this workflow."},"issuer":{"type":"string","description":"Issuer's DID."}},"required":["required","issuer"]}}},"required":["@context","type","trustedIssuer"]}}},"required":["required","example"]}}},"required":["type","credentialQuery"]},"CreatePresentationQueryByFrame":{"type":"object","title":"CreatePresentationQueryByFrame","properties":{"type":{"type":"string","description":"Indicates what type of query method would be used by presentation requests created from this presentation template. For selective-disclosure presentation templates you must use `QueryByFrame`."},"credentialQuery":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"reason":{"type":"string","description":"This value is displayed in the mobile wallet to provide the holder with context around why a credential is being requested. Ensure that this is written exactly as you would like it to appear to the user."},"frame":{"type":"object","required":["@context","type","credentialSubject"],"properties":{"@context":{"type":"array","description":"This is the JSON-LD schema used to expand the `credentialSubject`.","items":{"type":"object"}},"type":{"description":"The credential type that the mobile wallet will use to return matching credentials. Upon the holder's consent, the wallet would only return credentials that match this type and have been issued by the issuers included in the `trustedIssuer` object. When you include multiple credential types, the wallet will only return credentials that match **all** of the included types.","oneOf":[{"type":"string","example":"VerifiableCredential","description":"The value must be VerifiableCredential","examples":["VerifiableCredential"]},{"type":"array","example":["[VerifiableCredential, AlumniCredential]"],"items":{"type":"string","description":"VerifiableCredential must be the first value"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreatePresentationQueryByFrame:properties:credentialQuery:items:properties:frame:properties:type:oneOf:1:example"]}]},"credentialSubject":{"type":"object","description":"This object details what claims are required for this verification workflow. Only claims included in this object will be included in the verifiable presentation, as long as you set `@explicit` to `true`.","required":["@explicit","educationalCredentialAwarded","familyName"],"properties":{"@explicit":{"type":"boolean"},"educationalCredentialAwarded":{"type":"object"},"familyName":{"type":"object"}}}}},"trustedIssuer":{"type":"array","description":"This array is used to determine what credential issuers to accept in this verification workflow. If you want to accept credentials from any issuer as long as they match the defined credential `type`, leave this array empty.","uniqueItems":true,"minItems":0,"items":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates whether this issuer is required for a credential to be accepted in this workflow."},"issuer":{"type":"string","description":"Issuer's DID, must include a BLS key type."}},"required":["required","issuer"]}}},"required":["reason","frame","trustedIssuer"]}}},"required":["type","credentialQuery"]},"CreatePresentationDidAuthTemplate":{"type":"object","title":"CreatePresentationDidAuthTemplate","properties":{"type":{"type":"string","description":"DIDAuth","example":"DIDAuth","examples":["DIDAuth"]}},"required":["type"]},"PresentationTemplateResponse":{"type":"object","properties":{"id":{"type":"string","example":"64e45290-9980-11ea-b872-f1bee5fb328f","description":"Unique identifier for this presentation template. You will need it to [create a presentation request](#operation/createPresRequestV2) based on this template. You can also use it to [retrieve](#operation/retrievePresTemplateV2), [update](#operation/updatePresTemplateV2) or [remove](#operation/removePresTemplateV2) this presentation template.","examples":["64e45290-9980-11ea-b872-f1bee5fb328f"]},"domain":{"type":"string","example":"tenant.vii.mattr.global","examples":["tenant.vii.mattr.global"]},"name":{"type":"string","example":"alumni_credential_request","examples":["alumni_credential_request"]},"query":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CreatePresentationQueryByExample"},{"$ref":"#/components/schemas/CreatePresentationQueryByFrame"},{"$ref":"#/components/schemas/CreatePresentationDidAuthTemplate"}]}}},"required":["id","domain","name","query"],"title":"PresentationTemplateResponse"},"PresentationTemplateArrayResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/PresentationTemplateResponse"}}},"title":"PresentationTemplateArrayResponse"},"CreatePresentationTemplate":{"type":"object","title":"CreatePresentationTemplate","description":"","properties":{"domain":{"type":"string","description":"Informs the wallet holder what domain is the verification request coming from. The value must match your tenant URL or your custom domain (if you have one set up). If the domain validation is unsuccessful, the wallet will not let the user proceed with the verification workflow.\n\n\nIf you set up a custom domain later, any previous templates created where the domain is your tenant URL will become invalid. You will need to change any prior templates to use the custom domain.\n"},"name":{"type":"string","description":"Unique value that is used internally to manage your templates. It must be unique across all presentation templates on your tenant, but is not shown to the holder."},"query":{"type":"array","description":"Indicates what type of query method would be used by presentation requests created from this presentation template:\n- QueryByExample: This query method uses the credential `type` and `trustedIssuer` to only accept verifiable presentations that match these parameters.\n- QueryByFrame: This query method is used to create presentation requests that only require specific claims in the verifiable presentations and thus enable selective disclosure.\n- DidAuth: This query method id used to authenticate with the tenant and provide the holder's DID.\nYou can request multiple credentials in one request by adding additional `credentialQuery` objects to the `query` array.","items":{"oneOf":[{"$ref":"#/components/schemas/CreatePresentationQueryByExample"},{"$ref":"#/components/schemas/CreatePresentationQueryByFrame"},{"$ref":"#/components/schemas/CreatePresentationDidAuthTemplate"}]}}},"required":["domain","name","query"]},"UpdatePresentationTemplate":{"title":"UpdatePresentationTemplate","allOf":[{"type":"object","properties":{"id":{"type":"string"}}},{"$ref":"#/components/schemas/CreatePresentationTemplate"}]},"CreatePresentationRequestRequest":{"type":"object","required":["challenge","templateId","did","callbackUrl"],"properties":{"challenge":{"type":"string","description":"This unique identifier will be used to validate the presentation response sent to the configured `callbackUrl`. By comparing `challenge` with the `challengeId` value in the response, you can ensure it was sent by the intended MATTR VII tenant.","example":"64e45290-9980-11ea-b872-f1bee5fb328f","examples":["64e45290-9980-11ea-b872-f1bee5fb328f"]},"did":{"type":"string","description":"This is the DID associated with the verifier. It must be available on the tenant and have a key type that is able to be used for messaging (e.g. a ed25519 key type).","example":"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr","examples":["did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr"]},"templateId":{"type":"string","description":"The `id` value of an existing presentation template that will be used to create the presentation request.","example":"64e45290-9980-11ea-b872-f1bee5fb328f","examples":["64e45290-9980-11ea-b872-f1bee5fb328f"]},"expiresTime":{"type":"number","description":"Once the time (Unix time) is reached the presentation corresponding to the challenge will not be accepted. For the purpose of testing you may wish to extend this out. Value cannot be more than 30 minutes (1800000ms) in the future, which is the maximal expiry period for a presentation request. Defaults to five minutes if no value is provided.","example":1592955632103,"examples":[1592955632103]},"callbackUrl":{"type":"string","format":"uri","description":"This is the path that you want MATTR VII to message (in the form of a JSON body) once it has received and processed the verifiable presentation from the mobile wallet holder:\n- Must be a valid URL.\n- Must use the HTTPS protocol.\n- Must not be an IP address.\n- Must be available, accept POST requests and respond with a 200 OK.\n\n\nThe callback URL will not be present directly in the signed presentation request. We highly recommend protecting the callback endpoint by including a unique identifier in the URL to create a unique callback URL for each request, which would make it hard to guess.\n\n\n\nWe recommend the callback endpoint always responds with a 404 header to any unsuccessful calls.\n","example":"https://your-website.com/api/callback","examples":["https://your-website.com/api/callback"]}},"title":"CreatePresentationRequestRequest"},"CreatePresentationRequestResponse":{"type":"object","properties":{"id":{"type":"string","description":"Presentation Request id","example":"c74128a0-9949-11ea-9554-b5a630b3c119","examples":["c74128a0-9949-11ea-9554-b5a630b3c119"]},"callbackUrl":{"type":"string","format":"uri","description":"Endpoint that will receive the Verifiable Presentation","example":"https://your-website.com/api/callback","examples":["https://your-website.com/api/callback"]},"request":{"type":"object","description":"Presentation Request Details","properties":{"id":{"type":"string","format":"uuid","description":"Presentation Request id","example":"c74128a0-9949-11ea-9554-b5a630b3c119","examples":["c74128a0-9949-11ea-9554-b5a630b3c119"]},"type":{"type":"string","format":"uri","description":"Presentation Request schema","example":"https://mattr.global/schemas/verifiable-presentation/request/QueryByExample","examples":["https://mattr.global/schemas/verifiable-presentation/request/QueryByExample"]},"from":{"type":"string","description":"Verifier DID","example":"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq","examples":["did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq"]},"created_time":{"type":"number","description":"Creation time","example":1606709582907,"examples":[1606709582907]},"expires_time":{"type":"number","description":"Expiry time","example":2594859115000,"examples":[2594859115000]},"reply_url":{"type":"string","description":"Endpoint that will receive the Verifiable Presentation","example":"https://your-website.com/api/callback","examples":["https://your-website.com/api/callback"]},"reply_to":{"type":"array","description":"Verifier DID","items":{"type":"string","example":"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq","examples":["did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq"]}},"body":{"description":"Definition of what type of Credential is being requested","allOf":[{"$ref":"#/components/schemas/PresentationTemplateResponse"},{"type":"object","properties":{"challenge":{"type":"string","format":"uuid","description":"Challenge to match the response to a request","example":"e1b35ae0-9e0e-11ea-9bbf-a387b27c9e60","examples":["e1b35ae0-9e0e-11ea-9bbf-a387b27c9e60"]}}}]}}},"didcommUri":{"type":"string","format":"uri","description":"A DIDComm URI that is pointing to a shortened presentation request JWS message"}},"title":"CreatePresentationRequestResponse"},"VerifiablePresentation":{"description":"","type":"object","x-examples":{},"title":"VerifiablePresentation","properties":{"presentation":{"type":"object","required":["@context","type","verifiableCredential","id","holder","proof"],"properties":{"@context":{"type":"array","items":{"type":"object"}},"type":{"type":"array","items":{"type":"object"}},"verifiableCredential":{"type":"array","uniqueItems":true,"minItems":1,"items":{"$ref":"#/components/schemas/VerifiableCredential"}},"id":{"type":"string","minLength":1},"holder":{"type":"string","minLength":1},"proof":{"type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"created":{"type":"string","minLength":1},"challenge":{"type":"string","minLength":1},"domain":{"type":"string","minLength":1},"jws":{"type":"string","minLength":1},"proofPurpose":{"type":"string","minLength":1},"verificationMethod":{"type":"string","minLength":1}},"required":["type","created","challenge","domain","jws","proofPurpose","verificationMethod"]}}}},"challenge":{"type":"string","example":"3182bdea-63d9-11ea-b6de-3b7c1404d57f","examples":["3182bdea-63d9-11ea-b6de-3b7c1404d57f"]},"domain":{"type":"string","example":"example.com","examples":["example.com"]}},"required":["presentation"]},"VerifyPresentation":{"title":"VerifyPresentation","type":"object","properties":{"verified":{"type":"boolean","description":"Set to `true` if the presentation passed all checks, and `false` otherwise."},"reason":{"type":"string","description":"When `verified` is `false`, details why the verification had failed."}},"required":["verified"]},"WebSemanticCredentialConfiguration":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Insert a meaningful name for the credential. This string is displayed on the top part of the credential in the holder's digital wallet. It is recommended to limit this value to 18 characters as any additional characters are not displayed on the credential.","example":"Course credential","examples":["Course credential"]},"description":{"type":"string","maxLength":1024,"description":"Insert a meaningful description for the credential. This string is displayed below the name field on the credential in the holder's digital wallet. It is recommended to limit this value to 38 characters as any additional characters are not displayed on the credential.","example":"This credential shows that the person has attended a course.","examples":["This credential shows that the person has attended a course."]},"type":{"description":"Used to differentiate between different JSON credentials configurations on your tenant. Thus, its value must:\n- Be unique across all JSON credentials configurations on your tenant.\n- Not be `VerifiableCredential`.","type":"string","minLength":1,"maxLength":1024,"example":"CourseCredential","examples":["CourseCredential"]},"additionalTypes":{"description":"Additional credential types that can be referenced. Each entry must be 1-1024 characters long, with no whitespaces allowed.","type":"array","example":["AlumniCredential","EducationCredential"],"items":{"type":"string","maxLength":1024},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticCredentialConfiguration:properties:additionalTypes:example"]},"contexts":{"type":"array","description":"Additional JSON-LD contexts to be included in the credential. As part of the credential issuance MATTR VII will auto-inject the following contexts, which reference the W3C Verifiable Credential definitions:\n- https://www.w3.org/2018/credentials/v1\n- https://mattr.global/contexts/vc-extensions/v2\n- https://w3id.org/vc-revocation-list-2020/v1\nIf you require introducing a different context for your production implementation, please [contact us](https://mailto:dev-support@mattr.global). Referenced contexts must be whitelisted or credential issuance will fail.","example":["https://optionalschema.example/"],"items":{"type":"string","description":"Must be an HTTPS URL."},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:WebSemanticCredentialConfiguration:properties:contexts:example"]},"issuer":{"type":"object","description":"Issuer details and branding for issued credentials. Refer to this [video](https://www.youtube.com/watch?v=Tu8ApHBWG90) to learn more about branding best practices.","required":["name"],"properties":{"name":{"type":"string","description":"Insert a meaningful name to indicate the issuer. This string is used when the credential is offered to the holder. It is also used on the bottom part of the credential when `logoURL` is not provided.","example":"ABC University","examples":["ABC University"]},"logoUrl":{"type":"string","description":"Insert a URL for a logo that is displayed on the bottom part of the credential. If no logo is provided, the issuer's `name` and `iconURL` are used instead. The logo must meet the following criteria:\n- URL must be publicly available.\n- Must be 140x42 px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended. Raster images, whilst supported, are currently displayed at 1x resolution and may look pixelated on some devices.\n- Transparencies are allowed for **svg** or **png** images.\n- If no logo is provided, the first letter of the issuer name is displayed instead.\n- The recommended maximum size is 50 KB.","example":"https://example.edu/img/logo.png","examples":["https://example.edu/img/logo.png"]},"iconUrl":{"type":"string","example":"https://example.edu/img/icon.png","description":"Insert a URL for an icon that is displayed next to the issuer's name when the credential is offered to the holder. It is also displayed next to the issuer's name on the bottom part of the credential when `logoURL` is not provided. When `iconURL` is not provided, the first letter from `name` is used instead. The icon must meet the following criteria:\n- URL must be publicly available.\n- Must be 32x32 px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended. Raster images, whilst supported, are currently displayed at 1x resolution and may look pixelated on some devices.\n- Transparencies are allowed for svg or png images.\n- The recommended maximum size is 15 KB.","examples":["https://example.edu/img/icon.png"]}}},"proofType":{"description":"This is an _optional_ field which defines the cryptographic algorithm used to sign the credential. The credential Issuer's DID must contain a key that supports the corresponding signing capability. If no `proofType` is provided, the credential will be signed using the key that is available in the Issuer's DID:\n- If a `Bls12381G2` key is available, the credential will be signed with a `BbsSignature2022` proof. Credentials signed with this proof type support selective disclosure.\n- If a `Bls12381G2` key is unavailable and a `Ed25519` key is available, the credential will be signed with a `Ed25519Signature2018` proof. Credentials signed with this proof type do not support selective disclosure.\n- If none of the two suitable keys are available, the request will be rejected and the credential will not be created.","type":"string","enum":["Ed25519Signature2018","BbsSignature2022"],"example":"Ed25519Signature2018","examples":["Ed25519Signature2018"]},"credentialBranding":{"type":"object","description":"Additional branding that will be applied to issued credentials. Refer to this [video](https://www.youtube.com/watch?v=Tu8ApHBWG90) to learn more about branding best practices.","properties":{"backgroundColor":{"type":"string","example":"#B00AA0","description":"Insert a color hex code to use for the credential background color in the holder's digital wallet.","examples":["#B00AA0"]},"watermarkImageUrl":{"type":"string","example":"https://example.edu/img/watermark.png","description":"Insert a URL for a watermark image to be included as a pattern on the credential in the holder's digital wallet:\n- URL must be publicly available.\n- Must be 245x150px in size.\n- **svg**, **png** and **jpg** files are supported, but **svg** is recommended.\n- If no watermark image is provided, a wave pattern is applied to the credentials by default.\n- The recommended maximum size is 150 KB.","examples":["https://example.edu/img/watermark.png"]}}},"claimMappings":{"$ref":"#/components/schemas/credentialConfigurationClaimMappings"},"persist":{"type":"boolean","default":false,"description":"When set to `true`, both the issued credential and its metadata are stored in the credential registry. When set to `false` (default) only the following metadata is stored:\n- `id`\n- `tag`\n- `credentialStatus`\n- `issuanceDate`"},"revocable":{"type":"boolean","default":true,"description":"When set to `true` (default), the created credential can later be revoked. When set to `false`, the credential cannot be revoked. When set to `true`, `https://w3id.org/vc-revocation-list-2020/v1` is injected into the credential `@context` object when it is issued. This references the JSON-LD definition of the `credentialStatus` object used to manage revocation status."},"claimSourceId":{"type":"string","format":"uuid","description":"References the unique identifier of a claims source that can be used to retrieve claims and include them in the issued credential."},"expiresIn":{"type":"object","description":"Used to determine when will issued credentials expire. Can include any combination of `years`, `months`, `weeks`, `days`, `hours`, `minutes` and `seconds`.","properties":{"years":{"type":"number"},"months":{"type":"number","example":3,"examples":[3]},"weeks":{"type":"number"},"days":{"type":"number"},"hours":{"type":"number"},"minutes":{"type":"number"},"seconds":{"type":"number"}}}}},"WebSemanticCredentialConfigurationResponse":{"required":["id","name","type","issuer","persist","revocable"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Credential Configuration ID","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]}}},{"$ref":"#/components/schemas/WebSemanticCredentialConfiguration"}],"title":"WebSemanticCredentialConfigurationResponse"},"GetWebSemanticCredentialConfigurationsResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebSemanticCredentialConfigurationResponse"}}},"title":"GetWebSemanticCredentialConfigurationsResponse"},"WebSemanticCredentialConfigurationRequest":{"required":["name","type","issuer"],"allOf":[{"$ref":"#/components/schemas/WebSemanticCredentialConfiguration"}],"title":"CreateWebSemanticCredentialConfigurationRequest"},"IosHolderApplication":{"type":"object","title":"iOS Holder Application","description":"Configuration for a holder iOS application.","properties":{"type":{"type":"string","enum":["ios"],"description":"Defines the holder application type."},"bundleId":{"type":"string","description":"Bundle ID of the iOS app.","example":"com.example-holder-ios-application","examples":["com.example-holder-ios-application"]},"teamId":{"$ref":"#/components/schemas/teamId"},"maxTimeOfflineInSecs":{"type":"integer","minimum":86400,"default":604800,"maximum":2592000,"description":"Maximum number of seconds the SDK can operate offline before requiring a new license token.\n- Cannot be less than 1 day (86400 seconds).\n- Cannot exceed 30 days (2592000 seconds).\n- Default is 7 days (604800 seconds).\n","example":86400,"examples":[86400]},"appAttest":{"type":"object","description":"App Attest configuration for the iOS holder application.","properties":{"required":{"type":"boolean","description":"Whether App Attest is required during registration and token renewal. \n- When `true`, the holder application instance must provide a valid attestation during registration and token renewal, and MATTR VII will verify the attestation with Apple’s App Attest service to ensure the legitimacy of the request.\n- When `false`, the holder application instance can register and renew tokens using just an authentication assertion without attestation.\n","example":true,"examples":[true]},"environment":{"type":"string","enum":["development","production"],"description":"The App Attest environment. Apple recommends using the development environment for testing and switching to production for apps in distribution. MATTR VII will verify attestations with the corresponding Apple environment based on this configuration.","example":"production","examples":["production"]}},"required":["required","environment"]}},"required":["bundleId","type","teamId"]},"AndroidHolderApplication":{"type":"object","title":"Android Holder Application","description":"Configuration for a holder Android application.","properties":{"type":{"type":"string","enum":["android"],"description":"Defines the holder application type."},"packageName":{"type":"string","description":"Package name of the Android application that will interact with this holder application.","example":"com.example-holder-android-application","examples":["com.example-holder-android-application"]},"packageSigningCertificateThumbprints":{"type":"array","description":"- SHA-256 hex-encoded fingerprints of the signing key certificates that were used to sign the Android Package Kit (APK) or app bundle.\n- This ensures the holder tenant only accepts requests from known and trusted applications.\n- Any verification requests will fail if the certificate thumbprint does not match. Refer to [Android app signing](https://learn.mattr.global/docs/verification/signing-verification-requests/android-app-signing) for more information.\n","items":{"type":"string"},"example":["1232584B6F6A892D356899FB9576C5F226A179E6199F2B7A1D837B5C234C5A8E"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AndroidHolderApplication:properties:packageSigningCertificateThumbprints:example"]},"maxTimeOfflineInSecs":{"type":"integer","minimum":86400,"default":604800,"maximum":2592000,"description":"Maximum number of seconds the SDK can operate offline before requiring a new license token.\n- Cannot be less than 1 day (86400 seconds).\n- Cannot exceed 30 days (2592000 seconds).\n- Default is 7 days (604800 seconds).\n","example":86400,"examples":[86400]},"keyAttestation":{"type":"object","description":"Key Attestation configuration for the Android holder application.","properties":{"required":{"type":"boolean","description":"$19d","example":true,"examples":[true]}},"required":["required"]}},"required":["type","packageName","packageSigningCertificateThumbprints"]},"HolderApplicationResponse":{"type":"object","title":"HolderApplicationResponse","description":"Holder application response.","properties":{"id":{"type":"string","description":"Unique identifier of the holder application.","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"name":{"type":"string","description":"Unique name to identify the holder application.","example":"Example Holder Application","examples":["Example Holder Application"]},"clientId":{"type":"string","description":"OAuth 2.0 `client_id` value associated with the holder application for client attestation. Included as the `sub` claim in attestation JWTs.","example":"example-wallet-client","examples":["example-wallet-client"]}},"required":["id","name","clientId"],"oneOf":[{"$ref":"#/components/schemas/IosHolderApplication"},{"$ref":"#/components/schemas/AndroidHolderApplication"}]},"HolderApplicationRequest":{"type":"object","description":"Configuration for a registered holder application.","properties":{"name":{"type":"string","description":"Unique name to identify the holder application.","example":"My Holder Application","examples":["My Holder Application"]},"clientId":{"type":"string","description":"OAuth 2.0 `client_id` value that the holder application uses when requesting client attestations. This value is included as the `sub` claim in attestation JWTs and must match the `client_id` configured on the Authorization Server.","example":"example-wallet-client","examples":["example-wallet-client"]}},"required":["name","clientId"],"oneOf":[{"$ref":"#/components/schemas/IosHolderApplication"},{"$ref":"#/components/schemas/AndroidHolderApplication"}]},"HolderApplicationInstanceResponse":{"type":"object","title":"Holder Application Instance Response","description":"Holder application instance response.","properties":{"id":{"type":"string","description":"Unique identifier corresponding to the registered holder application instance.","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"appAttestationType":{"type":"string","description":"The type of attestation used during registration of the holder application instance.","enum":["none","app_attestation","key_attestation"],"example":"key_attestation","examples":["key_attestation"]},"registeredAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the holder application instance was registered.","example":"2023-10-05T14:48:00.000Z","examples":["2023-10-05T14:48:00.000Z"]},"licenseExpiresAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the license for the holder application instance expires.","example":"2024-10-05T14:48:00.000Z","examples":["2024-10-05T14:48:00.000Z"]},"lastAttestedAt":{"type":"string","format":"date-time","description":"Timestamp indicating when the holder application instance was last attested.","example":"2023-12-01T10:30:00.000Z","examples":["2023-12-01T10:30:00.000Z"]},"externalReferenceId":{"type":"string","description":"Optional external reference identifier associated with the holder application instance.","example":"external-ref-12345","examples":["external-ref-12345"]},"deviceDetails":{"type":"object","description":"Details about the device on which the holder application instance is registered.","properties":{"deviceModel":{"type":"string","description":"Model of the device.","example":"iPhone 12","examples":["iPhone 12"]},"deviceMake":{"type":"string","description":"Manufacturer of the device.","example":"Apple","examples":["Apple"]},"osVersion":{"type":"string","description":"Operating system version of the device.","example":"iOS 14.4","examples":["iOS 14.4"]}},"required":["deviceModel","deviceMake","osVersion"]},"sdkDetails":{"type":"object","description":"Details about the SDK used by the holder application instance.","properties":{"sdkVersion":{"type":"string","description":"Version of the SDK.","example":"1.2.3","examples":["1.2.3"]}},"required":["sdkVersion"]}}},"HolderCaResponse":{"type":"object","description":"A holder root CA certificate.","required":["id","active","certificatePem","certificateFingerprint","certificateData","isManaged"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this holder root CA certificate.","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"active":{"type":"boolean","description":"Whether this root is currently active. Only one root can be active per tenant at a time.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"The root CA certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 fingerprint (hex) of the root certificate.","example":"a3b2c1d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890","examples":["a3b2c1d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890"]},"certificateData":{"type":"object","description":"Parsed metadata extracted from the certificate.","required":["commonName","country","notAfter","notBefore"],"properties":{"commonName":{"type":"string","description":"Subject common name of the root certificate.","example":"Example Tenant Wallet Attestation Root","examples":["Example Tenant Wallet Attestation Root"]},"country":{"type":"string","description":"Subject country (ISO 3166-1 alpha-2).","example":"NZ","examples":["NZ"]},"notBefore":{"type":"string","format":"date-time","description":"Certificate validity period start.","example":"2026-04-06T00:00:00.000Z","examples":["2026-04-06T00:00:00.000Z"]},"notAfter":{"type":"string","format":"date-time","description":"Certificate validity period end. For managed roots this is fixed at 10 years from `notBefore` and cannot be customised. For unmanaged roots this reflects the validity period of the customer-supplied certificate.","example":"2036-04-06T00:00:00.000Z","examples":["2036-04-06T00:00:00.000Z"]}}},"isManaged":{"type":"boolean","description":"Whether the private key for this root certificate is managed by MATTR VII (`true`) or externally by the customer (`false`).","example":true,"examples":[true]}}},"HolderCaCreateRequestManaged":{"title":"Managed holder root CA certificate","type":"object","description":"Payload for creating a managed holder root CA certificate. MATTR VII generates the P-256 key pair and self-signed certificate on the customer's behalf. The root is always created inactive — activate it via `PUT /v1/holder/certificates/ca/{certificateId}`.","properties":{"commonName":{"type":"string","description":"Common name of the holder root CA certificate. Must be a valid `PrintableString` and cannot be an empty string if provided. If omitted, defaults to `\"{tenantDomain} Wallet Attestation\"` — the tenant's custom domain is used if configured and verified, otherwise the tenant subdomain.\n","example":"Example Tenant Wallet Attestation Root","examples":["Example Tenant Wallet Attestation Root"]},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code for the root certificate's subject. If omitted, a tenant-level default is used.\n","example":"NZ","examples":["NZ"]}}},"HolderCaCreateRequestUnmanaged":{"title":"Unmanaged holder root CA certificate","type":"object","description":"Payload for creating an unmanaged holder root CA certificate from an externally-managed PEM. `commonName` and `country` are extracted from the certificate and must not be provided. The root is always created inactive — activate it via `PUT /v1/holder/certificates/ca/{certificateId}`.","required":["certificatePem"],"properties":{"certificatePem":{"type":"string","description":"Externally-managed root CA certificate in PEM format. Must be a valid, self-signed, non-expired X.509 certificate with `cA=true` basic constraints and `keyCertSign` + `cRLSign` key usage.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]}}},"HolderCaUpdateRequest":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Whether the holder root CA certificate is active. Setting `true` deactivates all other roots for the tenant (single-active constraint).","example":true,"examples":[true]}}},"WalletAttestationSignerResponse":{"title":"Wallet attestation signer with certificate","type":"object","description":"A wallet attestation signer with a signed certificate. For managed signers, the certificate is auto-provisioned. For unmanaged signers, the certificate was uploaded via PUT.","required":["id","caId","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this wallet attestation signer.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"caId":{"type":"string","format":"uuid","description":"Identifier of the holder root CA certificate this signer is issued from.","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"active":{"type":"boolean","description":"Whether this signer is currently active. Only active signers with a valid certificate are used to sign wallet attestation JWTs.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"The signer certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 fingerprint (hex) of the signer certificate.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","description":"Parsed metadata extracted from the signer certificate.","required":["commonName","country","notAfter","notBefore"],"properties":{"commonName":{"type":"string","description":"Subject common name of the signer certificate.","example":"example.com Wallet Attestation Signer","examples":["example.com Wallet Attestation Signer"]},"country":{"type":"string","description":"Subject country (ISO 3166-1 alpha-2).","example":"NZ","examples":["NZ"]},"notBefore":{"type":"string","format":"date-time","description":"Certificate validity period start.","example":"2026-04-06T00:00:00.000Z","examples":["2026-04-06T00:00:00.000Z"]},"notAfter":{"type":"string","format":"date-time","description":"Certificate validity period end. Managed signers default to 365 days from `notBefore`, clamped to the parent root's `notAfter`.","example":"2027-04-06T00:00:00.000Z","examples":["2027-04-06T00:00:00.000Z"]}}}}},"CreateWalletAttestationSignerResponse":{"title":"Wallet attestation signer without certificate","type":"object","description":"A wallet attestation signer prior to certificate upload. Includes the Certificate Signing Request (CSR) that must be externally signed.","required":["id","caId","csrPem","active"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this wallet attestation signer.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"caId":{"type":"string","format":"uuid","description":"Identifier of the holder root CA certificate this signer is issued from.","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"csrPem":{"type":"string","description":"X.509 Certificate Signing Request in PEM format. Sign this externally with the parent root and upload the resulting certificate via `PUT /v1/holder/certificates/wallet-attestation-signers/{certificateId}`.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIC5zCCAc8CAQAwgaExC...\n-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----\nMIIC5zCCAc8CAQAwgaExC...\n-----END CERTIFICATE REQUEST-----"]},"active":{"type":"boolean","description":"Always `false` prior to certificate upload.","enum":[false],"example":false,"examples":[false]}}},"WalletAttestationSignerCreateRequest":{"type":"object","required":["caId"],"properties":{"caId":{"type":"string","format":"uuid","description":"Identifier of the holder root CA certificate this signer will be issued from.\n- Must be an unmanaged root. Managed root signers are auto-provisioned and cannot be created via this endpoint.\n","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]}}},"WalletAttestationSignerUpdateRequest":{"type":"object","description":"Payload for updating a wallet attestation signer. Can be used to upload the signed certificate PEM (first-time upload only) and/or toggle the `active` flag.\n","properties":{"active":{"type":"boolean","description":"Whether the wallet attestation signer is active. Only signers with an uploaded certificate PEM can be activated.\n\nMultiple active signers may exist for the same root (e.g. during a rotation where a new signer has been created but the old one is still trusted by relying parties). When more than one active signer exists for the active root, attestation signing always selects the most recently created one.\n","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"Signed certificate PEM for an unmanaged signer whose CSR has been externally signed. Must match the signer's CSR public key and be signed by the parent root certificate. Other certificate properties (key usage, extensions, validity period) are inherited from the CSR or set by the issuing CA.\n\nThis field is immutable after the first upload — subsequent requests with `certificatePem` will return `400 CannotOverrideCertificatePem`.\n","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]}}},"UnauthorizedError":{"title":"UnauthorizedError","description":"The request does not have a valid Authorization header","type":"string","example":"Unauthorized","examples":["Unauthorized"]},"CredentialResponseEncryption":{"type":"object","description":"JSON object containing details for encrypting the issued credential in the response.","required":["jwk","enc"],"properties":{"jwk":{"type":"object","description":"JSON Web Key (JWK) containing the public key to use for encrypting the issued credential.","required":["kty","crv","alg","x","y"],"properties":{"kty":{"type":"string","example":"EC","examples":["EC"]},"kid":{"type":"string","example":"kid","examples":["kid"]},"use":{"type":"string","example":"enc","examples":["enc"]},"crv":{"type":"string","example":"P-256","examples":["P-256"]},"alg":{"type":"string","example":"HPKE-7","examples":["HPKE-7"]},"x":{"type":"string","example":"YO4epjifD-KWeq1sL2tNmm3...","examples":["YO4epjifD-KWeq1sL2tNmm3..."]},"y":{"type":"string","example":"Hekpm0zfK7C-YccH5iBjcIXg...","examples":["Hekpm0zfK7C-YccH5iBjcIXg..."]}}},"enc":{"type":"string","description":"Encryption algorithm to use when encrypting the issued credential.","example":"A256GCM","examples":["A256GCM"]}}},"ldpvcIssueCredentialRequest":{"title":"JSON","type":"object","required":["credential_configuration_id"],"properties":{"credential_configuration_id":{"type":"string","description":"Credential configuration identifier."},"proofs":{"type":"object","description":"JSON object containing proof of possession of the key material the issued Credential shall be bound to.","properties":{"jwt":{"type":"array","items":{"type":"string"},"description":"The JSON Web Token (JWT) containing the proof data."}}},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"cwtIssueCredentialRequest":{"title":"CWT","type":"object","required":["credential_configuration_id"],"properties":{"credential_configuration_id":{"type":"string","description":"Credential configuration identifier."},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"cwtvcIssueCredentialRequest":{"title":"Semantic CWT","type":"object","required":["credential_configuration_id"],"properties":{"credential_configuration_id":{"type":"string","description":"Credential configuration identifier."},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"msomdocIssueCredentialRequest":{"title":"mDoc","type":"object","required":["credential_configuration_id","proofs"],"properties":{"credential_configuration_id":{"type":"string","description":"Credential configuration identifier."},"proofs":{"type":"object","description":"JSON object containing proof of possession of the key material the issued Credential shall be bound to.","properties":{"jwt":{"type":"array","items":{"type":"string"},"description":"The JSON Web Token (JWT) containing the proof data."}}},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"deprecatedLdpvcIssueCredentialRequest":{"title":"JSON (Deprecated)","type":"object","required":["format","credential_definition"],"properties":{"format":{"type":"string","description":"Credential format, always `ldp_vc` for JSON credentials.","enum":["ldp_vc"]},"credential_definition":{"type":"object","properties":{"type":{"type":"array","description":"Credential types, as defined in the credential schema.","items":{"type":"string"}},"@context":{"type":"array","description":"Credential contexts, as defined in the credential schema.","items":{"type":"string"}}},"required":["type","@context"]},"proof":{"type":"object","description":"JSON object containing proof of possession of the key material the issued Credential shall be bound to.","properties":{"proof_type":{"type":"string","description":"Proof type - must be `jwt`.","enum":["jwt"]},"jwt":{"type":"string","description":"The JSON Web Token (JWT) containing the proof data."}}},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"deprecatedCwtIssueCredentialRequest":{"title":"CWT (Deprecated)","type":"object","required":["format","type"],"properties":{"format":{"type":"string","description":"Credential format, always `cwt` for CWT credentials.","example":"cwt","enum":["cwt"],"examples":["cwt"]},"type":{"type":"string"},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"deprecatedCwtvcIssueCredentialRequest":{"title":"Semantic CWT (Deprecated)","type":"object","required":["format","types"],"properties":{"format":{"type":"string","description":"Credential format, always `cwt_vc` for Semantic CWT credentials.","enum":["cwt_vc"]},"types":{"type":"array","items":{"type":"string"}},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"deprecatedMsomdocIssueCredentialRequest":{"title":"mDoc (Deprecated)","type":"object","required":["format","doctype"],"properties":{"format":{"type":"string","description":"Credential format, always `mso_mdoc` for mDocs.","enum":["mso_mdoc"]},"doctype":{"type":"string","description":"The document type identifier for the credential, as defined in ISO/IEC 18013-5:2021.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"proof":{"type":"object","description":"JSON object containing proof of possession of the key material the issued credential shall be bound to.","properties":{"proof_type":{"description":"Proof type - must be `jwt`.","type":"string","enum":["jwt"]},"jwt":{"type":"string","description":"A single JSON Web Token (JWT) containing the proof data.\n\nThe JWT header must include the following elements:\n- `typ` (String): Must be `openid4vci-proof+jwt`.\n- `alg` (String): Must be `ES256`.\n- `jwk` (Object): JWK object containing the key material the new credential shall be bound to.\n\nThe JWT payload must include the following elements:\n- `iss` (String): Must be the `client_id` of the client making the credential request.\n- `aud` (String): Must be the `credential_issuer` URL of the issuer.\n- `iat` (NumericDate): Must be the time at which the proof was issued using the syntax defined in RFC 7519. The value must not be older than 5 minutes.\n\nThe following JWT payload elements are optional:\n- `exp` (NumericDate): Must be the time at which the proof expires. When provided, must not be in the past.\n- `jti` (String): A unique identifier for the JWT.\n"}}},"credential_response_encryption":{"$ref":"#/components/schemas/CredentialResponseEncryption"}}},"ldpvcSupportedCredentialResponse":{"title":"JSON","type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/VerifiableCredential"}],"description":"The verifiable credential that was issued."}}}}}},"msomdocIssueCredentialResponse":{"title":"mDoc","type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"credential":{"type":"string","description":"The verifiable credential that was issued."}}}}}},"cwtvcIssueCredentialResponse":{"title":"Semantic CWT","type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"credential":{"type":"string","description":"The verifiable credential that was issued."},"pdf":{"type":"string","description":"A base64-encoded PDF representation of the issued credential, if requested."}}}}}},"cwtIssueCredentialResponse":{"title":"CWT","type":"object","required":["credentials"],"properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"credential":{"type":"string","description":"The verifiable credential that was issued."},"pdf":{"type":"string","description":"A base64-encoded PDF representation of the issued credential, if requested."}}}}}},"deprecatedLdpvcSupportedCredentialResponse":{"title":"JSON (Deprecated)","type":"object","required":["credential","format"],"properties":{"credential":{"allOf":[{"$ref":"#/components/schemas/VerifiableCredential"}],"description":"The verifiable credential that was issued."},"format":{"type":"string","description":"The format of the issued credential.","example":"ldp_vc","examples":["ldp_vc"]}}},"deprecatedMsomdocIssueCredentialResponse":{"title":"mDoc (Deprecated)","type":"object","required":["credential","format"],"properties":{"credential":{"type":"string","description":"The mobile credential that was issued."},"format":{"type":"string","description":"The format of the issued credential.","example":"mso_mdoc","examples":["mso_mdoc"]}}},"deprecatedCwtvcIssueCredentialResponse":{"title":"Semantic CWT (Deprecated)","type":"object","required":["credential","format"],"properties":{"credential":{"type":"string","description":"The compact semantic credential that was issued."},"format":{"type":"string","description":"The format of the issued credential.","example":"cwt_vc","examples":["cwt_vc"]},"pdf":{"type":"string","description":"A base64-encoded PDF representation of the issued credential, if requested."}}},"deprecatedCwtIssueCredentialResponse":{"title":"CWT (Deprecated)","type":"object","required":["credential","format"],"properties":{"credential":{"type":"string","description":"The compact credential that was issued."},"format":{"type":"string","description":"The format of the issued credential.","example":"cwt","examples":["cwt"]},"pdf":{"type":"string","description":"A base64-encoded PDF representation of the issued credential, if requested."}}},"CryptographicBindingMethodsSupported":{"title":"Cryptographic Binding Methods Supported","type":"array","items":{"type":"string"},"description":"Array of case-sensitive strings indicating supported cryptographic key binding representations for the issued credential.","example":["did:key","mso"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CryptographicBindingMethodsSupported:example"]},"CryptographicSuitesSupported":{"title":"Cryptographic Suites Supported","type":"array","items":{"type":"string"},"description":"Array of case-sensitive strings indicating supported cryptographic suites for the issued credential.","example":["Ed25519Signature2018","ES256"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CryptographicSuitesSupported:example"]},"ldpvcSupportedCredential":{"type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"type":"object"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"cryptographic_suites_supported":{"$ref":"#/components/schemas/CryptographicSuitesSupported"}}},"cwtvcSupportedCredential":{"type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"credentialSubject":{"type":"object"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"cryptographic_suites_supported":{"$ref":"#/components/schemas/CryptographicSuitesSupported"}}},"cwtSupportedCredential":{"type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"type":{"type":"string"},"claims":{"type":"object"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"cryptographic_suites_supported":{"$ref":"#/components/schemas/CryptographicSuitesSupported"}}},"msomdocSupportedCredential":{"type":"object","properties":{"format":{"type":"string","description":"Credential format. Always `mso_mdoc` for mDocs.","example":"mso_mdoc","enum":["mso_mdoc"],"examples":["mso_mdoc"]},"scope":{"type":"string"},"doctype":{"type":"string","description":"The document type identifier for the credential, as defined in ISO/IEC 18013-5:2021.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"id":{"type":"string"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"cryptographic_suites_supported":{"$ref":"#/components/schemas/CryptographicSuitesSupported"},"claims":{"type":"object"},"display":{"description":"Display information for issued credentials.","type":"array","items":{"type":"object"},"example":{"name":"Driver's License","description":"Official state-issued driver's license.","background_color":"#FFFFFF"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:msomdocSupportedCredential:properties:display:example"]}}},"CredentialSigningAlgValuesSupported":{"title":"Credential Signing Algorithm Values Supported","type":"array","items":{"type":"string"},"description":"Array of algorithm identifiers indicating the signing algorithms supported by the issuer for issued credentials.","example":["Ed25519Signature2018","BbsSignatureProof2022",-7],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CredentialSigningAlgValuesSupported:example"]},"ProofTypesSupported":{"title":"Proof Types Supported","type":"object","description":"Describes specifics of the key proof(s) that the credential issuer supports. Contains a list of name/value pairs, where each name is a unique identifier of the supported proof type(s). If absent, the wallet is not required to supply proofs when requesting this credential.","properties":{"jwt":{"type":"object","properties":{"proof_signing_alg_values_supported":{"type":"array","items":{"type":"string"}},"key_attestations_required":{"type":"object","properties":{"key_storage":{"type":"array","items":{"type":"string"}},"user_authentication":{"type":"array","items":{"type":"string"}}}}}}},"example":{"jwt":{"proof_signing_alg_values_supported":["EdDSA"],"key_attestations_required":{"key_storage":["iso_18045_moderate"],"user_authentication":["iso_18045_moderate"]}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ProofTypesSupported:example"]},"CredentialDisplay":{"title":"Credential Display","description":"Array of objects that contain display properties of the issued credential for a certain language.","type":"array","items":{"type":"object","example":[{"name":"Driver's License","logo":{"uri":"https://example.com/logo.png","alt_text":"Example Logo"},"locale":"en-US","background_color":"#FFFFFF","text_color":"#000000"}],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CredentialDisplay:items:example"]}},"ClaimDisplay":{"title":"Claim Display","type":"object","properties":{"name":{"type":"string"},"locale":{"type":"string"}},"example":{"name":"First Name","locale":"en-US"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ClaimDisplay:example"]},"CredentialClaim":{"title":"Credential Claim","description":"Array of objects that describe the claims included in the credential. Each object contains the path to the claim in the credential, whether the claim is mandatory, and its display information.","type":"object","properties":{"path":{"type":"array","items":{"type":"string"}},"mandatory":{"type":"boolean"},"display":{"description":"Each object in this array contains display properties of a certain claim in the credential for a certain language.","type":"array","items":{"$ref":"#/components/schemas/ClaimDisplay"}}},"example":{"path":["firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CredentialClaim:example"]},"CredentialMetadata":{"title":"Credential Metadata","type":"object","description":"Display information for issued credentials.","properties":{"display":{"$ref":"#/components/schemas/CredentialDisplay"},"claims":{"type":"array","items":{"$ref":"#/components/schemas/CredentialClaim"}}}},"ldpvcCredentialConfigurationSupported":{"title":"JSON Credential","type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"credential_definition":{"description":"The credential definition as defined in the credential schema.","type":"object","properties":{"type":{"type":"array","items":{"type":"string"}},"@context":{"type":"array","items":{"type":"string"}}}},"credential_signing_alg_values_supported":{"$ref":"#/components/schemas/CredentialSigningAlgValuesSupported"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"proof_types_supported":{"$ref":"#/components/schemas/ProofTypesSupported"},"credential_metadata":{"$ref":"#/components/schemas/CredentialMetadata"}},"example":{"format":"ldp_vc","id":"2cdb2c15-39a7-4556-abab-4515ce2d831b","scope":"ldp_vc:TestCredential","credential_definition":{"@context":["https://www.w3.org/2018/credentials/v1","https://schema.org"],"type":["VerifiableCredential","TestCredential"]},"credential_signing_alg_values_supported":["Ed25519Signature2018","BbsSignatureProof2022"],"cryptographic_binding_methods_supported":["did:key"],"proof_types_supported":{"jwt":{"proof_signing_alg_values_supported":["EdDSA"]}},"credential_metadata":{"display":[{"name":"Test Credential","logo":{"uri":"https://example.com/logo.png","alt_text":"Example Logo"},"locale":"en-US","background_color":"#FFFFFF","text_color":"#000000"}],"claims":[{"path":["credentialSubject","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ldpvcCredentialConfigurationSupported:example"]},"cwtvcCredentialConfigurationSupported":{"title":"CWT Credential","type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"types":{"type":"array","items":{"type":"string"}},"credential_signing_alg_values_supported":{"$ref":"#/components/schemas/CredentialSigningAlgValuesSupported"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"credential_metadata":{"$ref":"#/components/schemas/CredentialMetadata"}},"example":{"format":"cwt_vc","id":"3dfe1c4a-5b6c-4e2f-9f3a-2b1c4d5e6f7g","scope":"cwt_vc:TestCredential","types":["VerifiableCredential","TestCredential"],"cryptographic_binding_methods_supported":[],"credential_signing_alg_values_supported":[-7],"credential_metadata":{"claims":[{"path":["vc","credentialSubject","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:cwtvcCredentialConfigurationSupported:example"]},"cwtCredentialConfigurationSupported":{"title":"Semantic CWT Credential","type":"object","properties":{"format":{"type":"string"},"id":{"type":"string"},"scope":{"type":"string"},"type":{"type":"string"},"credential_signing_alg_values_supported":{"$ref":"#/components/schemas/CredentialSigningAlgValuesSupported"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"credential_metadata":{"$ref":"#/components/schemas/CredentialMetadata"}},"example":{"format":"cwt","id":"b068c060-cc72-4758-9526-92d29edb821f","scope":"cwt:TestCredential","type":"TestCredential","cryptographic_binding_methods_supported":[],"credential_signing_alg_values_supported":[-7],"credential_metadata":{"claims":[{"path":["firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:cwtCredentialConfigurationSupported:example"]},"msomdocCredentialConfigurationSupported":{"title":"mDoc","type":"object","properties":{"format":{"type":"string"},"doctype":{"type":"string","description":"The document type identifier for the credential, as defined in ISO/IEC 18013-5:2021.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"scope":{"type":"string"},"id":{"type":"string"},"credential_signing_alg_values_supported":{"$ref":"#/components/schemas/CredentialSigningAlgValuesSupported"},"cryptographic_binding_methods_supported":{"$ref":"#/components/schemas/CryptographicBindingMethodsSupported"},"proof_types_supported":{"$ref":"#/components/schemas/ProofTypesSupported"},"credential_metadata":{"$ref":"#/components/schemas/CredentialMetadata"}},"example":{"format":"mso_mdoc","doctype":"org.iso.18013.5.1.mDL.T","scope":"mso_mdoc:TestCredential","id":"a1b2c3d4-e5f6-4789-abcd-ef0123456789","cryptographic_binding_methods_supported":["mso"],"credential_signing_alg_values_supported":[-7],"proof_types_supported":{"jwt":{"proof_signing_alg_values_supported":["ES256"]}},"credential_metadata":{"claims":[{"path":["org.iso.18013.5.1","firstName"],"mandatory":true,"display":[{"name":"First Name","locale":"en-US"}]}],"display":[{"name":"Test Mobile Credential","logo":{"uri":"https://example.com/logo.png","alt_text":"Example Logo"},"locale":"en-US","background_color":"#FFFFFF","text_color":"#000000"}]}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:msomdocCredentialConfigurationSupported:example"]},"ClaimSourceSchema":{"type":"object","required":["name","url","requestParameters"],"properties":{"name":{"type":"string","description":"Claims source name.","example":"My claims from example.com","examples":["My claims from example.com"]},"url":{"type":"string","description":"Claims source URL (and any redirects it may include):\n- Must be a valid URL.\n- Must use the HTTPS protocol.\n- Must not be an IP address.\n- Must not include query parameters.\n- Unicode will be converted to ASCII.","example":"https://example.com","examples":["https://example.com"]},"requestMethod":{"type":"string","description":"Indicates the request method MATTR VII will use when retrieving data from this claims source. Both the GET and POST method are supported. If no value is provided, GET is used by default.\nWhen using POST, all `requestParameters` must be included in the request body in JSON format.","enum":["GET","POST"]},"requestParameters":{"description":"Use this object to define how to map request parameters that are sent to your claims source using the `mapFrom` and `defaultValue` properties:\n- When only providing `mapFrom`, the request parameter will be mapped from the defined path. If mapping fails, no alternative value is used. You can map data from both the `claims` and `credentialConfiguration` objects.\n- When providing both `mapFrom` and `defaultValue`, MATTR VII will attempt to map the request parameter from the defined path. If mapping fails, the `defaultValue` is used instead.\n- When only providing `defaultValue`, its value is used to populate the request parameter, regardless of any available claims values.","oneOf":[{"type":"object","title":"Mapping only","required":["mapFrom"],"properties":{"mapFrom":{"type":"string","description":"Path to map the claim from.","example":"claims.accountType","examples":["claims.accountType"]}}},{"type":"object","title":"Mapping with fallback","required":["mapFrom","defaultValue"],"properties":{"mapFrom":{"type":"string","description":"Path to map the claim from.","example":"claims.accountType","examples":["claims.accountType"]},"defaultValue":{"description":"Static value to be used when `mapFrom` fails or evaluated to undefined (attribute doesn't exist).","oneOf":[{"type":"string"},{"type":"array","items":{}},{"type":"object"}]}}},{"type":"object","title":"Static value","required":["defaultValue"],"properties":{"defaultValue":{"description":"Static value to be used for all issued credentials, without querying the claims source.","oneOf":[{"type":"string"},{"type":"array","items":{}},{"type":"object"}]}}}]}}},"ClaimSourceAuthorizationApiKeySchema":{"title":"API Key","description":"API Key for claim source authorization.","type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["api-key"],"example":"api-key","examples":["api-key"]},"value":{"type":"string","example":"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J","examples":["6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"]}}},"ClaimSourceAuthorizationApiKeyResponse":{"title":"API Key","description":"API Key used to authenticate the request to the claims source server.","required":["value"],"allOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationApiKeySchema"},{"type":"object","properties":{"value":{"type":"string","description":"Masked API key value. Completely masked if it is less than 20 characters, while if it is 20 characters or longer only the last 5 characters are exposed.\n","example":"****************************************61m1J","examples":["****************************************61m1J"]}}}]},"ClaimSourceAuthorizationOAuthSchema":{"type":"object","required":["type","tokenEndpoint","clientId"],"properties":{"type":{"type":"string","enum":["oauth-client-credentials"],"example":["oauth-client-credentials"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:ClaimSourceAuthorizationOAuthSchema:properties:type:example"]},"tokenEndpoint":{"type":"string","description":"OAuth 2.0 token endpoint URL for obtaining an access token for this claims source.","format":"url"},"clientId":{"type":"string","description":"Your client identifier for this claims source."},"clientSecret":{"type":"string","description":"Your client secret for this claims source."},"tokenEndpointAuthMethod":{"type":"string","enum":["client_secret_basic","client_secret_post"],"description":"Two authentication methods are available:\n- `client_secret_basic` (default): Credentials are passed as a base 64 encoded basic token.\n- `client_secret_post`: Credentials are passed as parameters within the request body."},"audience":{"type":"string","description":"Optional audience for the claims source token."},"scope":{"type":"string","description":"Optional scope for the claims source token."}}},"ClaimSourceAuthorizationOAuthResponse":{"title":"OAuth Client Credentials","description":"OAuth client credentials used for getting an access token for the claim source.","required":["clientSecret"],"allOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationOAuthSchema"},{"type":"object","properties":{"clientSecret":{"type":"string","description":"Masked OAuth 2.0 client secret. Completely masked if it is less than 20 characters, while if it is 20 characters or longer only the last 5 characters are exposed.\n","example":"***********************************6d0f5","examples":["***********************************6d0f5"]}}}]},"CreateClaimSourceResponse":{"description":"Returns the claims source details, including a `claimSourceId`. You will use the this identifier to reference your claims source when creating your credential configuration.","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Claims source unique identifier","example":"57fa09e2-82f3-4d3d-9eca-d0253e84a4e6","examples":["57fa09e2-82f3-4d3d-9eca-d0253e84a4e6"]}}},{"$ref":"#/components/schemas/ClaimSourceSchema"},{"type":"object","required":["authorization"],"properties":{"authorization":{"description":"Authentication method configuration to access the claims source.","oneOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationApiKeyResponse"},{"$ref":"#/components/schemas/ClaimSourceAuthorizationOAuthResponse"}]}}}]},"GetClaimSourcesResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page.","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateClaimSourceResponse"}}}},"ClaimSourceAuthorizationApiKeyRequest":{"title":"API Key","description":"API Key used to authenticate the request to the claims source server.","allOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationApiKeySchema"},{"type":"object","properties":{"value":{"type":"string","description":"API key value. Note that MATTR VII does not validate your input, which means it's up to you to provide the correct API key for your claim sources.","example":"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J","examples":["6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J"]}}}]},"ClaimSourceAuthorizationOAuthRequest":{"title":"OAuth Client Credentials","description":"OAuth client credentials used for getting an access token for the claim source.","type":"object","allOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationOAuthSchema"},{"type":"object","properties":{"clientSecret":{"type":"string","description":"OAuth 2.0 client secret that will be used for the token endpoint request.","example":"1b41186347e4cc716155155cdecbded07536d0f5","examples":["1b41186347e4cc716155155cdecbded07536d0f5"]}}}]},"ClaimSourceRequest":{"allOf":[{"$ref":"#/components/schemas/ClaimSourceSchema"},{"type":"object","required":["authorization"],"properties":{"authorization":{"required":["clientSecret","value"],"description":"Authentication method configuration to access the claims source.","oneOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationApiKeyRequest"},{"$ref":"#/components/schemas/ClaimSourceAuthorizationOAuthRequest"}]}}}]},"UpdateClaimSourcesRequest":{"allOf":[{"$ref":"#/components/schemas/ClaimSourceSchema"},{"type":"object","required":["authorization"],"properties":{"authorization":{"description":"Authentication method configuration to access the claims source.","oneOf":[{"$ref":"#/components/schemas/ClaimSourceAuthorizationApiKeyRequest"},{"$ref":"#/components/schemas/ClaimSourceAuthorizationOAuthRequest"}]}}}]},"MessagingInbox":{"title":"MessagingInbox","type":"object","properties":{"id":{"type":"string","example":"f04faabf-cea8-4f39-95b3-0ce357ac4d03","examples":["f04faabf-cea8-4f39-95b3-0ce357ac4d03"]},"name":{"type":"string","example":"My_Inbox","examples":["My_Inbox"]}},"required":["id","name"]},"MessagingInboxDIDs":{"title":"MessagingInboxDIDs","type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","description":"Array of DIDs which are registered with this inbox.","example":["did:key:did1","did:key:did2","did:key:did3"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:MessagingInboxDIDs:properties:data:example"]}}},"MessageInboxMessage":{"title":"MessageInboxMessage","type":"object","properties":{"name":{"type":"string","description":"Message name."},"createdAt":{"type":"string","format":"date","description":"Message creation date."},"id":{"type":"string","description":"Unique identifier of this message."},"inboxId":{"type":"string","description":"Unique identifier of the inbox this message is held in."},"payload":{"type":"string","description":"Message payload."}},"required":["name","createdAt"]},"JSONObjectMessage":{"type":"object","description":"A JSON Object plaintext message","example":{"msg":"this is a message"},"title":"JSONObjectMessage","examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:JSONObjectMessage:example"]},"SignMessageRequest":{"type":"object","required":["didUrl","payload"],"properties":{"didUrl":{"type":"string","description":"The did key that will be used to sign the message, which must supports signing. You can obtain it from the DID document `DID.localMetadata.initialDidDocument.authentication[0]` path.","example":"did:example:abcdefghijkl#key1","examples":["did:example:abcdefghijkl#key1"]},"payload":{"$ref":"#/components/schemas/JSONObjectMessage"}},"title":"SignMessageRequest"},"SignMessageResponse":{"title":"SignMessageResponse","type":"string","description":"Signed message in a response","example":"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDprZXk6ejZNa21mazNtMldIQlVxVm94SlZ3R1NQejVrYmFKNnpBMXRwN1JRWUJiUUdtczNoI3o2TWttZmszbTJXSEJVcVZveEpWd0dTUHo1a2JhSjZ6QTF0cDdSUVlCYlFHbXMzaCJ9.eyJtc2ciOiJUaGlzIGlzIGEgcGF5bG9hZCJ9.5E9qEmmSOMHLABAr4A9VzuNKFaO4EDo2GSCMoxQm9zsE7eCmEEuaAxtNhOUdd-Wvj64vqBBVl84XB1Yg7X9wBg","required":["ciphertext"],"examples":["eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDprZXk6ejZNa21mazNtMldIQlVxVm94SlZ3R1NQejVrYmFKNnpBMXRwN1JRWUJiUUdtczNoI3o2TWttZmszbTJXSEJVcVZveEpWd0dTUHo1a2JhSjZ6QTF0cDdSUVlCYlFHbXMzaCJ9.eyJtc2ciOiJUaGlzIGlzIGEgcGF5bG9hZCJ9.5E9qEmmSOMHLABAr4A9VzuNKFaO4EDo2GSCMoxQm9zsE7eCmEEuaAxtNhOUdd-Wvj64vqBBVl84XB1Yg7X9wBg"]},"VerifyRequest":{"type":"object","properties":{"jws":{"type":"string","description":"JWS (JSON Web Siganture) in its compact form.","example":"EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","examples":["EXAMPLE_JWS_TOKEN_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"]}},"title":"VerifyRequest"},"VerifyMessageResponse":{"type":"object","properties":{"didUrl":{"type":"string","description":"The `didUrl` included in the JWS (JSON Web Signature) object.","example":"did:web:organization.com#2vcj3MjR4d","examples":["did:web:organization.com#2vcj3MjR4d"]},"did":{"type":"string","description":"The DID URI parsed from the `didUrl`.","example":"did:web:organization.com","examples":["did:web:organization.com"]},"verified":{"type":"boolean","description":"Verification result.","example":true,"examples":[true]},"payload":{"oneOf":[{"type":"string"},{"type":"object"}],"description":"The payload of the verified message"}},"title":"VerifyMessageResponse"},"EncryptMessageRequest":{"title":"EncryptMessageRequest","type":"object","properties":{"senderDidUrl":{"type":"string","description":"The sender's DID URL, obtained from the `id` field of the first `keyAgreement` entry of its DID document (`DID.localMetadata.initialDidDocument.keyAgreement[0].id`). This must reference a key that supports key agreement."},"recipientDidUrls":{"type":"array","description":"The intended recepient's Subject DID.","items":{"type":"string"}},"payload":{"type":"object","description":"The message to be encrypted."}},"required":["senderDidUrl","recipientDidUrls","payload"]},"EncryptedMessage":{"title":"EncryptedMessage","type":"object","properties":{"jwe":{"type":"object","description":"The encrypted message in JWM format.","properties":{"protected":{"type":"string","minLength":1},"recipients":{"type":"array","uniqueItems":true,"minItems":1,"items":{"required":["encryption_key"],"properties":{"header":{"type":"object","properties":{"alg":{"type":"string","minLength":1},"kid":{"type":"string","minLength":1},"epk":{"type":"object","properties":{"kty":{"type":"string","minLength":1},"crv":{"type":"string","minLength":1},"x":{"type":"string","minLength":1}},"required":["kty","crv","x"]},"skid":{"type":"string","minLength":1}},"required":["alg","kid","epk","skid"]},"encryption_key":{"type":"string","minLength":1}}}},"ciphertext":{"type":"string","minLength":1},"iv":{"type":"string","minLength":1},"tag":{"type":"string","minLength":1}},"required":["protected","recipients","ciphertext","iv","tag"]}},"required":["jwe"]},"DecryptMessageRequest":{"title":"DecryptMessageRequest","type":"object","properties":{"jwe":{"description":"The `jwe` object to be decrypted. It can be extracted from the `jwe` attribute of the response body you get when [encrypting a message](#operation/encryptMessage).\nAlternatively, you can use a `jwe string` using `Base64` encoding method and following the [JWE open-standard](https://datatracker.ietf.org/doc/rfc7516/):\n`BASE64URL(UTF8(JWE Protected Header)) || '.' || BASE64URL(JWE Encrypted Key) || '.' || BASE64URL(JWE Initialization Vector) || '.' || BASE64URL(JWE Ciphertext) || '.' || ASE64URL(JWE Authentication Tag)`","oneOf":[{"type":"string","example":"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA","examples":["eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA"]},{"$ref":"#/components/schemas/EncryptedMessage"}]}},"required":["jwe"]},"DecryptMessageResponse":{"type":"object","properties":{"payload":{"oneOf":[{"type":"string"},{"type":"object"}]},"senderDidUrl":{"type":"string","description":"Sender DID retrieved from the decrypted message.","example":"did:web:organization.com#2vcj3MjR4d","examples":["did:web:organization.com#2vcj3MjR4d"]},"senderPublicJwk":{"type":"object","description":"The sender public JWK (JSON Web Key) retrieved from the decrypted message."},"recipientDidUrl":{"type":"string","description":"Intended recipient DID URI retrieved from the decrypted message.","example":"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d","examples":["did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d"]}},"title":"DecryptMessageResponse"},"SendMessageRequest":{"type":"object","properties":{"to":{"type":"string","description":"Recipient DID."},"message":{"oneOf":[{"type":"string"},{"type":"object"}],"description":"Message in JWE (JSON Web Encryption) format. This endpoint only accepts Encrypted payloads to ensure that messages are encrypted-at-rest whilst in messaging inboxes. The message should be encrypted for the recipient based on a key available in the DID Document."}},"title":"SendMessageRequest"},"GetUserResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"User unique identifier.","example":"0c3fad74-a8df-4a2d-8e75-f2d356b413ba","examples":["0c3fad74-a8df-4a2d-8e75-f2d356b413ba"]},"claims":{"type":"object","description":"User claims.","example":{"externalUserId":"0c3fad74-a8df-4a2d-8e75-f2d356b413ba"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:GetUserResponse:properties:claims:example"]},"authenticationProvider":{"type":"object","description":"Authentication Provider information for the user.","properties":{"providerId":{"type":"string","description":"Authentication Provider identifier.","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"url":{"type":"string","description":"Authentication Provider url.","example":"https://example-university.au.auth0.com","examples":["https://example-university.au.auth0.com"]},"subjectId":{"type":"string","description":"Unique identifier of the user in the Authentication Provider.","example":"example-university-oauth2|123456789","examples":["example-university-oauth2|123456789"]}}}},"title":"GetUserResponse"},"SearchUsersResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","description":"Includes all matching user objects.","items":{"$ref":"#/components/schemas/GetUserResponse"}}},"title":"SearchUsersResponse"},"GetUsersResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","description":"Includes matching user objects.","items":{"$ref":"#/components/schemas/GetUserResponse"}}},"title":"GetUsersResponse"},"CreateUserRequest":{"type":"object","properties":{"claims":{"type":"object","description":"User claims to be persisted. No claims are persisted by default. Consider PII implications before persisting any claims.","example":{"externalUserId":"0c3fad74-a8df-4a2d-8e75-f2d356b413ba"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreateUserRequest:properties:claims:example"]},"authenticationProvider":{"type":"object","description":"Authentication Provider information for the user. This enables linking the user to an external identity provider. If implemented insecurely, this process can be exploited by malicious actors to gain unauthorized access to legitimate user accounts. \n\nTo mitigate this risk, require authentication for both accounts involved in the link, whether the link is created manually or automatically. Always prompt the user to enter credentials to verify ownership before establishing the link.","required":["providerId","subjectId"],"properties":{"providerId":{"type":"string","description":"Authentication Provider identifier.","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"subjectId":{"type":"string","description":"Unique identifier of the user in the Authentication Provider. Must be an exact match.","example":"example-university-oauth2|123456789","examples":["example-university-oauth2|123456789"]}},"example":{"providerId":"41458e5a-9092-40b7-9a26-d4eb43c5792f","subjectId":"example-university-oauth2|123456789"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreateUserRequest:properties:authenticationProvider:example"]}},"title":"CreateUserRequest"},"GetUserCredentialsResponse":{"type":"object","properties":{"data":{"type":"array","description":"- Includes metadata for all credentials referenced by the provided `UserId`.\n- Properties returned depend on the credential type, with the exception of the following properties which are always returned:\n - `id`\n - `type`\n - `profile`\n - `sessionId`\n - `credentialConfigurationId`\n- Properties are only returned for credentials issued using Platform v11.0.0 or later, with the exception of the following properties which are always returned:\n - `id`\n - `type`\n - `profile`\n - `sessionId`","items":{"oneOf":[{"type":"object","title":"mDoc","required":["id","type","profile","sessionId","credentialConfigurationId","devicePublicKey","namespaces","msoHash","issuedDate","validFrom","validUntil"],"properties":{"id":{"type":"string","description":"Credential unique identifier.","example":"552b35fe-a3ed-4c33-8c3c-64810c712323","examples":["552b35fe-a3ed-4c33-8c3c-64810c712323"]},"type":{"type":"string","description":"Credential type.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"profile":{"type":"string","enum":["mobile"],"description":"Credential format.","example":"mobile","examples":["mobile"]},"offerId":{"type":"string","description":"Identifier of the credential offer used to claim this credential.","example":"b0877ef9-deaf-4c88-8765-2b5aad2913d9","examples":["b0877ef9-deaf-4c88-8765-2b5aad2913d9"]},"sessionId":{"type":"string","description":"Identifier of the session in which this credential was claimed.","example":"4da5bce7-39d0-482e-8972-c674c688e01a","examples":["4da5bce7-39d0-482e-8972-c674c688e01a"]},"credentialConfigurationId":{"type":"string","description":"Identifier of the credential configuration used to issue this credential.","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"devicePublicKey":{"type":"object","description":"The device public key that is bound to this credential.","properties":{"kty":{"type":"string","description":"Key type.","example":"EC","examples":["EC"]},"crv":{"type":"string","description":"Elliptic curve used with the key.","example":"P-256","examples":["P-256"]},"x":{"type":"string","description":"The x coordinate for the elliptic curve point.","example":"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo","examples":["11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo"]}},"title":"PublicJsonWebKey"},"namespaces":{"type":"object","description":"Namespaces used in the credential.","example":{"org.iso.18013.5.1":{"given_name":{"digestID":0,"digest":"8GWbUyIRA2xATs5ILEa0fVZF1QQt4JL5gG2aCtVsazU"},"family_name":{"digestID":1,"digest":"R4jk/m0wX9KhENp7DVPr9AM7Hz+CJoEJNKJRQo92FCI"}}},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:GetUserCredentialsResponse:properties:data:items:oneOf:0:properties:namespaces:example"]},"msoHash":{"type":"string","description":"Base64NoPadding encoded string of the Sha256 hash of the Mobile Security Object (MSO) Bytes.","example":"OsPO++ARsvvJYswmuzN8E3rxN+jAkbWbxhqVIOfM1Go","examples":["OsPO++ARsvvJYswmuzN8E3rxN+jAkbWbxhqVIOfM1Go"]},"issuedDate":{"type":"string","format":"date-time","example":"2025-06-28T12:34:56.000Z","description":"The date and time when the credential was issued.","examples":["2025-06-28T12:34:56.000Z"]},"validFrom":{"type":"string","format":"date-time","example":"2025-06-30T12:00:00.000Z","description":"The date and time when the credential becomes valid.","examples":["2025-06-30T12:00:00.000Z"]},"validUntil":{"type":"string","format":"date-time","example":"2025-07-30T12:00:00.000Z","description":"The date and time when the credential expires.","examples":["2025-07-30T12:00:00.000Z"]},"status":{"type":"string","enum":["valid","invalid","suspended"],"description":"The credential's current revocation status.","example":"valid","examples":["valid"]}}},{"type":"object","title":"CWT","required":["id","type","profile","sessionId","credentialConfigurationId"],"properties":{"id":{"type":"string","description":"Credential unique identifier.","example":"552b35fe-a3ed-4c33-8c3c-64810c712323","examples":["552b35fe-a3ed-4c33-8c3c-64810c712323"]},"type":{"type":"string","description":"Credential type.","example":"CourseCredential","examples":["CourseCredential"]},"profile":{"type":"string","enum":["compact","compact-semantic"],"description":"Credential format.","example":"compact-semantic","examples":["compact-semantic"]},"offerId":{"type":"string","description":"Identifier of the credential offer used to claim this credential.","example":"b0877ef9-deaf-4c88-8765-2b5aad2913d9","examples":["b0877ef9-deaf-4c88-8765-2b5aad2913d9"]},"sessionId":{"type":"string","description":"Identifier of the session in which this credential was claimed.","example":"4da5bce7-39d0-482e-8972-c674c688e01a","examples":["4da5bce7-39d0-482e-8972-c674c688e01a"]},"credentialConfigurationId":{"type":"string","description":"Identifier of the credential configuration used to issue this credential.","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]},"issuedDate":{"type":"string","format":"date-time","example":"2025-06-28T12:34:56.000Z","description":"The date and time when the credential was issued.","examples":["2025-06-28T12:34:56.000Z"]},"validFrom":{"type":"string","format":"date-time","example":"2025-06-30T12:00:00.000Z","description":"The date and time when the credential becomes valid.","examples":["2025-06-30T12:00:00.000Z"]},"validUntil":{"type":"string","format":"date-time","example":"2025-07-30T12:00:00.000Z","description":"The date and time when the credential expires.","examples":["2025-07-30T12:00:00.000Z"]}}},{"type":"object","title":"JSON","required":["id","type","profile","sessionId","credentialConfigurationId"],"properties":{"id":{"type":"string","description":"Credential unique identifier.","example":"552b35fe-a3ed-4c33-8c3c-64810c712323","examples":["552b35fe-a3ed-4c33-8c3c-64810c712323"]},"type":{"type":"string","description":"Credential type.","example":"CourseCredential","examples":["CourseCredential"]},"profile":{"type":"string","enum":["web-semantic"],"description":"Credential format.","example":"web-semantic","examples":["web-semantic"]},"offerId":{"type":"string","description":"Identifier of the credential offer used to claim this credential.","example":"b0877ef9-deaf-4c88-8765-2b5aad2913d9","examples":["b0877ef9-deaf-4c88-8765-2b5aad2913d9"]},"sessionId":{"type":"string","description":"Identifier of the session in which this credential was claimed.","example":"4da5bce7-39d0-482e-8972-c674c688e01a","examples":["4da5bce7-39d0-482e-8972-c674c688e01a"]},"credentialConfigurationId":{"type":"string","description":"Identifier of the credential configuration used to issue this credential.","example":"3948c40e-6e19-4ffc-933c-91f643f24264","examples":["3948c40e-6e19-4ffc-933c-91f643f24264"]}}}]}},"nextCursor":{"$ref":"#/components/schemas/nextCursor"}},"title":"GetUserCredentialsResponse"},"AuthenticationProviderSchema":{"type":"object","required":["clientId"],"properties":{"scope":{"type":"array","description":"OpenID scopes to use during authentication. Each scope returns a set of user attributes which are called claims. Be sure to test that right scopes are added to get all the information you need. If no scopes are provided, [`openid`,`profile`,`email`] are added by default. If any scopes are provided, `openid` must also be included in the array.","example":["openid","profile","email","address","phone"],"default":["openid","profile","email"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AuthenticationProviderSchema:properties:scope:example"]},"clientId":{"type":"string","description":"The client ID of the application client created on your IdP.","example":"vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN","examples":["vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN"]},"clientSecret":{"type":"string","description":"The client secret of the application client created on your IdP."},"tokenEndpointAuthMethod":{"type":"string","description":"Authentication method for your IdP token endpoint:\n- `client_secret_post`: Your credentials are passed as parameters in the request body.\n- `client_secret_basic` (default): Your credentials are passed as a base 64 encoded token.","example":"client_secret_post","default":"client_secret_basic","enum":["client_secret_basic","client_secret_post"],"examples":["client_secret_post"]},"staticRequestParameters":{"type":"object","maxProperties":1000,"description":"Additional parameters (maximum 1000 entries allowed) that will be included in the request to your IdP. These parameters are identical for every request as defined in your configuration. An example would be setting the prompt to be login to let your IdP know it should show the login page every time. Keys must be strings. Values of top-level object keys must stringify to less than 1000 characters.","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array"},{"type":"object"}]},"example":{"prompt":"login","max_age":10000},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AuthenticationProviderSchema:properties:staticRequestParameters:example"]},"forwardedRequestParameters":{"type":"array","description":"In contrast to `staticRequestParameters`, you can provide dynamic parameters that are fetched uniquely for each request to make the user journey more seamless. You can forward params to your IdP like `login_hint` which will pass the email of the user starting the flow. Values are limited to 1000 characters each, and cannot override any core [Authorize Parameters](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).","default":[],"example":["login_hint"],"items":{"type":"string","maxLength":1000},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AuthenticationProviderSchema:properties:forwardedRequestParameters:example"]},"claimsToPersist":{"type":"array","description":"List of claims to persist from your IdP to MATTR VII. If you have attributes from the ID token (e.g. user identifier, email, etc.) that you would like persisted on MATTR VII, add them to this array. By default this array is empty, meaning no claims are persisted on MATTR VII.","items":{"type":"string"},"default":[],"example":["userId"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:AuthenticationProviderSchema:properties:claimsToPersist:example"]}}},"CreateAuthenticationProviderResponse":{"required":["clientSecret"],"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the configured authentication provider. This identifier can be used to retrieve, update or remove the authentication provider configuration.","example":"983c0a86-204f-4431-9371-f5a22e506599","examples":["983c0a86-204f-4431-9371-f5a22e506599"]},"redirectUrl":{"type":"string","format":"uri","description":"You will need to add this URL to your IdP's allowed redirects list, to enable it to redirect the user back to the wallet upon successful authentication with your IdP. If you are using Auth0 as your identity provider, [this guide](https://auth0.com/docs/authenticate/login/redirect-users-after-login) shows how to add callback URLs. For others, consult your provider for instructions on adding callback URLs.","example":"https://tenant.vii.mattr.global/v1/oauth/authentication/callback","examples":["https://tenant.vii.mattr.global/v1/oauth/authentication/callback"]},"url":{"type":"string","format":"uri","description":"Base url for your Authentication Provider well-known endpoint."}}},{"$ref":"#/components/schemas/AuthenticationProviderSchema"},{"type":"object","properties":{"clientSecret":{"type":"string","description":"Your authentication provider client secret will be masked in the response without revealing the actual secret. If the secret is less than 20 characters it will be completely masked, and if it is over 20 only the last 5 characters are revealed.","example":"***********************************************************6-OjH","examples":["***********************************************************6-OjH"]}}}],"title":"CreateAuthenticationProviderResponse"},"GetAuthenticationProvidersResponse":{"type":"object","properties":{"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","description":"Starting point for next cursor to use in a page","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateAuthenticationProviderResponse"}}},"title":"GetAuthenticationProvidersResponse"},"AuthenticationProviderRequest":{"type":"object","allOf":[{"$ref":"#/components/schemas/AuthenticationProviderSchema"},{"type":"object","properties":{"clientSecret":{"description":"The client secret of the application client created on your IdP.","example":"QNwfa4Yi4Im9zy1u_15n7SzWKt-9G5cdH0r1bONRpUPfN-UIRaaXv_90z8V6-OjH","examples":["QNwfa4Yi4Im9zy1u_15n7SzWKt-9G5cdH0r1bONRpUPfN-UIRaaXv_90z8V6-OjH"]}}}]},"OpenIdConfigurationInteractionHookRequest":{"type":"object","description":"Interaction Hook configuration.","properties":{"url":{"type":"string","format":"uri","description":"The interaction hook URL that the user will be redirected to after completing the authentication process:\n- Must be a valid URL.\n- Must use the HTTPS protocol.\n- Must not be an IP address.\n- Must not include query parameters. Port and fragment parameters will be dropped. \n- Must have a valid public TLD.\n- Unicode will be converted to ASCII.","example":"https://example-university.com/callback","examples":["https://example-university.com/callback"]},"claims":{"type":"array","description":"An array of user attributes that will be returned in the authentication response. These claims are included in the session token that is sent to the interaction hook. Claims can only include alphanumeric characters, ''_'', or ''-''. If the value is empty or not defined, no claims are sent.","items":{"type":"string"},"default":[],"example":["first_name","last_name","email"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:OpenIdConfigurationInteractionHookRequest:properties:claims:example"]},"sessionTimeoutInSec":{"type":"number","description":"Interaction hook session duration (in seconds). Once a session expires, the user is shown an error when they are redirected. If not specified, the default environment session duration is applied.","example":1200,"minimum":300,"maximum":7200,"examples":[1200]},"disabled":{"type":"boolean","description":"Indicates whether the interactions hook is disabled. When `false`, the interactions hook is **enabled** and users will be redirected to your configured interaction hook component after they've authenticated themselves against your IdP.","default":true,"example":false,"examples":[false]}},"title":"OpenIdConfigurationInteractionHookRequest"},"OpenIdConfigurationInteractionHook":{"type":"object","description":"Interaction Hook configuration.","allOf":[{"$ref":"#/components/schemas/OpenIdConfigurationInteractionHookRequest"},{"type":"object","properties":{"secret":{"type":"string","description":"A Base64 encoded HMAC secret that must be used by your interaction hook component to sign a new JWT with any additional claims that you may include. Refer to the [Interaction hook tutorial](https://learn.mattr.global/docs/issuance/authorization-code/interaction-hook/tutorial#sign-the-interaction-hook-response-jwt-and-redirect-back-to-mattr-vii) for more information.","example":"dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c=","examples":["dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c="]}}}],"title":"OpenIdConfigurationInteractionHook"},"OpenIdConfigurationGeneral":{"type":"object","properties":{"interactionHook":{"$ref":"#/components/schemas/OpenIdConfigurationInteractionHook"}},"title":"OpenIdConfiguration"},"UpdateOpenIdConfigurationRequest":{"type":"object","properties":{"interactionHook":{"$ref":"#/components/schemas/OpenIdConfigurationInteractionHookRequest"}},"title":"UpdateOpenIdConfigurationRequest"},"Event":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event identifier.","example":"0c099611-19c4-4f29-8724-6b9e5ba1ef7c","examples":["0c099611-19c4-4f29-8724-6b9e5ba1ef7c"]},"type":{"type":"string","description":"Event type.","example":"CREDENTIAL_COMPACT_SIGN_START","examples":["CREDENTIAL_COMPACT_SIGN_START"]},"timestamp":{"type":"string","description":"Timestamp of when the event was generated.","example":"2023-06-01T02:45:44.087Z","examples":["2023-06-01T02:45:44.087Z"]},"category":{"type":"string","description":"Event category.","example":"credential-compact","examples":["credential-compact"]},"requestId":{"type":"string","description":"Identifier for the request this event is part of.","example":"4SO6JZz3sPYLjOQvxIVHr5","examples":["4SO6JZz3sPYLjOQvxIVHr5"]},"requestIp":{"type":"string","description":"IP address from which the request originated.","example":"192.0.2.1","examples":["192.0.2.1"]},"managementUserId":{"type":"string","format":"uuid","description":"Identifier for the management user associated with this event.","example":"ea691ed4-90ff-4be2-bd85-f2c74efa72c3","examples":["ea691ed4-90ff-4be2-bd85-f2c74efa72c3"]},"clientId":{"type":"string","description":"Identifier for the client associated with this event.","example":"54rp8Z8yGnlva19mThj7tJzNXFSyXrCf","examples":["54rp8Z8yGnlva19mThj7tJzNXFSyXrCf"]},"metadata":{"type":"object","description":"Available metadata will vary based on event type and logging level."},"data":{"type":"object","description":"Available data will vary based on event type and logging level."}},"required":["id","type","timestamp","category","metadata","data"]},"CredentialReportRequest":{"title":"CredentialReportRequest","type":"object","properties":{"timezoneOffset":{"type":"string","description":"Timezone offset for the report in ISO-8601 format. For example, \"+02:00\" or \"-05:00\". This is used to determine the date boundaries for the report. For example, if the timezone offset is \"+02:00\", an operation that occurred at 2026-02-25T22:30:00Z would be counted towards 2026-02-26 in the report, while if the timezone offset is \"-05:00\", it would be counted towards 2026-02-25.","example":"+02:00","examples":["+02:00"]},"startDate":{"type":"string","format":"date","description":"Start date for the report (inclusive) in ISO-8601 format. The date is interpreted based on the provided timezone offset. Maximum range for a single report is 31 days, so the endDate cannot be more than 30 days after the startDate.","example":"2026-02-01","examples":["2026-02-01"]},"endDate":{"type":"string","format":"date","description":"End date for the report (inclusive) in ISO-8601 format. The date is interpreted based on the provided timezone offset. Maximum range for a single report is 31 days, so the endDate cannot be more than 30 days after the startDate.","example":"2026-02-28","examples":["2026-02-28"]},"profiles":{"type":"array","description":"A list of credential profiles to include in the report.","items":{"type":"string","enum":["cwt","mdoc"]},"example":["cwt","mdoc"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CredentialReportRequest:properties:profiles:example"]},"limit":{"type":"integer","description":"Maximum number of entries to include in the report. Defaults to 1000.","example":100,"default":1000,"examples":[100]},"cursor":{"type":"string","description":"Cursor for pagination. If not specified, the report will start from the most recent entry.","example":"b2Zmc2V0PTM=","examples":["b2Zmc2V0PTM="]}},"required":["timezoneOffset","startDate","endDate","profiles"]},"CredentialReport":{"title":"CredentialReport","type":"object","properties":{"data":{"type":"array","items":{"title":"CredentialReportEntry","type":"object","properties":{"date":{"type":"string","format":"date","description":"The date associated with this report entry.","example":"2026-02-25","examples":["2026-02-25"]},"operation":{"type":"string","enum":["issued","status_changed"],"description":"The type of credential lifecycle operation:\n - `issued`: The credential was issued.\n - `status_changed`: The credential status was changed (e.g., revoked).","example":"issued","examples":["issued"]},"profile":{"type":"string","enum":["cwt","mdoc"],"description":"The credential profile associated with the operation.","example":"mdoc","examples":["mdoc"]},"credentialType":{"type":"string","description":"The credential type associated with the operation, if applicable.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]},"count":{"type":"integer","description":"The total number of operations performed on the specified date. This aggregates all operations of the same type and profile that occurred on that date. For example, if 5 mDoc credentials were issued on 2026-02-25, there would be an entry with `date` of \"2026-02-25\", `operation` of \"issued\", `profile` of \"mdoc\", and `count` of 5.","example":5,"examples":[5]}},"required":["date","operation","profile","count"]}},"nextCursor":{"type":"string","description":"Cursor to use in the next request to retrieve the next page of results. If not present, there are no more results.","example":"Y3JlYXRlZEF0PTIwMjYtMDItMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM","examples":["Y3JlYXRlZEF0PTIwMjYtMDItMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"]}}},"MattrIntegration":{"title":"MATTR Integration","type":"object","required":["format","url","enabled"],"properties":{"format":{"type":"string","description":"Integration format.","enum":["MATTR"]},"url":{"type":"string","description":"URL where this integration's trust information is retrieved from.","example":"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy","examples":["https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy"]},"enabled":{"type":"boolean","description":"Flag indicating whether the integration is enabled.","example":true,"examples":[true]}}},"VicalIntegration":{"title":"VICAL Integration","type":"object","required":["format","url","enabled","rootCertificatePems"],"properties":{"format":{"type":"string","description":"Integration format.","enum":["VICAL"]},"url":{"type":"string","description":"URL where this integration's trust information is retrieved from.","example":"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/vicals/public/latest","examples":["https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/vicals/public/latest"]},"enabled":{"type":"boolean","description":"Flag indicating whether the integration is enabled.","example":true,"examples":[true]},"rootCertificatePems":{"type":"array","description":"The root certificate PEM that should be used to verify this [VICAL](https://learn.mattr.global/docs/digital-trust-service/vical-overview).","items":{"type":"string","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]}}}},"EcosystemIntegration":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/MattrIntegration"},{"type":"object","properties":{"integrationResult":{"type":"object","required":["success","lastSyncedAt"],"properties":{"success":{"type":"boolean","description":"Flag indicating whether the integration was successful.","example":true,"examples":[true]},"lastSyncedAt":{"type":"string","description":"The timestamp when the integration was last synced.","format":"date-time","example":"2024-09-10T02:28:36.550Z","examples":["2024-09-10T02:28:36.550Z"]},"lastModifiedAt":{"type":"string","description":"The timestamp when the integrated trust information was last modified.","format":"date-time","example":"2024-08-10T02:28:36.550Z","examples":["2024-08-10T02:28:36.550Z"]},"failReasons":{"type":"array","description":"A list of integration failure reasons, present only when `success` is `false`.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"UnknownVerificationError","examples":["UnknownVerificationError"]},"message":{"type":"string","example":"Unknown verification error occurred","examples":["Unknown verification error occurred"]}}}}}}}}]},{"allOf":[{"$ref":"#/components/schemas/VicalIntegration"},{"type":"object","properties":{"integrationResult":{"type":"object","required":["success","lastSyncedAt"],"properties":{"success":{"type":"boolean","description":"Flag indicating whether the integration was successful.","example":true,"examples":[true]},"lastSyncedAt":{"type":"string","description":"The timestamp when the integration was last synced.","format":"date-time","example":"2024-09-10T02:28:36.550Z","examples":["2024-09-10T02:28:36.550Z"]},"vicalIssueID":{"type":"integer","description":"vicalIssueID identifies the specific issue of the VICAL.","example":112,"examples":[112]},"date":{"type":"string","description":"The timestamp when the VICAL was signed.","format":"date-time","example":"2024-05-01T00:00:00.000Z","examples":["2024-05-01T00:00:00.000Z"]},"failReasons":{"type":"array","description":"A list of integration failure reasons, present only when `success` is `false`.","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"InvalidCertificatePem","examples":["InvalidCertificatePem"]},"message":{"type":"string","example":"Invalid certificate PEM","examples":["Invalid certificate PEM"]}}}}}}}}]}]},"Ecosystem":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the ecosystem.","example":"87880d7e-a4d0-462e-8383-3f1e5e16865d","readOnly":true,"examples":["87880d7e-a4d0-462e-8383-3f1e5e16865d"]},"name":{"type":"string","description":"The name of the ecosystem.","minLength":1,"maxLength":50,"example":"My Ecosystem","examples":["My Ecosystem"]},"integrations":{"type":"array","items":{"$ref":"#/components/schemas/EcosystemIntegration"}}}},"name":{"type":"string","description":"The name of the ecosystem.","minLength":1,"maxLength":50,"example":"My Ecosystem","examples":["My Ecosystem"]},"EcosystemConfig":{"type":"object","properties":{"ecosystems":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"object","properties":{"url":{"type":"string","description":"Ecosystem URL","example":"https://example.vii.au01.mattr.global/v1/ecosystems/cdd42cec-e961-447c-9083-1312ee316053","examples":["https://example.vii.au01.mattr.global/v1/ecosystems/cdd42cec-e961-447c-9083-1312ee316053"]}}}},"isIssuanceRestricted":{"type":"boolean","description":"Indicates whether issuance is restricted (`true`) or not (`false`).","example":false,"examples":[false]},"isVerificationRestricted":{"type":"boolean","description":"Indicates whether verification is restricted (`true`) or not (`false`).","example":false,"examples":[false]}}},"id":{"type":"string","format":"uuid","description":"The UUID of the ecosystem.","example":"87880d7e-a4d0-462e-8383-3f1e5e16865d","readOnly":true,"examples":["87880d7e-a4d0-462e-8383-3f1e5e16865d"]},"CreatePolicyResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this policy.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"policyPublishedAt":{"type":"string","format":"date-time","description":"The timestamp when the policy was published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]}}},"CredentialProfile":{"type":"string","enum":["compact","compact-semantic","web-semantic"]},"Credential":{"title":"Web/Compact","type":"object","required":["id","ecosystemId","profile","type","name"],"properties":{"id":{"type":"string","format":"uuid","example":"599bf148-d711-405a-a20b-9c8a87ac8850","description":"Unique identifier for this credential type.","readOnly":true,"examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]},"ecosystemId":{"$ref":"#/components/schemas/id"},"profile":{"$ref":"#/components/schemas/CredentialProfile"},"type":{"type":"string","example":"DriverLicense","examples":["DriverLicense"]},"name":{"type":"string","description":"The name of the credential","minLength":1,"maxLength":50,"example":"Driver's License","examples":["Driver's License"]}}},"ParticipantIdentifiers":{"type":"object","description":"Define the unique identifier that will be used by this participant to issue and/or verify credentials. Participants can have different identifiers for different credential formats. Each participant must have at least one defined credential format, and for each credential format a participant can define exactly one unique identifier.\n- Credentials are only valid in the ecosystem if they include an identifier of an issuer that is a participant in the ecosystem.\n- Verification requests are only valid in the ecosystem if they include an identifier of a verifier that is a participant in the ecosystem.\n- For mDocs this must be the PEM of a valid [IACA](#operation/create-mobile-credential-iaca) used by this participant to sign mDocs, as defined in annex B of [ISO/IEC 18013-5:2021](https://www.iso.org/standard/69084.html). An exception to this aforementioned definition is that IACAs with a `notBefore` date in the future are considered valid.","properties":{"web-semantic":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]},"compact-semantic":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]},"compact":{"type":"string","example":"did:web:example.com","examples":["did:web:example.com"]},"mobile":{"type":"array","minItems":1,"items":{"type":"object","properties":{"certificatePem":{"type":"string","description":"Must be the PEM of a valid [IACA](/docs/issuance/certificates/api-reference/iaca#create-an-iaca) used by this participant to sign mDocs, as defined in annex B of [ISO/IEC 18013-5:2021](https://www.iso.org/standard/69084.html). An exception to this aforementioned definition is that IACAs with a `notBefore` date in the future are considered valid.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","description":"The status of the mobile identifier.","enum":["Active","Inactive","Delisted"],"example":"Active","examples":["Active"]},"docTypes":{"type":"array","description":"Determines the document types that a participant is permitted to issue. This parameter governs how the participant’s permissions are represented in published VICALs and ecosystem policies, limiting issuance to the defined `docTypes`.\n\nNote: This is a metadata-level declaration and does not enforce validation during credential assignment or issuance.\n","items":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}}},"required":["certificatePem","status","docTypes"]}}}},"Participant":{"required":["id","ecosystemId","name","identifiers"],"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","readOnly":true,"examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]},"ecosystemId":{"$ref":"#/components/schemas/id"},"name":{"type":"string","description":"Name to easily identify the participant.","minLength":1,"maxLength":50,"example":"My Participant","examples":["My Participant"]},"identifiers":{"$ref":"#/components/schemas/ParticipantIdentifiers"},"isIssuer":{"type":"boolean","description":"Indicates whether the participant is an issuer in the ecosystem (`true`) or not (`false`). When set to `false`, the participant will not be able to issue any valid credential types, even if it is added to an issuer policy. The default value is `false`, as this assigns the least privileges to the new participant.","default":false,"example":false,"examples":[false]},"isVerifier":{"type":"boolean","description":"Indicates whether the created participant is a verifier in the ecosystem (`true`) or not (`false`). When set to `false`, the participant will not be able to verify any valid credential types, even if it is added to a verifier policy. The default value is `false`, as this assigns the least privileges to the new participant.","default":false,"example":false,"examples":[false]},"isIssuerConstrained":{"type":"boolean","description":"Indicates whether the created participant is constrained to only issue specific types of valid credentials (`true`) or not (`false`). When set to `false`, the issuer can issue all valid credential types defined within the ecosystem, even if it is added to a more limited issuer policy. The default value is `true`, as this assigns the least privileges to the new participant.","default":true,"example":true,"examples":[true]},"isVerifierConstrained":{"type":"boolean","description":"Indicates whether the created participant is constrained to only verify specific types of valid credentials (`true`) or not (`false`). When set to `false`, the verifier can verify all valid credential types defined within the ecosystem, even if it is added to a more limited verifier policy. The default value is `true`, as this assigns the least privileges to the new participant.","default":true,"example":true,"examples":[true]},"status":{"type":"string","enum":["Active","Inactive"],"description":"Indicates whether the participant is active or inactive. Only active participants are included in the ecosystem policy.","default":"Inactive","example":"Active","examples":["Active"]},"country":{"type":"string","description":"The country in which the participant is based. When provided, must be a valid [Alpha 2 country code](https://www.iso.org/glossary-for-iso-3166.html) as per [ISO 3166-1](https://www.iso.org/standard/72482.html) and match the `country` value in the PEM certificate associated with the `mobile` [identifier](#operation/createEcosystemParticipant!path=identifiers&t=request) of this participant.","example":"US","examples":["US"]},"stateOrProvince":{"type":"string","description":"The state or province in which the participant is based, in [ISO 3166-2](https://www.iso.org/standard/72483.html) subdivision code format. When provided, must match the `stateOrProvinceName` value in the PEM certificate associated with the `mobile` [identifier](#operation/createEcosystemParticipant!path=identifiers&t=request) of this participant.","example":"US-AL","examples":["US-AL"]},"organizationAddress":{"type":"string","description":"The address of the organization that the participant represents.","example":"1234 Main St, City, State, 12345","examples":["1234 Main St, City, State, 12345"]},"organizationPhoneNumber":{"type":"string","description":"The phone number of the organization that the participant represents.","example":"012-3456789","examples":["012-3456789"]}}},"EcosystemPolicy":{"type":"object","properties":{"policyModifiedAt":{"description":"The timestamp when the ecosystem policy was last modified.","type":"string","format":"date-time","example":"2023-10-17T00:00:00Z","examples":["2023-10-17T00:00:00Z"]},"policyPublishedAt":{"type":"string","format":"date-time","description":"The timestamp when the policy was published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"credentials":{"description":"A map of credential IDs to credentials associated with the ecosystem policy.","type":"object","properties":{"599bf148-d711-405a-a20b-9c8a87ac8850":{"$ref":"#/components/schemas/Credential"}}},"participants":{"description":"A list of participants associated with the ecosystem policy.","type":"object","properties":{"a24e391a-c27f-4b6e-9805-1ee7e03f3c58":{"allOf":[{"$ref":"#/components/schemas/Participant"},{"type":"object","properties":{"identifiers":{"allOf":[{"$ref":"#/components/schemas/ParticipantIdentifiers"},{"type":"object","properties":{"mobile":{"type":"array","minItems":1,"items":{"type":"object","properties":{"certificatePem":{"type":"string","description":"Must be the PEM of a valid [IACA](/docs/issuance/certificates/api-reference/iaca#create-an-iaca) used by this participant to sign mDocs, as defined in annex B of [ISO/IEC 18013-5:2021](https://www.iso.org/standard/69084.html). An exception to this aforementioned definition is that IACAs with a `notBefore` date in the future are considered valid.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"docTypes":{"type":"array","description":"Defines which document types a participant is permitted to issue.\n\nNote: This is a metadata-level declaration and does not enforce validation during credential assignment or issuance.\n","items":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}}},"required":["certificatePem","docTypes"]}}}}]},"issuerAllowedCredentials":{"description":"A list of credentials that can be validly issued within the ecosystem.","type":"array","items":{"type":"string","format":"uuid"},"example":["e0a07846-44e1-41a4-b704-1ccf6eb1a5af","25fa6ffc-bf6e-417c-865c-96fcf1d7d1a3"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:EcosystemPolicy:properties:participants:properties:a24e391a-c27f-4b6e-9805-1ee7e03f3c58:allOf:1:properties:issuerAllowedCredentials:example"]},"verifierAllowedCredentials":{"description":"A list of credentials that can be validly verified within the ecosystem.","type":"array","items":{"type":"string","format":"uuid"},"example":["4e25a240-76bb-4e9f-9f93-b93be287922b","daca4a43-3ff9-4ecb-93fe-d9104e36bf74"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:EcosystemPolicy:properties:participants:properties:a24e391a-c27f-4b6e-9805-1ee7e03f3c58:allOf:1:properties:verifierAllowedCredentials:example"]}}}]}}}},"required":["policyModifiedAt","policyPublishedAt","credentials","participants"]},"IssuerCertificateDocType":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"The document type value.","example":"org.iso.18013.5.1.mDL","examples":["org.iso.18013.5.1.mDL"]}}},"IssuerPolicyCertificate":{"type":"object","required":["id","certificatePem","certificateFingerprint","docTypes"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the issuer certificate.","example":"599bf148-d711-405a-a20b-9c8a87ac8850","examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]},"certificatePem":{"type":"string","description":"The PEM-encoded issuer certificate.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\n-----END CERTIFICATE-----\r\n"]},"certificateFingerprint":{"type":"string","description":"The fingerprint of the issuer certificate.","example":"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2","examples":["a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2"]},"docTypes":{"type":"array","description":"Defines which document types the issuer certificate is permitted to issue.\n\nNote: This is a metadata-level declaration and does not enforce validation during credential assignment or issuance.\n","items":{"$ref":"#/components/schemas/IssuerCertificateDocType"}}}},"IssuerPolicyParticipant":{"type":"object","required":["id","name","issuerCertificates"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]},"name":{"type":"string","description":"The name of the participant.","example":"My Participant","examples":["My Participant"]},"issuerCertificates":{"type":"array","description":"A list of issuer certificates associated with the participant.","items":{"$ref":"#/components/schemas/IssuerPolicyCertificate"}}}},"IssuerPolicy":{"type":"object","required":["id","publishedAt","participants"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this issuer policy.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"publishedAt":{"type":"string","format":"date-time","description":"The timestamp when the issuer policy was published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"participants":{"type":"array","description":"A list of participants associated with the issuer policy.","items":{"$ref":"#/components/schemas/IssuerPolicyParticipant"}}}},"ParticipantStatus":{"type":"string","description":"The status of the participant.","enum":["Active","Inactive"],"example":"Active","examples":["Active"]},"IssuerCertificateStatus":{"type":"string","description":"The status of the issuer certificate.","enum":["Active","Inactive","Delisted"],"example":"Active","examples":["Active"]},"IssuerValidationResult":{"oneOf":[{"type":"object","required":["validated"],"properties":{"validated":{"type":"boolean","enum":[true],"example":true,"examples":[true]}}},{"type":"object","required":["validated","failReasons"],"properties":{"validated":{"type":"boolean","enum":[false],"example":false,"examples":[false]},"failReasons":{"type":"array","description":"A list of validation failure reasons, present only when `validated` is `false`. Possible values are:\n* `Certificate PEM is invalid`: the certificate PEM could not be parsed.\n* `Certificate has expired`: the certificate's validity period has ended.\n* `Certificate status is Inactive`: the certificate's status is `Inactive`.\n* `Certificate status is Delisted`: the certificate's status is `Delisted`.\n* `No docTypes are assigned to the issuer certificate`: the issuer certificate has no document types assigned.\n","items":{"type":"string"},"example":["Certificate has expired","No docTypes are assigned to the issuer certificate"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:IssuerValidationResult:oneOf:1:properties:failReasons:example"]}}}]},"IssuerPolicyPreviewCertificate":{"allOf":[{"$ref":"#/components/schemas/IssuerPolicyCertificate"},{"type":"object","required":["status","validationResult"],"properties":{"status":{"$ref":"#/components/schemas/IssuerCertificateStatus"},"validationResult":{"$ref":"#/components/schemas/IssuerValidationResult"}}}]},"IssuerPolicyPreviewParticipant":{"type":"object","required":["id","name","status","issuerCertificates"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]},"name":{"type":"string","description":"The name of the participant.","example":"My Participant","examples":["My Participant"]},"status":{"$ref":"#/components/schemas/ParticipantStatus"},"issuerCertificates":{"type":"array","description":"A list of issuer certificates associated with the participant.","items":{"$ref":"#/components/schemas/IssuerPolicyPreviewCertificate"}},"country":{"type":"string","description":"The country associated with the participant.","example":"NZ","examples":["NZ"]},"stateOrProvince":{"type":"string","description":"The state or province associated with the participant.","example":"Wellington","examples":["Wellington"]}}},"IssuerPolicyPreview":{"type":"object","required":["publishedAt","participants"],"properties":{"publishedAt":{"type":"string","format":"date-time","description":"The timestamp when the issuer policy was last published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"participants":{"type":"array","description":"A list of participants included in the issuer policy preview.","items":{"$ref":"#/components/schemas/IssuerPolicyPreviewParticipant"}}}},"VerifierPolicyCertificate":{"type":"object","required":["id","certificatePem","certificateFingerprint"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the verifier certificate.","example":"599bf148-d711-405a-a20b-9c8a87ac8850","examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]},"certificatePem":{"type":"string","description":"The PEM-encoded verifier certificate.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\n-----END CERTIFICATE-----\r\n"]},"certificateFingerprint":{"type":"string","description":"The fingerprint of the verifier certificate.","example":"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2","examples":["a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2"]}}},"VerifierPolicyParticipant":{"type":"object","required":["id","name","verifierCertificates"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]},"name":{"type":"string","description":"The name of the participant.","example":"My Participant","examples":["My Participant"]},"verifierCertificates":{"type":"array","description":"A list of verifier certificates associated with the participant.","items":{"$ref":"#/components/schemas/VerifierPolicyCertificate"}}}},"VerifierPolicy":{"type":"object","required":["id","publishedAt","participants"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this verifier policy.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"publishedAt":{"type":"string","format":"date-time","description":"The timestamp when the verifier policy was published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"participants":{"type":"array","description":"A list of participants associated with the verifier policy.","items":{"$ref":"#/components/schemas/VerifierPolicyParticipant"}}}},"VerifierCertificateStatus":{"type":"string","description":"The status of the verifier certificate.","enum":["Active","Inactive","Delisted"],"example":"Active","examples":["Active"]},"VerifierValidationResult":{"oneOf":[{"type":"object","required":["validated"],"properties":{"validated":{"type":"boolean","enum":[true],"example":true,"examples":[true]}}},{"type":"object","required":["validated","failReasons"],"properties":{"validated":{"type":"boolean","enum":[false],"example":false,"examples":[false]},"failReasons":{"type":"array","description":"A list of validation failure reasons, present only when `validated` is `false`. Possible values are:\n* `Certificate PEM is invalid`: the certificate PEM could not be parsed.\n* `Certificate has expired`: the certificate's validity period has ended.\n* `Certificate status is Inactive`: the certificate's status is `Inactive`.\n* `Certificate status is Delisted`: the certificate's status is `Delisted`.\n","items":{"type":"string"},"example":["Certificate has expired"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:VerifierValidationResult:oneOf:1:properties:failReasons:example"]}}}]},"VerifierPolicyPreviewCertificate":{"allOf":[{"$ref":"#/components/schemas/VerifierPolicyCertificate"},{"type":"object","required":["status","validationResult"],"properties":{"status":{"$ref":"#/components/schemas/VerifierCertificateStatus"},"validationResult":{"$ref":"#/components/schemas/VerifierValidationResult"}}}]},"VerifierPolicyPreviewParticipant":{"type":"object","required":["id","name","status","verifierCertificates"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]},"name":{"type":"string","description":"The name of the participant.","example":"My Participant","examples":["My Participant"]},"status":{"$ref":"#/components/schemas/ParticipantStatus"},"verifierCertificates":{"type":"array","description":"A list of verifier certificates associated with the participant.","items":{"$ref":"#/components/schemas/VerifierPolicyPreviewCertificate"}},"country":{"type":"string","description":"The country associated with the participant.","example":"NZ","examples":["NZ"]},"stateOrProvince":{"type":"string","description":"The state or province associated with the participant.","example":"Wellington","examples":["Wellington"]}}},"VerifierPolicyPreview":{"type":"object","required":["publishedAt","participants"],"properties":{"publishedAt":{"type":"string","format":"date-time","description":"The timestamp when the verifier policy was last published.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"participants":{"type":"array","description":"A list of participants included in the verifier policy preview.","items":{"$ref":"#/components/schemas/VerifierPolicyPreviewParticipant"}}}},"ParticipantContactResponse":{"type":"object","description":"Point of contact associated with a participant.","required":["id","fullName","active","createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"id":{"type":"string","format":"uuid","example":"920f2489-d953-42f2-b2dd-f37c29b818cf","description":"Unique identifier of a specific point of contact entry.","examples":["920f2489-d953-42f2-b2dd-f37c29b818cf"]},"fullName":{"type":"string","example":"John Doe","description":"Full name of the point of contact.","examples":["John Doe"]},"active":{"type":"boolean","example":true,"description":"Indicates whether the point of contact is active.","examples":[true]},"emailAddress":{"type":"string","format":"email","example":"john.doe@example.com","description":"Email address of the point of contact.","examples":["john.doe@example.com"]},"primaryPhoneNumber":{"type":"string","example":1234567890,"description":"Primary phone number of the point of contact.","examples":[1234567890]},"secondaryPhoneNumber":{"type":"string","example":987654321,"description":"Secondary phone number of the point of contact.","examples":[987654321]},"createdBy":{"type":"object","properties":{"clientId":{"type":"string","example":"f7b9ecfc-8431-470e-a1de-94b68dd92f68","description":"Identifier of the API client that created the point of contact.","examples":["f7b9ecfc-8431-470e-a1de-94b68dd92f68"]},"managementUserId":{"type":"string","example":"ab16dc65-b58e-4be2-ba77-a6f35021cb2b","description":"Identifier of the user that created the point of contact.","examples":["ab16dc65-b58e-4be2-ba77-a6f35021cb2b"]}}},"createdAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"Timestamp indicating when the point of contact was created.","examples":["2025-07-01T00:00:00.000Z"]},"lastModifiedBy":{"type":"object","properties":{"clientId":{"type":"string","example":"f7b9ecfc-8431-470e-a1de-94b68dd92f68","description":"Identifier of the API client that created the point of contact.","examples":["f7b9ecfc-8431-470e-a1de-94b68dd92f68"]},"managementUserId":{"type":"string","example":"ab16dc65-b58e-4be2-ba77-a6f35021cb2b","description":"Identifier of the user that created the point of contact.","examples":["ab16dc65-b58e-4be2-ba77-a6f35021cb2b"]}}},"lastModifiedAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"Timestamp indicating when the point of contact was last updated.","examples":["2025-07-01T00:00:00.000Z"]}}},"ParticipantContactRequest":{"type":"object","description":"Point of contact associated with a participant.","required":["fullName","active"],"properties":{"fullName":{"type":"string","example":"John Doe","description":"Full name of the point of contact.","examples":["John Doe"]},"active":{"type":"boolean","example":true,"description":"Indicates whether the point of contact is active.","examples":[true]},"emailAddress":{"type":"string","format":"email","example":"john.doe@example.com","description":"Email address of the point of contact.","examples":["john.doe@example.com"]},"primaryPhoneNumber":{"type":"string","example":1234567890,"description":"Primary phone number of the point of contact.","examples":[1234567890]},"secondaryPhoneNumber":{"type":"string","example":987654321,"description":"Secondary phone number of the point of contact.","examples":[987654321]}}},"ParticipantEvidence":{"type":"object","description":"PDF evidence associated with a participant.","properties":{"filename":{"type":"string","example":"pdf-evidence.pdf","description":"Filename of the uploaded PDF.","examples":["pdf-evidence.pdf"]},"fileDescription":{"type":"string","example":"This is an example file description","description":"Optional plaintext description of the PDF evidence.","examples":["This is an example file description"]},"id":{"type":"string","format":"uuid","example":"920f2489-d953-42f2-b2dd-f37c29b818cf","description":"Unique identifier of the PDF evidence.","examples":["920f2489-d953-42f2-b2dd-f37c29b818cf"]},"uploadedBy":{"type":"object","description":"Identifiers of the user that uploaded the PDF evidence.","properties":{"clientId":{"type":"string","description":"Identifier of the API client that uploaded the PDF."},"managementUserId":{"type":"string","description":"Identifier of the user that uploaded the PDF."}}},"uploadedAt":{"type":"string","format":"date-time","example":"2025-07-01T00:00:00.000Z","description":"Timestamp indicating when the PDF was uploaded.","examples":["2025-07-01T00:00:00.000Z"]}}},"CredentialProfileMobile":{"type":"string","enum":["mobile"],"example":"mobile","examples":["mobile"]},"CredentialMobile":{"title":"Mobile","type":"object","required":["id","ecosystemId","profile","docType","name"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true,"example":"49b6beb2-1006-4fb7-9284-7ec920475abe","examples":["49b6beb2-1006-4fb7-9284-7ec920475abe"]},"ecosystemId":{"$ref":"#/components/schemas/id"},"profile":{"$ref":"#/components/schemas/CredentialProfileMobile"},"docType":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]},"name":{"type":"string","description":"The name of the credential","minLength":1,"maxLength":50,"example":"Driver's License","examples":["Driver's License"]}}},"LinkCertificateInfoResponse":{"type":"object","description":"Details of the link certificate tying this certificate to its predecessor, present only when the certificate was added as a successor.","required":["issuerCertificateId","certificatePem","certificateFingerprint"],"properties":{"issuerCertificateId":{"type":"string","format":"uuid","description":"Unique identifier of the predecessor certificate this certificate is linked to. Despite the field name, this is the predecessor certificate's ID regardless of certificate type, so it applies to both issuer and verifier certificates.","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]},"certificatePem":{"type":"string","description":"The link certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash fingerprint of the link certificate.","example":"57B178A6C2B8C1877DBA515AD4FD60F9C805EFC309287182DB7DEBFE43A22928","examples":["57B178A6C2B8C1877DBA515AD4FD60F9C805EFC309287182DB7DEBFE43A22928"]}}},"IssuerCertificateResponse":{"type":"object","required":["id","certificatePem","certificateFingerprint","status","docTypes"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the issuer certificate.","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash fingerprint of the certificate.","example":"57B178A6C2B8C1877DBA515AD4FD60F9C805EFC309287182DB7DEBFE43A22928","examples":["57B178A6C2B8C1877DBA515AD4FD60F9C805EFC309287182DB7DEBFE43A22928"]},"certificatePem":{"type":"string","description":"The issuer certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the issuer certificate.","example":"Inactive","examples":["Inactive"]},"docTypes":{"type":"array","description":"Document types that the certificate is permitted to issue.","items":{"type":"object","required":["value"],"properties":{"value":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}}}},"linkCertificateInfo":{"$ref":"#/components/schemas/LinkCertificateInfoResponse"}}},"LinkCertificateInfoRequest":{"type":"object","description":"Links this certificate to a previously uploaded certificate as its\nsuccessor, maintaining trust continuity across a certificate rotation.\n\nWhen provided, the new certificate is added as a successor to the\npreviously uploaded certificate identified by `issuerCertificateId`, and\nthe supplied link certificate ties the two together. The link certificate\nmust chain to that predecessor certificate.","required":["issuerCertificateId","certificatePem"],"properties":{"issuerCertificateId":{"type":"string","format":"uuid","description":"Unique identifier of the previously uploaded certificate to link to as the predecessor. Despite the field name, this is the predecessor certificate's ID regardless of certificate type, so it applies to both issuer and verifier certificates.","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]},"certificatePem":{"type":"string","description":"The link certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]}}},"IssuerCertificateCreateRequest":{"type":"object","required":["certificatePem"],"properties":{"certificatePem":{"type":"string","description":"The issuer certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the issuer certificate.","default":"Inactive","example":"Inactive","examples":["Inactive"]},"docTypes":{"type":"array","description":"Document types that the certificate is permitted to issue.","items":{"type":"object","required":["value"],"properties":{"value":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}}}},"linkCertificateInfo":{"$ref":"#/components/schemas/LinkCertificateInfoRequest"}}},"IssuerCertificateUpdateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the issuer certificate.","example":"Active","examples":["Active"]},"docTypes":{"type":"array","description":"Document types that the certificate is permitted to issue.","items":{"type":"object","required":["value"],"properties":{"value":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}}}}}},"VerifierCertificateResponse":{"type":"object","required":["id","certificatePem","certificateFingerprint","status"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the verifier certificate.","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash fingerprint of the certificate.","example":"65A98EFAB9A22A1829391B22B668F9F1B758094C1A19D599B516BBF63CBF0015","examples":["65A98EFAB9A22A1829391B22B668F9F1B758094C1A19D599B516BBF63CBF0015"]},"certificatePem":{"type":"string","description":"The verifier certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIICTDCCAfKgAwIBAgIKeKcjIBGvXfS/sjAKBggqhkjOPQQDAjAwMQswCQYDVQQG\r\nEwJVUzEhMB8GA1UEAwwYRXhhbXBsZSBWZXJpZmllciByb290IENBMB4XDTI1MDgy\r\nNzIxMzMxNFoXDTMwMDgyNjIxMzMxNFowMDELMAkGA1UEBhMCVVMxITAfBgNVBAMM\r\nGEV4YW1wbGUgVmVyaWZpZXIgcm9vdCBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEH\r\nA0IABNJHM5ZE+fpVn7b9WwjVBiOiZq9eNXq1JkNj/6ZLe+2GkaRY/WE2Xbg7yx++\r\nh3QEdX3sGKzGO7dygQALBe/4qEyjgfMwgfAwHQYDVR0OBBYEFK8ogqdUH2vZlC1y\r\nNf619a8fnx8KMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEAMHsG\r\nA1UdHwR0MHIwcKBuoGyGamh0dHBzOi8vbGVhcm4udmlpLmF1MDEubWF0dHIuZ2xv\r\nYmFsL3YyL3ByZXNlbnRhdGlvbnMvY2VydGlmaWNhdGVzL2Q3YzE3ODI4LThkMTgt\r\nNDYyZS1iNDk3LWNjNjI2NWM4ZmQxYi9jcmwwLgYDVR0SBCcwJYYjaHR0cHM6Ly9s\r\nZWFybi52aWkuYXUwMS5tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSAAwRQIhAOqD\r\n0DF3rohBitl5jAj6x1164uGGj6yAhF/eE4aJeGc+AiAgaUYHzobzaPEWd+jZOh/A\r\nq8WgVJ+8sLx9WdJDs9/shQ==\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIICTDCCAfKgAwIBAgIKeKcjIBGvXfS/sjAKBggqhkjOPQQDAjAwMQswCQYDVQQG\r\nEwJVUzEhMB8GA1UEAwwYRXhhbXBsZSBWZXJpZmllciByb290IENBMB4XDTI1MDgy\r\nNzIxMzMxNFoXDTMwMDgyNjIxMzMxNFowMDELMAkGA1UEBhMCVVMxITAfBgNVBAMM\r\nGEV4YW1wbGUgVmVyaWZpZXIgcm9vdCBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEH\r\nA0IABNJHM5ZE+fpVn7b9WwjVBiOiZq9eNXq1JkNj/6ZLe+2GkaRY/WE2Xbg7yx++\r\nh3QEdX3sGKzGO7dygQALBe/4qEyjgfMwgfAwHQYDVR0OBBYEFK8ogqdUH2vZlC1y\r\nNf619a8fnx8KMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEAMHsG\r\nA1UdHwR0MHIwcKBuoGyGamh0dHBzOi8vbGVhcm4udmlpLmF1MDEubWF0dHIuZ2xv\r\nYmFsL3YyL3ByZXNlbnRhdGlvbnMvY2VydGlmaWNhdGVzL2Q3YzE3ODI4LThkMTgt\r\nNDYyZS1iNDk3LWNjNjI2NWM4ZmQxYi9jcmwwLgYDVR0SBCcwJYYjaHR0cHM6Ly9s\r\nZWFybi52aWkuYXUwMS5tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSAAwRQIhAOqD\r\n0DF3rohBitl5jAj6x1164uGGj6yAhF/eE4aJeGc+AiAgaUYHzobzaPEWd+jZOh/A\r\nq8WgVJ+8sLx9WdJDs9/shQ==\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the verifier certificate.","example":"Inactive","examples":["Inactive"]},"linkCertificateInfo":{"$ref":"#/components/schemas/LinkCertificateInfoResponse"}}},"VerifierCertificateCreateRequest":{"type":"object","required":["certificatePem"],"properties":{"certificatePem":{"type":"string","description":"The verifier certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\r\nMIICTDCCAfKgAwIBAgIKeKcjIBGvXfS/sjAKBggqhkjOPQQDAjAwMQswCQYDVQQG\r\nEwJVUzEhMB8GA1UEAwwYRXhhbXBsZSBWZXJpZmllciByb290IENBMB4XDTI1MDgy\r\nNzIxMzMxNFoXDTMwMDgyNjIxMzMxNFowMDELMAkGA1UEBhMCVVMxITAfBgNVBAMM\r\nGEV4YW1wbGUgVmVyaWZpZXIgcm9vdCBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEH\r\nA0IABNJHM5ZE+fpVn7b9WwjVBiOiZq9eNXq1JkNj/6ZLe+2GkaRY/WE2Xbg7yx++\r\nh3QEdX3sGKzGO7dygQALBe/4qEyjgfMwgfAwHQYDVR0OBBYEFK8ogqdUH2vZlC1y\r\nNf619a8fnx8KMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEAMHsG\r\nA1UdHwR0MHIwcKBuoGyGamh0dHBzOi8vbGVhcm4udmlpLmF1MDEubWF0dHIuZ2xv\r\nYmFsL3YyL3ByZXNlbnRhdGlvbnMvY2VydGlmaWNhdGVzL2Q3YzE3ODI4LThkMTgt\r\nNDYyZS1iNDk3LWNjNjI2NWM4ZmQxYi9jcmwwLgYDVR0SBCcwJYYjaHR0cHM6Ly9s\r\nZWFybi52aWkuYXUwMS5tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSAAwRQIhAOqD\r\n0DF3rohBitl5jAj6x1164uGGj6yAhF/eE4aJeGc+AiAgaUYHzobzaPEWd+jZOh/A\r\nq8WgVJ+8sLx9WdJDs9/shQ==\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIICTDCCAfKgAwIBAgIKeKcjIBGvXfS/sjAKBggqhkjOPQQDAjAwMQswCQYDVQQG\r\nEwJVUzEhMB8GA1UEAwwYRXhhbXBsZSBWZXJpZmllciByb290IENBMB4XDTI1MDgy\r\nNzIxMzMxNFoXDTMwMDgyNjIxMzMxNFowMDELMAkGA1UEBhMCVVMxITAfBgNVBAMM\r\nGEV4YW1wbGUgVmVyaWZpZXIgcm9vdCBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEH\r\nA0IABNJHM5ZE+fpVn7b9WwjVBiOiZq9eNXq1JkNj/6ZLe+2GkaRY/WE2Xbg7yx++\r\nh3QEdX3sGKzGO7dygQALBe/4qEyjgfMwgfAwHQYDVR0OBBYEFK8ogqdUH2vZlC1y\r\nNf619a8fnx8KMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEAMHsG\r\nA1UdHwR0MHIwcKBuoGyGamh0dHBzOi8vbGVhcm4udmlpLmF1MDEubWF0dHIuZ2xv\r\nYmFsL3YyL3ByZXNlbnRhdGlvbnMvY2VydGlmaWNhdGVzL2Q3YzE3ODI4LThkMTgt\r\nNDYyZS1iNDk3LWNjNjI2NWM4ZmQxYi9jcmwwLgYDVR0SBCcwJYYjaHR0cHM6Ly9s\r\nZWFybi52aWkuYXUwMS5tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSAAwRQIhAOqD\r\n0DF3rohBitl5jAj6x1164uGGj6yAhF/eE4aJeGc+AiAgaUYHzobzaPEWd+jZOh/A\r\nq8WgVJ+8sLx9WdJDs9/shQ==\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the verifier certificate.","default":"Inactive","example":"Inactive","examples":["Inactive"]},"linkCertificateInfo":{"$ref":"#/components/schemas/LinkCertificateInfoRequest"}}},"VerifierCertificateUpdateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Active","Inactive","Delisted"],"description":"The status of the verifier certificate.","example":"Active","examples":["Active"]}}},"EcosystemPolicyPreview":{"type":"object","properties":{"policyModifiedAt":{"description":"The timestamp when the ecosystem policy was last modified.","type":"string","format":"date-time","example":"2023-10-17T00:00:00Z","examples":["2023-10-17T00:00:00Z"]},"credentials":{"description":"A map of credential IDs to credentials associated with the ecosystem policy.","type":"object","properties":{"599bf148-d711-405a-a20b-9c8a87ac8850":{"$ref":"#/components/schemas/Credential"}}},"participants":{"properties":{"a24e391a-c27f-4b6e-9805-1ee7e03f3c58":{"allOf":[{"$ref":"#/components/schemas/Participant"},{"type":"object","properties":{"identifiers":{"allOf":[{"$ref":"#/components/schemas/ParticipantIdentifiers"},{"type":"object","properties":{"mobile":{"type":"array","minItems":1,"items":{"type":"object","properties":{"certificatePem":{"type":"string","description":"Must be the PEM of a valid [IACA](/docs/issuance/certificates/api-reference/iaca#create-an-iaca) used by this participant to sign mDocs, as defined in annex B of [ISO/IEC 18013-5:2021](https://www.iso.org/standard/69084.html). An exception to this aforementioned definition is that IACAs with a `notBefore` date in the future are considered valid.","example":"-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n","examples":["-----BEGIN CERTIFICATE-----\r\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\r\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\r\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\r\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\r\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\r\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\r\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\r\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\r\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\r\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\r\n-----END CERTIFICATE-----\r\n"]},"status":{"type":"string","description":"The status of the mobile identifier.","enum":["Active","Inactive","Delisted"],"example":"Active","examples":["Active"]},"docTypes":{"type":"array","description":"Determines the document types that a participant is permitted to issue. This parameter governs how the participant’s permissions are represented in published VICALs and ecosystem policies, limiting issuance to the defined `docTypes`.\n\nNote: This is a metadata-level declaration and does not enforce validation during credential assignment or issuance.\n","items":{"type":"string","example":"org.iso.18013.5.1","examples":["org.iso.18013.5.1"]}},"validationResult":{"type":"object","properties":{"validated":{"type":"boolean","example":true,"examples":[true]},"failReasons":{"type":"array","description":"A list of validation failure reasons, present only when `validated` is `false`.","items":{"type":"string"}}},"required":["validated"]}},"required":["certificatePem","status","docTypes","validationResult"]}}}}]},"issuerAllowedCredentials":{"description":"A list of credentials that can be validly issued within the ecosystem.","type":"array","items":{"type":"string","format":"uuid"},"example":["e0a07846-44e1-41a4-b704-1ccf6eb1a5af","25fa6ffc-bf6e-417c-865c-96fcf1d7d1a3"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:EcosystemPolicyPreview:properties:participants:properties:a24e391a-c27f-4b6e-9805-1ee7e03f3c58:allOf:1:properties:issuerAllowedCredentials:example"]},"verifierAllowedCredentials":{"description":"A list of credentials that can be validly verified within the ecosystem.","type":"array","items":{"type":"string","format":"uuid"},"example":["4e25a240-76bb-4e9f-9f93-b93be287922b","daca4a43-3ff9-4ecb-93fe-d9104e36bf74"],"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:EcosystemPolicyPreview:properties:participants:properties:a24e391a-c27f-4b6e-9805-1ee7e03f3c58:allOf:1:properties:verifierAllowedCredentials:example"]}}}]}}}},"required":["policyModifiedAt","credentials","participants"]},"Vical":{"type":"object","required":["vicalIssueID","date"],"properties":{"vicalIssueID":{"description":"Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.","type":"integer","format":"int32","example":1337,"examples":[1337]},"date":{"description":"Date and time of VICAL issuance.","type":"string","format":"date-time","example":"2024-07-28T23:01:13.000Z","examples":["2024-07-28T23:01:13.000Z"]}}},"VicalWithFilename":{"allOf":[{"$ref":"#/components/schemas/Vical"},{"type":"object","required":["filename","isAutoPublished"],"properties":{"filename":{"type":"string","description":"Name of the VICAL file.","example":"vical-2024-07-28-1722164473000.cbor","examples":["vical-2024-07-28-1722164473000.cbor"]},"isAutoPublished":{"type":"boolean","description":"Indicates whether the VICAL was automatically published.","example":false,"examples":[false]}}}]},"vicalIssueID":{"description":"Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.","type":"integer","format":"int32","example":1337,"examples":[1337]},"VicalConfigurationData":{"type":"object","properties":{"vicalProvider":{"description":"VICAL provider name.","type":"string","example":"Mattr","examples":["Mattr"]},"autoPublish":{"type":"object","description":"Configuration for automatic scheduled publishing of VICALs.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Indicates whether automatic scheduled publishing of VICALs is enabled.","example":true,"examples":[true]},"frequency":{"type":"string","enum":["Daily","Weekly"],"description":"Frequency of automatic VICAL publishing. Required when `enabled` is `true`, ignored when `enabled` is `false`.","example":"Daily","examples":["Daily"]}}}},"required":["vicalProvider"]},"DtsCaResponse":{"type":"object","required":["id","active","certificatePem","certificateFingerprint","certificateData","isManaged"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this DTS root CA certificate.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"active":{"type":"boolean","description":"Indicates whether the DTS root CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate (intermediate CA or signer) certificates: you can build a complete certificate chain while the root CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain. Only one DTS root CA certificate can be active at a time.\n","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"DTS root CA certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash of DTS root CA certificate content.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore","organisationName"],"properties":{"commonName":{"type":"string","description":"The common name of the DTS root CA certificate.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"The country associated with the DTS root CA certificate.","example":"US","examples":["US"]},"organisationName":{"type":"string","description":"The organization associated with the DTS root CA certificate.","example":"Example Inc.","examples":["Example Inc."]},"notAfter":{"type":"string","format":"date-time","description":"The DTS root CA certificate's expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"The DTS root CA certificate's validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}},"isManaged":{"type":"boolean","description":"Indicates whether the private key for this DTS root CA certificate is managed by MATTR (`true`) or out of band by the customer as an external certificate (`false`).","example":true,"examples":[true]},"useIntermediateCa":{"type":"boolean","description":"When `true`, this DTS root CA certificate uses the 3-tier certificate model, requiring and using DTS intermediate CA certificates as part of its chain of trust for signing operations. When `false`, the 2-tier model is used and the DTS root CA signs signer certificates directly. For an explanation of the 2-tier and 3-tier models, refer to the [DTS certificates overview](https://learn.mattr.global/docs/digital-trust-service/certificates-overview#certificate-models-2-tier-and-3-tier).","example":true,"examples":[true]}}},"DtsCaCreateRequestManaged":{"title":"Managed DTS root CA certificate","type":"object","required":["organisationName"],"properties":{"commonName":{"type":"string","description":"Indicates the common name of the DTS root CA certificate. When specified, the value must be a valid `PrintableString` and cannot be an empty string. If not provided and a custom domain is configured and verified, the custom domain is used followed by the words `DTS CA`. If no custom domain is configured, the tenant subdomain is used instead.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"Indicates the DTS provider's country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid [Alpha 2 country code](https://www.iso.org/glossary-for-iso-3166.html) as per [ISO 3166-1](https://www.iso.org/standard/72482.html).","example":"US","examples":["US"]},"organisationName":{"type":"string","description":"Indicates the organization associated with the DTS root CA certificate.","example":"Example Inc.","examples":["Example Inc."]},"notAfter":{"type":"string","format":"date-time","description":"Used to set the date and time when the DTS root CA certificate expires.\n- If not provided, calculated as `notBefore` + 20 years.\n- If not provided and `notBefore` is not provided, calculated as time of creation + 20 years.\n- Maximum value is 20 years from creation.\n- Must be after `notBefore`, if provided.\n","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"Used to set the date and time when the DTS root CA certificate becomes valid and can be used to sign other intermediate certificates.\n- Must not be in the past.\n- Must be before `notAfter`.\n","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}},"DtsCaCreateRequestUnmanaged":{"title":"Unmanaged DTS root CA certificate","type":"object","required":["certificatePem"],"properties":{"certificatePem":{"type":"string","description":"DTS root CA certificate in PEM format. The certificate must be valid and not expired.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"useIntermediateCa":{"type":"boolean","description":"When `true`, this DTS root CA certificate uses the 3-tier certificate model, requiring and using DTS intermediate CA certificates as part of its chain of trust for signing operations. When `false` (the default), the 2-tier model is used and the DTS root CA signs signer certificates directly. This field can only be set for unmanaged (external) DTS root CA certificates. For an explanation of the 2-tier and 3-tier models, refer to the [DTS certificates overview](https://learn.mattr.global/docs/digital-trust-service/certificates-overview#certificate-models-2-tier-and-3-tier).","example":true,"default":false,"examples":[true]}}},"dtsCaCertificateId":{"description":"Unique identifier of the DTS root CA certificate.","type":"string","format":"uuid","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"DtsCaUpdateRequest":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicates whether the DTS root CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate (intermediate CA or signer) certificates: you can build a complete certificate chain while the root CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain. Only one DTS root CA certificate can be active at a time.\n","example":true,"examples":[true]},"useIntermediateCa":{"type":"boolean","description":"When `true`, this DTS root CA certificate uses the 3-tier certificate model, requiring and using DTS intermediate CA certificates as part of its chain of trust for signing operations. When `false`, the 2-tier model is used and the DTS root CA signs signer certificates directly. Changing this value requires deleting all subordinate certificates. This field can only be set for unmanaged (external) DTS root CA certificates. For an explanation of the 2-tier and 3-tier models, refer to the [DTS certificates overview](https://learn.mattr.global/docs/digital-trust-service/certificates-overview#certificate-models-2-tier-and-3-tier).","example":true,"examples":[true]}}},"DtsCaPublicResponse":{"type":"object","properties":{"rootCertificates":{"type":"array","items":{"type":"object","properties":{"certificate":{"type":"string","description":"Certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"notBefore":{"type":"string","format":"date-time","description":"The DTS root CA certificate's validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]},"notAfter":{"type":"string","format":"date-time","description":"The DTS root CA certificate's expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"fingerprint":{"type":"string","description":"Hash that includes all the DTS root CA certificate data and its signature.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"commonName":{"type":"string","description":"The common name of the DTS root CA certificate.","example":"MATTR DTS Root CA","examples":["MATTR DTS Root CA"]},"intermediateCertificates":{"type":"array","items":{"type":"object","properties":{"certificate":{"type":"string","description":"Certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"notBefore":{"type":"string","format":"date-time","description":"The DTS intermediate CA certificate's validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]},"notAfter":{"type":"string","format":"date-time","description":"The DTS intermediate CA certificate's expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"fingerprint":{"type":"string","description":"SHA-256 hash of DTS intermediate CA certificate content.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"commonName":{"type":"string","description":"The common name of the DTS intermediate CA certificate.","example":"MATTR DTS Intermediate CA","examples":["MATTR DTS Intermediate CA"]}}}}}}}}},"DtsIntermediateCaResponse":{"type":"object","required":["id","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for this DTS intermediate CA certificate.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"active":{"type":"boolean","description":"Indicates whether the DTS intermediate CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate signer certificates: you can build a complete certificate chain while the intermediate CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain.\n","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"DTS intermediate CA certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash of DTS intermediate CA certificate content.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore","organisationName"],"properties":{"commonName":{"type":"string","description":"The common name of the DTS intermediate CA certificate.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"The country associated with the DTS intermediate CA certificate. Must match the country of the DTS root CA certificate.","example":"US","examples":["US"]},"organisationName":{"type":"string","description":"The organization associated with the DTS intermediate CA certificate.","example":"Example Inc.","examples":["Example Inc."]},"notAfter":{"type":"string","format":"date-time","description":"The DTS intermediate CA certificate's expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"The DTS intermediate CA certificate's validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}},"usages":{"type":"array","items":{"type":"string","enum":["VICAL","RICAL"]}},"caCertificateId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS root CA certificate used to sign the intermediate certificate."}}},"dtsIntermediateCaCertificateId":{"description":"Unique identifier of the DTS intermediate CA certificate.","type":"string","format":"uuid","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"DtsIntermediateCaUpdateRequest":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicates whether the DTS intermediate CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate signer certificates: you can build a complete certificate chain while the intermediate CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain.\n","example":true,"examples":[true]},"usages":{"type":"array","items":{"type":"string","enum":["VICAL","RICAL"]}}}},"UpdateVicalSignerResponse":{"title":"VICAL Signer with certificate","description":"VICAL signer after a VICAL Signer Certificate (VSC) has been uploaded. Includes the uploaded certificate in PEM format, as well as the certificate's fingerprint and data.","type":"object","required":["id","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Each VICAL signer will have a unique identifier which must be provided when using this VICAL signer to sign a VICAL.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"active":{"type":"boolean","description":"Indicates whether the VICAL signer is active. Active VICAL signers are included in the selection process MATTR VII uses when choosing the signer to sign a VICAL, where MATTR VII prefers the most recently created active VICAL signer. A VICAL signer can only be set to active once a VICAL Signer Certificate (VSC) has been associated with it.\n","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"VICAL Signer Certificate (VSC) in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash of all VSC certificate data and signature.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore"],"properties":{"commonName":{"type":"string","description":"The common name of the VSC.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"The country associated with the VSC.","example":"US","examples":["US"]},"notAfter":{"type":"string","format":"date-time","description":"VSC expiration date and time.","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"VSC validity period start date and time.","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}},"caId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"intermediateCaId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS intermediate CA certificate used to sign the VICAL signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]}}},"CreateVicalSignerResponse":{"title":"VICAL Signer without certificate","description":"VICAL signer before a VICAL Signer Certificate (VSC) has been uploaded. Includes the Certificate Signing Request (CSR).","type":"object","required":["id","csrPem","caId","active"],"properties":{"id":{"type":"string","format":"uuid","description":"Each VICAL signer will have a unique identifier which must be provided when using this VICAL signer to sign a VICAL.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"csrPem":{"type":"string","description":"The X.509 Certificate Signing Request (CSR) in PEM format, base64 encoded. Use this CSR to generate a valid certificate, then update the VICAL signer with the resulting certificate.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----"]},"caId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"intermediateCaId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS intermediate CA certificate used to sign the VICAL signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"active":{"type":"boolean","description":"Indicates whether the VICAL signer is active.\n- Active VICAL signers are included in the selection process MATTR VII uses when choosing the signer to sign a VICAL, where MATTR VII prefers the most recently created active VICAL signer.\n- VICAL signers are created as inactive by default, and can only be set to active once a VICAL Signer Certificate (VSC) has been associated with them.\n","enum":[false],"example":false,"examples":[false]}}},"VicalSignerCreateRequest":{"type":"object","oneOf":[{"required":["caId"]},{"required":["intermediateCaId"]}],"properties":{"caId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.\n- Must be an unmanaged (external) DTS root CA certificate.\n","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"intermediateCaId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS intermediate CA certificate that will be used for signing the VICAL signer.\n","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]}}},"vicalSignerId":{"description":"Unique identifier of the VICAL signer.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","examples":["123e4567-e89b-12d3-a456-426614174000"]},"VicalSignerUpdateRequest":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates whether the VICAL signer is active. Active VICAL signers are included in the selection process MATTR VII uses when choosing the signer to sign a VICAL, where MATTR VII prefers the most recently created active VICAL signer. A VICAL signer can only be set to active once a VICAL Signer Certificate (VSC) has been associated with it.\n","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"VICAL Signer Certificate (VSC) in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]}}},"Rical":{"type":"object","required":["ricalIssueID","date"],"properties":{"ricalIssueID":{"description":"Unique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.","type":"integer","format":"int32","example":1337,"examples":[1337]},"date":{"description":"Date and time of RICAL issuance.","type":"string","format":"date-time","example":"2024-07-28T23:01:13.000Z","examples":["2024-07-28T23:01:13.000Z"]}}},"RicalWithFilename":{"allOf":[{"$ref":"#/components/schemas/Rical"},{"type":"object","required":["filename","isAutoPublished"],"properties":{"filename":{"type":"string","description":"Name of the RICAL file.","example":"rical-2024-07-28-1722164473000.cbor","examples":["rical-2024-07-28-1722164473000.cbor"]},"isAutoPublished":{"type":"boolean","description":"Indicates whether the RICAL was automatically published.","example":false,"examples":[false]}}}]},"ricalIssueID":{"description":"Unique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.","type":"integer","format":"int32","example":1337,"examples":[1337]},"RicalConfigurationData":{"type":"object","properties":{"ricalProvider":{"description":"RICAL provider name.","type":"string","example":"MATTR","examples":["MATTR"]},"autoPublish":{"type":"object","description":"Configuration for automatic scheduled publishing of RICALs.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Indicates whether automatic scheduled publishing of RICALs is enabled.","example":true,"examples":[true]},"frequency":{"type":"string","enum":["Daily","Weekly"],"description":"Frequency of automatic RICAL publishing. Required when `enabled` is `true`, ignored when `enabled` is `false`.","example":"Daily","examples":["Daily"]}}}},"required":["ricalProvider"]},"UpdateRicalSignerResponse":{"title":"RICAL Signer with certificate","description":"RICAL signer after a RICAL Signer Certificate has been uploaded. Includes the uploaded certificate in PEM format, as well as the certificate's fingerprint and data.","type":"object","required":["id","active","certificatePem","certificateFingerprint","certificateData"],"properties":{"id":{"type":"string","format":"uuid","description":"Each RICAL signer will have a unique identifier which must be provided when using this RICAL signer to sign a RICAL.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"active":{"type":"boolean","description":"Indicates if the RICAL signer is active. Only active RICAL signers can be used to sign RICALs.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"RICAL Signer Certificate in PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]},"certificateFingerprint":{"type":"string","description":"SHA-256 hash of the certificate content, including all certificate data and its signature.","example":"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172","examples":["f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172"]},"certificateData":{"type":"object","required":["commonName","country","notAfter","notBefore"],"properties":{"commonName":{"type":"string","description":"The common name of the RICAL signer certificate.","example":"example.com","examples":["example.com"]},"country":{"type":"string","description":"The country associated with the RICAL signer certificate.","example":"US","examples":["US"]},"notAfter":{"type":"string","format":"date-time","description":"Certificate expiration date and time.\n- Cannot be in the past.\n- Cannot be later than the `notAfter` of the CAs used to sign this RICAL signer: the DTS root CA in the 2-tier model, or both the DTS root CA and the DTS intermediate CA in the 3-tier model. A certificate cannot outlive the CA that issued it.\n- Must be after `notBefore`.\n","example":"2024-10-22T00:00:00Z","examples":["2024-10-22T00:00:00Z"]},"notBefore":{"type":"string","format":"date-time","description":"Certificate validity period start date and time.\n- Cannot be in the future.\n- Cannot be earlier than the `notBefore` of the CAs used to sign this RICAL signer: the DTS root CA in the 2-tier model, or both the DTS root CA and the DTS intermediate CA in the 3-tier model. A certificate cannot be valid before the CA that issued it.\n- Must be before `notAfter`.\n","example":"2023-10-22T00:00:00Z","examples":["2023-10-22T00:00:00Z"]}}}}},"CreateRicalSignerResponse":{"title":"RICAL Signer without certificate","description":"RICAL signer before a RICAL Signer Certificate has been uploaded. Includes the Certificate Signing Request (CSR).","type":"object","required":["id","csrPem","active"],"properties":{"id":{"type":"string","format":"uuid","description":"Each RICAL signer will have a unique identifier which must be provided when using this RICAL signer to sign a RICAL.","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]},"csrPem":{"type":"string","description":"The X.509 Certificate Signing Request (CSR) in PEM format. Use this CSR to generate a valid certificate, then update the RICAL signer with the resulting certificate.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----","examples":["-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----"]},"caId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS root CA certificate used to sign the RICAL signer.","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"intermediateCaId":{"type":"string","format":"uuid","description":"Unique identifier of the DTS intermediate CA certificate, if applicable.","example":"c1bbe671-21f8-5358-9537-eed4669b43f3","examples":["c1bbe671-21f8-5358-9537-eed4669b43f3"]},"active":{"type":"boolean","description":"Indicates if the RICAL signer is active.\n- Only active RICAL signers can be used to sign RICALs.\n- RICAL signers are created as inactive by default, and cannot be activated until a RICAL Signer Certificate (PEM) has been uploaded.\n","enum":[false],"example":false,"examples":[false]}}},"RicalSignerCreateRequest":{"type":"object","oneOf":[{"required":["caId"]},{"required":["intermediateCaId"]}],"properties":{"caId":{"type":"string","format":"uuid","description":"Internal identifier of the DTS root CA certificate that will be used for signing the RICAL signer.\n- Must be an unmanaged (external) DTS root CA certificate.\n","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"intermediateCaId":{"type":"string","format":"uuid","description":"Internal identifier of the DTS intermediate CA certificate that will be used for signing the RICAL signer.\n","example":"c1bbe671-21f8-5358-9537-eed4669b43f3","examples":["c1bbe671-21f8-5358-9537-eed4669b43f3"]}}},"ricalSignerId":{"description":"Unique identifier of the RICAL signer.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","examples":["123e4567-e89b-12d3-a456-426614174000"]},"RicalSignerUpdateRequest":{"type":"object","required":["active"],"properties":{"active":{"type":"boolean","description":"Indicates if the RICAL signer is active. Only active RICAL signers can be used to sign RICALs.","example":true,"examples":[true]},"certificatePem":{"type":"string","description":"RICAL Signer Certificate in PEM format.\n- Must match the Certificate Signing Request (CSR) issued for this RICAL signer.\n- Must be signed by the same DTS root CA (or DTS intermediate CA) specified when the RICAL signer was created.\n","example":"-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----","examples":["-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"]}}},"caCertificateId":{"description":"Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.","type":"string","format":"uuid","example":"b0aae560-10e7-4247-8e96-7cdd3578a1e2","examples":["b0aae560-10e7-4247-8e96-7cdd3578a1e2"]},"GetWebhooksResponse":{"type":"object","properties":{"data":{"type":"array","minItems":2,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Webhook id","example":"0c099611-19c4-4f29-8724-6b9e5ba1ef7c","examples":["0c099611-19c4-4f29-8724-6b9e5ba1ef7c"]},"events":{"type":"array","description":"List of events that trigger the Webhook.","example":["OpenIdCredentialIssued"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:GetWebhooksResponse:properties:data:items:properties:events:example"]},"url":{"description":"The URL that will receive the Webhook events data payload when they are triggered.","type":"string","example":"https://example.com","format":"uri","examples":["https://example.com"]},"disabled":{"type":"boolean","description":"Indicates whether ot not the Webhook is disabled. When set to `true` the webhook is disabled, and notifications for events associated with it will not be sent.","default":false}}}},"nextCursor":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj","examples":["Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj"]}},"title":"GetWebhooksResponse"},"CreateWebhookRequest":{"type":"object","properties":{"events":{"type":"array","description":"This array includes the event types that will trigger this Webhook. The following events are currently supported:\n- **OpenIdCredentialIssued**: Triggered upon completion of an OID4VCI issuance flow and includes credential data.\n- **OpenIdCredentialIssuedSummary**: Triggered upon completion of an OID4VCI issuance flow but does not include credential data.","example":["OpenIdCredentialIssued"],"items":{"type":"string","enum":["OpenIdCredentialIssued","OpenIdCredentialIssuedSummary"]},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreateWebhookRequest:properties:events:example"]},"url":{"description":"This is the URL that will receive the Webhook events data payload when they are triggered by MATTR VII for the specified events:\n- Must be a valid URL.\n- Must use the HTTPS protocol.\n- Must not be an IP address.\n- Must not include query parameters or have fragments.\n- Non-ASCII characters are normalized.\n- Must return a 2xx response, otherwise it will go through a retry cycle and eventually fail.","type":"string","example":"https://example.com","format":"uri","examples":["https://example.com"]},"disabled":{"type":"boolean","description":"Indicates whether or not the Webhook is disabled. When set to `true` the webhook is disabled, and notifications for events associated with it will not be sent. If no value is provided, defaults to `false`."}},"required":["events","url"],"title":"CreateWebhookRequest"},"CreateWebhookResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the created Webhook. You will need it to [verify Webhook requests](https://learn.mattr.global/docs/platform-management/webhooks-guide#verify-webhook-requests).","example":"0c099611-19c4-4f29-8724-6b9e5ba1ef7c","examples":["0c099611-19c4-4f29-8724-6b9e5ba1ef7c"]},"events":{"type":"array","description":"List of events that trigger the Webhook, as defined in the request.","example":["OpenIdCredentialIssued"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:CreateWebhookResponse:properties:events:example"]},"url":{"description":"The URL that will receive the Webhook events data payload when they are triggered, as defined in the request.","type":"string","example":"https://example.com","format":"uri","examples":["https://example.com"]},"disabled":{"type":"boolean","description":"Indicates whether ot not the Webhook is disabled. When set to `true` the webhook is disabled, and notifications for events associated with it will not be sent.","default":false}},"title":"CreateWebhookResponse"},"GetWebhookResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Webhook id","example":"0c099611-19c4-4f29-8724-6b9e5ba1ef7c","examples":["0c099611-19c4-4f29-8724-6b9e5ba1ef7c"]},"events":{"type":"array","description":"List of events that trigger the Webhook.","example":["OpenIdCredentialIssued"],"items":{"type":"string"},"examples":["$186:props:children:1:props:children:props:payload:bundled:components:schemas:GetWebhookResponse:properties:events:example"]},"url":{"description":"The URL that will receive the Webhook events data payload when they are triggered.","type":"string","example":"https://example.com","format":"uri","examples":["https://example.com"]},"disabled":{"type":"boolean","description":"Indicates whether ot not the Webhook is disabled. When set to `true` the webhook is disabled, and notifications for events associated with it will not be sent.","default":false}},"title":"GetWebhookResponse"},"GetWebhooksJwksResponse":{"type":"object","properties":{"keys":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kty":{"type":"string","description":"Key type.","example":"OKP","examples":["OKP"]},"crv":{"type":"string","description":"Elliptic curve used to generate the key.","example":"Ed25519","examples":["Ed25519"]},"x":{"type":"string","example":"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo","examples":["11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo"]},"use":{"type":"string","example":"sig","examples":["sig"]},"kid":{"type":"string","description":"Key identifier. You should use the `kid` specified in the JWK key object to identify which key a particular HTTP request is signed with, as the key set can change or contain multiple keys.","example":"FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ","examples":["FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ"]}}}]}}}}},"responses":{"304":{"description":"Not Modified. The resource has not been modified since the last request."},"400":{"description":"Bad Request. The request was malformed or missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}},"401":{"description":"Unauthorized. The client is not recognized by authorization server.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden. The client is recognized by authorization server but is not allowed to access this resource."},"404":{"description":"Not Found. The specified resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error. An unexpected error occurred."},"503":{"description":"Service Unavailable. The server is temporarily unavailable to handle requests."}},"parameters":{"limit":{"schema":{"type":"number","example":2,"maximum":1000,"minimum":1,"default":100,"examples":[2]},"in":"query","name":"limit","description":"Range size of returned list."},"cursor":{"schema":{"type":"string","example":"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h","examples":["Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"]},"in":"query","name":"cursor","description":"Starting point for the list of entries."},"verifierSignerId":{"in":"path","name":"verifierSignerId","description":"Unique identifier of the Verification request signer.","required":true,"schema":{"$ref":"#/components/schemas/verifierSignerId"}},"verifierApplicationId":{"name":"verifierApplicationId","in":"path","description":"Unique identifier for the verifier application.","schema":{"type":"string","format":"uuid","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"required":true},"instanceId":{"name":"instanceId","in":"path","description":"Unique identifier for the registered verifier application instance.","schema":{"type":"string","format":"uuid","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"required":true},"SessionId":{"name":"sessionId","in":"path","description":"Session ID","schema":{"type":"string","format":"uuid"},"required":true},"holderApplicationId":{"name":"holderApplicationId","in":"path","description":"Unique identifier for a registered holder application.","schema":{"type":"string","format":"uuid","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]},"required":true},"holderApplicationInstanceId":{"name":"instanceId","in":"path","description":"Unique identifier for an instance of a registered holder application.","schema":{"type":"string","format":"uuid","example":"1ef1f867-20b4-48ea-aec1-bea7aff4964c","examples":["1ef1f867-20b4-48ea-aec1-bea7aff4964c"]},"required":true},"holderCaCertificateId":{"name":"certificateId","in":"path","required":true,"description":"Unique identifier of the holder root CA certificate.","schema":{"type":"string","format":"uuid","example":"281d20b3-42a3-40dd-b29a-115ff32b02b7","examples":["281d20b3-42a3-40dd-b29a-115ff32b02b7"]}},"walletAttestationSignerId":{"name":"certificateId","in":"path","required":true,"description":"Unique identifier of the wallet attestation signer.","schema":{"type":"string","format":"uuid","example":"782f1885-c7c2-4459-8426-b6d7c111b0b1","examples":["782f1885-c7c2-4459-8426-b6d7c111b0b1"]}},"DPoP":{"name":"DPoP","in":"header","required":false,"description":"$19e","schema":{"type":"string","example":"eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwieCI6IlljWkdRdXpfRmRBUW5MYzkwNjVFYkMzb09Dd1l3SVZnSFJQUVJfRHdpdU0iLCJ5IjoidWpwODhlMGNYSjRKRmN5ZEJkS3pyUVprMzVfam45ZWNqeFpNN2RsWmV5TSIsImNydiI6IlAtMjU2In19.eyJodHUiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwvdjEvb2F1dGgvdG9rZW4iLCJodG0iOiJQT1NUIiwianRpIjoiZTQ5YmNiOGMtZDM0ZC00N2U4LWE0NTEtNzc5NDI3MjExY2ZlIiwiaWF0IjoxNzYyNDc5NjgyfQ.Du74EnQpyxqf13_IoXZfyow00TsRG5DTh_oyIX2ouW7Ys9OyeW774HFyfQdmAkD1oYdM0ucKtxRp6k_bZr2slw","examples":["eyJhbGciOiJFUzI1NiIsInR5cCI6ImRwb3Arand0IiwiandrIjp7Imt0eSI6IkVDIiwieCI6IlljWkdRdXpfRmRBUW5MYzkwNjVFYkMzb09Dd1l3SVZnSFJQUVJfRHdpdU0iLCJ5IjoidWpwODhlMGNYSjRKRmN5ZEJkS3pyUVprMzVfam45ZWNqeFpNN2RsWmV5TSIsImNydiI6IlAtMjU2In19.eyJodHUiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwvdjEvb2F1dGgvdG9rZW4iLCJodG0iOiJQT1NUIiwianRpIjoiZTQ5YmNiOGMtZDM0ZC00N2U4LWE0NTEtNzc5NDI3MjExY2ZlIiwiaWF0IjoxNzYyNDc5NjgyfQ.Du74EnQpyxqf13_IoXZfyow00TsRG5DTh_oyIX2ouW7Ys9OyeW774HFyfQdmAkD1oYdM0ucKtxRp6k_bZr2slw"]}},"OAuthClientAttestationPoP":{"name":"OAuth-Client-Attestation-PoP","in":"header","required":false,"description":"$19f","schema":{"type":"string","example":"eyJhbGciOiJFUzI1NiIsInR5cCI6Im9hdXRoLWNsaWVudC1hdHRlc3RhdGlvbi1wb3Arand0In0.eyJhdWQiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwiLCJqdGkiOiI2ZmU2ZWMwMi00NGRlLTQ0OTktYWFiYy1iNzZiNzRiMzJjZjciLCJpYXQiOjE3NzA4Njc1ODh9.NBMLwAa65ICxE_nwsZoJeuyFmCFWV-1s7anheUC-qTtL4ZdOE5sfzS1_v_GourNUTTdtszIJTfhYYnRhwB7t6A","examples":["eyJhbGciOiJFUzI1NiIsInR5cCI6Im9hdXRoLWNsaWVudC1hdHRlc3RhdGlvbi1wb3Arand0In0.eyJhdWQiOiJodHRwczovL3lvdXItdGVuYW50LnJlZ2lvbi5tYXR0ci5nbG9iYWwiLCJqdGkiOiI2ZmU2ZWMwMi00NGRlLTQ0OTktYWFiYy1iNzZiNzRiMzJjZjciLCJpYXQiOjE3NzA4Njc1ODh9.NBMLwAa65ICxE_nwsZoJeuyFmCFWV-1s7anheUC-qTtL4ZdOE5sfzS1_v_GourNUTTdtszIJTfhYYnRhwB7t6A"]}},"UserId":{"name":"userId","in":"path","description":"User ID","schema":{"type":"string","format":"uuid","example":"41458e5a-9092-40b7-9a26-d4eb43c5792f","examples":["41458e5a-9092-40b7-9a26-d4eb43c5792f"]},"required":true},"ecosystemId":{"in":"path","name":"ecosystemId","description":"The UUID of the ecosystem","required":true,"schema":{"$ref":"#/components/schemas/id"}},"ifNoneMatch":{"in":"header","name":"If-None-Match","description":"The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since.","schema":{"type":"string"}},"acceptEncoding":{"in":"header","name":"Accept-Encoding","description":"Use the Accept-Encoding header to specify the supported content encodings.","schema":{"type":"string","enum":["gzip","deflate"]}},"issuerPolicyId":{"in":"path","name":"id","description":"The UUID of the issuer policy","required":true,"schema":{"type":"string","format":"uuid"}},"verifierPolicyId":{"in":"path","name":"id","description":"The UUID of the verifier policy","required":true,"schema":{"type":"string","format":"uuid"}},"participantId":{"in":"path","name":"participantId","description":"The UUID of the participant","required":true,"schema":{"type":"string","format":"uuid","description":"The UUID of the participant.","example":"a24e391a-c27f-4b6e-9805-1ee7e03f3c58","readOnly":true,"examples":["a24e391a-c27f-4b6e-9805-1ee7e03f3c58"]}},"contactId":{"in":"path","name":"contactId","description":"Unique identifier of the points of contact for a given participant.","required":true,"schema":{"type":"string","format":"uuid","example":"920f2489-d953-42f2-b2dd-f37c29b818cf","description":"Unique identifier of a specific point of contact entry.","examples":["920f2489-d953-42f2-b2dd-f37c29b818cf"]}},"evidenceId":{"in":"path","name":"evidenceId","description":"The UUID of the participant evidence","required":true,"schema":{"type":"string","format":"uuid","example":"920f2489-d953-42f2-b2dd-f37c29b818cf","description":"Unique identifier of the PDF evidence.","examples":["920f2489-d953-42f2-b2dd-f37c29b818cf"]}},"credentialId":{"in":"path","name":"credentialId","description":"The UUID of the credential","required":true,"schema":{"type":"string","format":"uuid","example":"599bf148-d711-405a-a20b-9c8a87ac8850","description":"Unique identifier for this credential type.","readOnly":true,"examples":["599bf148-d711-405a-a20b-9c8a87ac8850"]}},"issuerCertificateId":{"in":"path","name":"issuerCertificateId","description":"Unique identifier of the participant issuer certificate.","required":true,"schema":{"type":"string","format":"uuid","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","description":"Unique identifier of the participant issuer certificate.","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]}},"verifierCertificateId":{"in":"path","name":"verifierCertificateId","description":"Unique identifier of the participant verifier certificate.","required":true,"schema":{"type":"string","format":"uuid","example":"3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a","description":"Unique identifier of the participant verifier certificate.","examples":["3b5b1a6a-1b1a-4b1a-8b1a-1b1a4b1a8b1a"]}},"vicalIssueId":{"in":"path","name":"vicalIssueId","description":"Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.","required":true,"schema":{"$ref":"#/components/schemas/vicalIssueID"}},"dtsCaCertificateId":{"in":"path","name":"dtsCaCertificateId","description":"Unique identifier of the DTS root CA certificate.","required":true,"schema":{"$ref":"#/components/schemas/dtsCaCertificateId"}},"dtsIntermediateCaCertificateId":{"in":"path","name":"dtsIntermediateCaCertificateId","description":"Unique identifier of the DTS intermediate CA certificate.","required":true,"schema":{"$ref":"#/components/schemas/dtsIntermediateCaCertificateId"}},"vicalSignerId":{"in":"path","name":"vicalSignerId","description":"Unique identifier of the VICAL signer.","required":true,"schema":{"$ref":"#/components/schemas/vicalSignerId"}},"ricalIssueId":{"in":"path","name":"ricalIssueId","description":"Unique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.","required":true,"schema":{"$ref":"#/components/schemas/ricalIssueID"}},"ricalSignerId":{"in":"path","name":"ricalSignerId","description":"Unique identifier of the RICAL signer.","required":true,"schema":{"$ref":"#/components/schemas/ricalSignerId"}},"caCertificateId":{"in":"path","name":"caCertificateId","description":"Unique identifier of the VICAL root CA certificate.","required":true,"schema":{"$ref":"#/components/schemas/caCertificateId"}}},"examples":{"PayloadNotStringError":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"1","msg":"must be a string","param":"payload","location":"body"}]}},"InvalidCompactCredentialError":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"CSS:/1/BASE_32_ENCODED_PAYLOAD","msg":"The payload does not belong to compact credential profile","param":"payload","location":"body"}]}},"QRCodeTooLargeDataError":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"CSC:/1/BASE_32_ENCODED_PAYLOAD","msg":"The amount of data is too big to be stored in a QR Code","param":"payload","location":"body"}]}},"QRCodeLargerWidthError":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"5","msg":"The generated QR Code is larger than the provided width","param":"width","location":"body"}]}},"IssuerNotTrusted":{"value":{"verified":false,"reason":[{"type":"IssuerNotTrusted","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"IssuerPublicKeyInvalid":{"value":{"verified":false,"reason":[{"type":"IssuerPublicKeyInvalid","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"SignatureInvalid":{"value":{"verified":false,"reason":[{"type":"SignatureInvalid","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"Expired":{"value":{"verified":false,"reason":[{"type":"Expired","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"NotActive":{"value":{"verified":false,"reason":[{"type":"NotActive","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"Revoked":{"value":{"verified":false,"reason":[{"type":"Revoked","msg":"..."}],"decoded":{"jti":"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2","iss":"did:web:xxx","nbf":1649037604,"vc":{"@context":["https://www.w3.org/2018/credentials/v1","https://example.com/credentials/pass"],"type":["VerifiableCredential","PublicCovidPass"],"credentialSubject":{"givenName":"Jack","familyName":"Sparrow","dob":"1979-04-14"}}}}},"InvalidCompactSemanticCredentialError":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"CSC:/1/BASE_32_ENCODED_PAYLOAD","msg":"The payload does not belong to compact semantic credential profile","param":"payload","location":"body"}]}},"InboxIdNotUuid":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"notUUIDvalue","msg":"Invalid value","param":"inboxId","location":"params"}]}},"InboxNameNotUnique":{"value":{"code":"BadRequest","message":"Unique Constraint Error","details":[{"param":"name","message":"Must be unique"}]}},"MessageIdNotUuid":{"value":{"code":"BadRequest","message":"Validation Error","details":[{"value":"notUUIDvalue","msg":"Invalid value","param":"messageId","location":"params"}]}},"ResourceNotFound":{"value":{"code":"NotFound","message":"Resource Not Found"}}}}},"proxyUrl":"$undefined"},"document":"public/api-reference/platform-latest.yml","operations":[{"method":"get","path":"/v1/messaging/inboxes/{id}","tags":["Inboxes"]}],"showDescription":true}]}],"$L1a0"]}]

Retrieve an inbox

Roles

Analytics Events

Authorization

Path Parameters

Response Body

200application/json

400application/json

404application/json

Retrieve an inbox

Roles

Analytics Events

Authorization

Path Parameters

Response Body

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`