developer.sailpoint.com/docs/api/beta/generate-digit-token.api.mdx

---
id: generate-digit-token
sidebar_label: Generate a digit token
hide_title: true
hide_table_of_contents: true
api: eJztG9tu2zj2Vwjtw7RFJMdOHDd5WbhJO8ii3WZzQR+cAKVF2mYrkRqSSuoJ8u97zqEky7HbeNtitztwCyQ2RZ77Xcx9ZAppuVdGn4roKJpKjV/liZoqf2k+Sx3tRJ5PXXQ0is64c3fGCvaOaz6VudQ+utmJhHSpVQXCAAiXM+XY8OyUwa/SScG8YTVUxplAwLAGkNnEWFbUMPMGZsLO5R+lstIxXvqZsepPIpC5FIhlZsKuIyX0UX00JpgxwTxKrQRE11ECdFsAI51/ZcQ8OrqnrwAV2PS2lDtRarRHFuARL4pMpYSl88khH/eRS2cy5/jJzwsJnJnxJ5n6Cm4ANIqARQuSAzEUFkXplXR4plpfnHbeKj2NVsUlWakEcuXxIxxjFd0gO5RQS2JwWn7heZEhwOF4PE8ucuVn0cNOlEk9hU8LfAqYm0q7FmHYjDhbwBN26pmbmTITbCzZxJqcHaD2ui93mNJpVjp1KxOGAISc8DLz7JZnpURNHyRt2l4CQaIMZvVO6dIHmWxAmVe5RJwZoCLuUShtm1Ga5QHiVyjpN8/bFPUfgCSvPEmutuOFkZ9LJz2KsTmw0GBb0As5v1zDISBBNGC4hdEu8Nzb3cVfq5xu4gjRDxjpsjmKhT9vZJIbUNcW7+Huy8Ggu/fQ+Nympm/lRFqpU8lOT2ofaOOuIgd6fwV5yQdkt3cwkKmIJ6k4jPfTwV58mPb7cbfX7/fBMkR37yD6tuofab0tqGi34ita4mtTrIh3f536jzMF8mOvrQXJxhDtfGk1eLsK/Feo2BjiFlq00mDcSvxMa5Ceq+zYCPm0lt4oLeOp5QoplERyCgcZQLxVAk6w3Fj0QwRZq5D2LTkgSiLpsldcUHRH/o4rZlA9lqefAdYmZnOlFZxn9RGmRBMo1qCVA8nHB7uHvf3JwT7nvZf73UF/fDjhe3u7h/3DQ8SeS+fAqNsxilvL5yuof0drVCnLTAoa+RMEAtkGZE8EEHI4orzM3dM6IBgbyJ/iNe1t2KzoZV5+8TuQU18dn7H9Acu4npa0zqePhKDjqwtY0WWW8TEuYQbErEGA31sw+rWBQeoyxyx38vrN8OrtJaycv/7X1esL+ISwVpL/EAO0QLMEUsEWZuaOKK4YuOOOOZmBOKRI2IsK6gtgiGvX3qjCNzeHLJjXMR5OVNjXnGiDDrmr7UrkN188e6YSmexAeoO1nPt0xsYcaxRQIW5/MUxTWfj4bSXJF2wmuZD2ecKGQihkkmch1Tg4P8c8yYVA1w0AJiW4MhADucKUnmnjVSqXdbEQ5bI2FjHqbVsp6BxA+dN2Mkx9CcQRm20vbKylIrHSD9AcJLdM3WVLaCTSufY8BS54ls1BjNaChNkYeFPesSocobocBB5d72siVjv0Urh7F4g58Yaepbx0G/jdWQbhJybWmge3snI+h/VCiEakjVpNVUSCh8g2Ha52NeqqHZ9NlMzE1ne3vrv13Q199/HD86rorZ5S6bO3Wvq8MXasQOp6Td1Dvc/clIyDGmypNWZ37naYMNLp3zybcXB6Dmp2Lrg10C61iAujfm6xvC2PtuXRNsRuQ+y2PNqWR1vf3fruTy6PGqrIW6o6yZV5zu08WFr1HLnlDDaweqbIGpcjVT2uVhAYa2qsaLlyiMa97rg7GaRyX/B9cbB3OOmlBz3eH3QH3fF+bxC1c/1o4ceNky37VEvfQY8kYijibqGOKzUYl/PGiOWZFojXygmGNQw99XwfdAcF3MPNw0OoHfvrxmanoBGLVnoRUHxlfmbJx7gGEuSXInhNU/lsK8RthbjNMtss89fIMtsKceu7W9/9//Td/6BCrKqhr1eIsGHjChH2JrusqaXeoHH91wtFcpWKgvD+3qRpCfIViyqQ6gowJSSoMPTit+D46j3q1PdJ4uYKiMUX+OEKSIde4cLuUIkGCkubwcGZ94U76nTuQXGgsIeEFyqBeAa683Nt7pLU5J0xSGtNIMIXscHpcAPdcAkIEhK1VWjNIfQR8CB4Yg7tFhRAY8pvQtY8J43OTQnBjsDsMLD8yrJoGUgsuJ7/5mh3Qpa0wh/wdWWzhx/nJQD6Ci/rxPdNbLCfAaWPWEQWblBdYAEAiPR1BfQch7g1LFHpo5v2ngus0wOFKzsXuQe7i94KQe9xW4+9ktxCExGuGTz7x4fL5801JcFKh4WxVNhOgH+dgRlR9BvWw2c8RAnJmnI6I+aGS3eV0NvYJAOhsGt9ISUbnVaC+iekhXOI4yR2PCQpdOCpm2e1BoW8lRlmzGQhbTROJXQHpNjhS+eeU3akNkJp+JjTanKtY3aiMGgpzPK4p75PgZN1NipqvniLr+8l4m81tDhAC97onj+iIoh2lIY7ECm4PILgmSNpfTfyAC9uwcOeC1YQ6mMaUBIVHcs3zNJaa99NxxK8GOEt03GtP8wUpN7lYyxEuvr61SlLZ8Y4+XfG0HTQVUbTEjztu8m6Q6QxeUTc222RFAeUsYqhkCT63oJj6GBMfIyJnOoYAyWeFsFtP5JmIS58hDZbsI9LPNPyCPIt7hQmdd9NMyKMEWEc4oSr6A/pDA0LfBt5oDgQDOB4oX+KBBWhrdgYYK2N/AS+U9+0o9uGBMUVR+HL0SII1vfO6AHubvZAqMY6vHlNBd9ZBQtz2pKw6gnCYwmu0psZSKWP5BbobWYomF5/NX6R4+Fi0PJeZ/OfHaW/Ekl+nbj7P4p420jzV4w0VWWMA8vzxfXm1z92bRX6djBfYqNqSdpO86qqEVcHidBtgBzhJzwl36eiHlomagKpKmoDKjLu0UsoSqQzJWkEUUjusd7cQUs1OXl2YQ2GE2g0CdCULnVbEAGHplFlAI9u/9aYOTlgKGbRTvC7K6kPQlzpDFpambAP0BXqFNSMHSFeNIBnn0zVGl6Aps/QUNhJbTxQxOV5qQEb+nmZMw4m+oSFCeXSMgRCaBC1rGVhqJRsTtVRAU0XWUioN7K5ez/B6TY0zi1DegIX2JGrRtsgetQidgbYdjWMnMuMdI77lluFp2CD9cYzmRV0xxzIgg6zheHd6eUKRACmHfAFvb+x0051yHVwLwDBliyYz17STXZjalFgHVs86KJbwH9f+1cDj63wfjHT/5X+9qDKbtiWdAqcviGPZWilQhs7ir7ZxiKf1MhC2zPD9hcO3N/jxAY7uwdcBvfHccDoZtG0UaMEB2hyQ53UZ4kTg+pVQXw5p+xdjQZW34FgLxlOhGnQN/fetDr0s/c4F4vG1d9a5GHYYPkdLOLPo+ga/sMXUwRDxD/IwPX7qB7dwZ4AF//9G7Eeuf8=
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Generate a digit token' (generate-digit-token)"
---

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 TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Generate a digit token</h1>

<MethodEndpoint method={"post"} path={"/generate-password-reset-token/digit"}></MethodEndpoint>



This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create".

## Request

<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><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"userId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The uid of the user requested for digit token","example":"Abby.Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"length"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The length of digit token. It should be from 6 to 18, inclusive. The default value is 6.","example":8}}></SchemaItem><SchemaItem collapsible={false} name={"durationMinutes"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The time to live for the digit token in minutes. The default value is 5 minutes.","example":5}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

The digit token for password management.

</div><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={"digitToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The digit token for password management","example":9087713}}></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reference ID of the digit token generation request","example":"e1267ecd-fcd9-4c73-9c55-12555efad136"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"digitToken\": 9087713,\n  \"requestId\": \"e1267ecd-fcd9-4c73-9c55-12555efad136\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"digitToken\": \"09087713\",\n  \"requestId\": \"e1267ecd-fcd9-4c73-9c55-12555efad136\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>