---
id: config-preview-digital-wallet-open-id-credential-definition
title: "Preview credential definition from URI"
description: "Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at `credentialDefinitionUri` and returns it unchanged in `credentialDefinition`. For OpenID4VCI 1.0, the document is a claim path pointer document: its `claims` array holds one entry per claim, each with a `path` array. Send one request per URI."
sidebar_label: "Preview credential definition from URI"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zgS/isDfmoAWXZeetczFotLk/bO3eISNE6zQBLAtDiy2UikSlJ2fIb/+2JIyZIcO9cvdzhgmw+xYnGGw3l55hlmzQTaxMjCSa3YkH1El8zRAofEoEDlJM/AJnPMOQidlDkqB6nROXC4/TICq8HNuYOVLiHhCqSyBSYOpIMpptpgeGOQO+wqFZhKJWnboE+6GMZzBItmIRMEoZcq01xYcHNs9uYOJo2Wy62SWyMnwJUAg640ypIFpUrmXM1QgFT7pSYxfNQGrgpUo8uzrxcjOI4HUXdH6b2RcZlDwd0cCi2VQ7NdMATpLEz8CjsBbgxfwVxnwoJWCKicWUGBJuiIAHkyh6V0c+AwIY2VTAw3qISXMfi9ROu81O2XUfygWMR0gYaT0SPBhizRKpWza4MLictLOZOOZ3c8y9D5w4iLPadlEas0v9dixYZr0uJQOXrkRZHJxG/Q/2YpGdYsBJ6e3KpANmR6+g0TV+mRBgUb3rMD4WCPESsMWe0kWr/bgYWNfuuMVDMWsVSbnDs2ZKWRLNpJ0n+Ox9egDdDnjU9DnfqYvZKzTkNKuR2ziOEzz4uM9ps7V9hhvx9W27h6Eyc672eFFLH3xMb/RKzghufo0Fg2vF/vGHXlH3gWw62S30sE6U1JJZraPMuVmOpn0GbGlbTe12RYaRFSbcDNpa1jH8PdHJWvHktp4d/NkQs0IT/rOjGlCiWyzQ/Kdu8NCu6zq3dXPEex14Yo1LC0EfAZl8o6L7D06RTEudtvPVWc0q4jl3OpOsLYkYnhM/IF+u/DgUCXrvbDjoL4QT2oNiwYDJCw9QZola1gWTuLl25Ofk8IcKoqmyI3aIAnCVoLTj+harl3j4SC8+sRPOGq62rHn9AejqSHMXpbCXvnyJnSBjsWxzDWFLZqnx4tTXiWUdz4gQBNpc8B9HqdPmyEP8Dk+nYM/cVJP6BEn4tcqj4v5BOu+mteyN9wNRKbfqWhp81sQtDtkAvv8cnvvZtyGkIwEhPCQI+JWBgkPwmfTSG67XO1nEXZJ1VJR9fe9QV1hQimpQNSH7a+MjPSv5SE2GmT7lPt5pVa2+TAvgPnpXWAz9K6KDxPMdNqRruudGlepmu1iA6T6RWKGM4VlOpJ6aVqFW1E4enW8P7g1MXj66BWGvmtuhr8umBdcAoImaZoCJ66VmYZ5PwpFIPPjJTLLITWY9/ZYEA4Jgl3gpNYxCgibMi6ru1Adcozi9FLVK9Qd9NGxr+8e/c3POZnydvpSXo6GAyO+an46/GAbR5JpS20sgHVTwYD+uii4cUr7MFTDAG29PWYllm2YtF/rxX9WB/ap7l7JJ+Bu12FQtqGiPpwHgsOEpWoYikoGo5CAeVCyNBFrlsGO1Ni1YGqimDDNf11Fjz/w55rewqN0eZCC6R+SM+XrcM+Ri980fVgI924jVjRzGfiNovOBoPNHvV7+n2TeO850bWidLBtt6w6/ct4dMpG2rqMo3b/elGZ9I5Ig7SQS2ulmkXgu2+L9CW6zEJnmzZB1ca3H4rUbiCO/8SBuFXUQrWR/0bxwjVv/9Q5OqJJQREIolmgAb/Njo82EbOYlEa6laeV5749s+H94yZas/eeu5yXbu6/oVPzGfFPVpF+CKwf3myHmCMWsZG1JRpyUo5urmliKLT1TuKkirXYgQiKeqFe+rpAJUXfim9L128QrNcMbP0ijB2MLKdz7ePDl5jr6tgsYqXJWnRbYK57vJCxnBmuXCw1o7N2FVwbLcrEV/YBNf9Jw43jM6lmh8RteL1ryGMTjxtKy5BNdVS2aRFY1KEufF5VBK/mrq5hW4LYUE9PjAnSFjwrsebNk46eSU15awpTGEzlM4qK9QUbYQJvlHaBPTjDZeZ9UPAEjyLAeBbvqB1CJfgLESZyB1HSXycxMYJ2/q1ZYNIf6+Hs09345dlaLBsKbm1tXtBU2Uxct2MEbD3osYB8GDZj2zqnuDEqF0KNL80g+6Guy1cmzB+d9Cicqa4RiycesTDnkhLHlkWhjft7kyzbeMt/NF91s6ydoDuu2gpBYfRCinDvoskuhyDpk5pR8E+VEaHK/bj4FY1MJZ9mCA3dskClz1WC8OYq3GkceS66X/DaoN1usYWQ6yOyyOlEZ5ayUlo/06AiGVt13RA3z2QloU3kLz0C8V3QDiuokKU1l1sorU9Hx5XgRtieP6/kRAwzvbQhVypPe2vvTi/g6wW8+XQ3Popg9GH8EW4ue5/uxvD1Iuw2urmC43eD49PeW8gvddLPLz+37wLCZYKlvp3JBJX1uVJXasGTOcJJPHgRuuVyGXP/OtZm1q9kbf/z6OLDv24+9EhmEzEnXdbJAe+smkrUCEAwGcJ+Mjg5i0/jY5IlUM65atlTXem8dlV2+2W0W3atDvvzDu//9w6vQjK6lukXGZcecXzSravGfM8WJ2EaSiWRjm5zDteAShLP8g2alu5r0Z4NhSb9GLE5tf7hPVuvp9zirck2G/r6e4nGE42ILbjxgBBoR93OfFeXll404+PBvPt5A/bzBuznDdjPG7D/4Q3YXjx9Ip7+8h7ME2s2ZH5QCGsuAnb1xqSmWfFiQm0kzn0YX13bnrmur26IIU+rf7fkfhplhtPoRL+H7IE9MI/qnkz5CZi+X7OMq1nJZ7S+/idExHjFw5sZ5MnPINUD4XX9Sq1aVu6OI+Ew9JuOtlfkF6rh33D163Z5eHNQYEvgw2qKxeNms/kD+EEMVQ==
sidebar_class_name: "post api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Preview credential definition from URI</h1>

<MethodEndpoint method={"post"} path={"/v2/config/digital-wallet/openid/sdjwt/credential-definition/preview"}></MethodEndpoint>



Fetches a credential schema document from a URI so that you can inspect it before you create a credential definition from it. The service downloads the document at `credentialDefinitionUri` and returns it unchanged in `credentialDefinition`. For OpenID4VCI 1.0, the document is a claim path pointer document: its `claims` array holds one entry per claim, each with a `path` array. Send one request per URI.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.\n\nThe service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with `PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org` instead.\n\n`X-SubwalletId` is the deprecated name of this header. The service continues to accept it, but `X-SandboxOrgId` wins if you send both headers.\n\nThe sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.","in":"header","name":"X-SandboxOrgId","required":false,"schema":{"type":"string"},"example":"6889e1a4c5b2f30001a3d710"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"credentialDefinitionUri"} required={true} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"HTTP or HTTPS URI of the credential schema document to fetch.","example":"https://schemas.example.com/lpid.json"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Credential schema document fetched successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>credentialDefinition</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The schema document that the service fetched from `credentialDefinitionUri`, returned unchanged.

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The schema document that the service fetched from `credentialDefinitionUri`, returned unchanged.","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"credentialDefinition\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The organisation is unknown, the wallet is not deployed, the URI is missing, or the document could not be fetched or read.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>