---
id: create-domain-dkim
sidebar_label: Verify domain address via DKIM
hide_title: true
hide_table_of_contents: true
api: eJztW1tz2zYW/isY7kOTjCjZsh2v/bKj2E7HrW/rS/PgeCYQCUloKJIFSDtaj//7fucApEhLTtLUu20zSjIZigQOzu07FxC8D6yKSqOLWbB7fR9cWWX2srRQn4pBWUxwL7D5bpoVeqQjWegsDW+V0aNZGGdTqdMw/qinu3eYr4Kbh5tOkOXK8LjDONgNIqNkofZ56D5GBp2gkGNLZE8aNG2AmbGykdE5/cbMPZ4ppHDriCITQyV4ba1icaul2P/58Fi8cMR/VjMrDmOVFu75sdTJS6xm1G+lssWbLIZ89/xTGwXWClOqThCRqGlBj2SeJ56d3q+WeLgPbDRRU0lXxSxX4Cob/qqiAnRzQ4IWWll66nhsjLOF0ekY49QnOc0TvgWO8kynRTfKSA9tcQeVnDKOjbI2eHiAqnTBU52Ig/oJPcNlDsW59ftra8xGi+SRtoXIRk5NRfZRpVZU8otRZkQxqRTqxBYQKsIK3eDZFKPjzytlvb8x3NwaroUSf8Ih/oRyOx6GuL+59Vri3zBa0NWJuhNXV4f7QlqbRRpuEos7XUyWu0oAZf0v7IMRcOiDVA4TFTvtj2SZQGUjmVjVIO1crU2PjaKtUG6+twdueFY9+Us2W4NxaYycgTvgbWoXBXpoLHsdsNHXCXN00a8uNhbR9qSPSAQBApWzf8XWLw2vuShkUS5hpanbs4OT/cOTHxe06ubWTvp4sYcFNp0NrJu2f3kqyE9xCwsKBYvPoENc1iLAFVy4qgNG8BhWjof9IvPA2lyGpb1EgzFxYAx0EopzVZQmBX09YhT5KCOGCDNkVZ3eykTHzwikWEHMZC+L1TJNt5l9q1MVjg1kA4eKWY4wkeB9q2PSzzQzSjiSpHwSgcd1W1aDJrrr4o2MIa+Tb88LQ7HJyOgjaB0uRXiboatUY76opgg9jz9LllXbSg5fr+30N0evN6Xs/3NzfXtruDOSGxtrO1s7O7T6FBCUY7UMGe2lf1Qp7B+JJItgkf9AIcgr0D0zwIsvAdMTNmAaX6H/S8jlxtZien4F5dUOktqbvTOxuS0SmY5Lvi/Hj5SQhlcXuJOWSUIRwkURSO4Inxo9fiKgpeWUsL9/8HZwdXSJO+cH/746uMAV0VpA/iCFt8bklmAVvjDJ7phjL8CdtMKqBOpQcVe88lRfQSCJUNEYqN0vO7NQpvCxEDP86ktmNEmLkcmmLShFrggRL3RXdTsI6Lg3lUU0EUNpMQEmpOGvBlGk8iI88pp8JSZKxsq87ArkS01CykQAjSCK+TPKDAjhBF1HYFQCyorzR1YWgiqdSLVtMVdl2xrzSHLUNAqBA5x/2U8GUVGCORazicLaWzyL3j7g2Wmuzd1lQ2ms0hkiYkRBNElmUKMx0LAYQjZdWOHDEZnLIvCk1bg6YjXrDg53x44ZFyARz2RpvwJ3ZwkVhyxa/eBWefBZissuGrE1KjP5iISHJDZP9qNqc1XAF0jtSbzC7gq7K+x+JXYfPzz3HUSz9FlfLH2uUirLMsPJc6H0Mew9aSaqQa6TcIbsCCjEl0g/vbt0BSZXvZ9yKs+esT5yqXyB+UFtD3d/SOVHbayWLYhB1qOTYIRIpOJd5nvOMSvKqWpjcbW3mRlqOGi6pERE1DRilpVCQmWmTLlklbaDgl/Z9IdCTCTio4yoAXMRkLuDOHQ9yaqSXFWSq2y0ykbfTTZaVZIr7K6w+/fE7mcryZorRouvk2w5nUozc57mn5O0UmCAqPayRQ05NtXjaoWIibrGCtqVQzDsrw/XR9uR2ozlZvx6Y2fUj1735db2+vb6cLO/HTRz/fUcxzXI2phq2NvZkVWMIu4WdVyZwrlskWVxe/sP6jVqRGGNQk9dN0PnUOnNvHbcWqwdjxUGx+IkK8QgSbI7LrYrmxNiZOGg5Tj4mGZ3trX4lAl0mAkOetKMFfFjs9JEqq4zbZnnmSlcgekmPXcdfiKn6g/V4tDChWNTxQefCNp+81k1fHFxhf35rxaUWrT3ZAp4EwTglKqGAov1J1ejlX/0dxZlu8wycSzTWVVB21aPkc4xRDkPY6c01lRj6cWFGCNvpgLG0nA00o+G/KEw9J4t0VPNwZ28HHTNLByMCjiaC6RVEKpX0WmUlOCQM0WSkSUzBB4NEKgR9QSgwB3OGNn7Gf1r+pTtf4d3iXOS+IgkFuRdihJBrf2tZfv/h2DeUA65cPB74kWA64ZligCBhtHltNoTVv3bqn9b1YCrGvD7qAFX/dsKuyvs/j2x+zv6N18NPd2/YcBX928Y210TdS31lo/L/L/bOIaK54DdW2RRVBp+HVH1aFxXUGeE8XlmOYhIOg0X9KpjRf78m8Uj15I5dkqTYNSkKHK72+vdw0qwzkNX5rqr+XRaMUPnRkeMekOoZknUoeMjDmE0QAzODn3P12W9Gk2u6+IcE28dPZqfYvos5RQNGplvhtZQODId6oC8G/FtsJijh/jB8uguu82CfJDryiQPf1wWR+gJWZap77OrYbwAp49EJBFuOvV5xwsquN3qC6ce50mEmvj+wmKnNKwv3ihp0A2491ovfnp3+VKMqcxkmJeWTyVp6gsAlDO4CIexQfWOhyZxZjFZOZ4w44PWWzSCjRglEFi8Ty+UEteHXgkniO/nCMis0kHr2NTNi8o6sbpVCaW+butsW0/HaQ8a6rWPW73kNMf9gE5xOeW73fdpKPY1RR86p8ljvIjc3onrvJJLNuT6Vib+UVELHbXQnUl7+YgLp9rryJ3KioBdIiETy9r65sUdvbBBj5on3CGqj3kgTXg+2u8+o8pq38xHi15I9Np8vE/fTTRyaHua38wRFikwicWhiCZZZtW/hCDXIRhcj0ug6JvZuqNFQ0ZE2F9rsBS6JUMdoiJk/o4AjNQ5kxxSRuaCJEOtlsYOkh/YssD8B/TLsfjQkplvXyNx0sg4i+w380wLhrRg6GKA9fy7vESOBWyTDBwHnAPsze3PkcAz2oh7jtbSqM7kezyHUkMEVpmKzXfdj915gPNXgh/Q6HoMwjAV1PXbYPwWnhYlp5ayqq2Axxpc5DfJkBMf6c3xW29VVmdE/0ryksSD+Y7JaZrMnjtKPxFJ/jpx90+KeKtI8z1GGl/i0s7j+fz7iIOqGZl/z/DoUDzmkIsyq75/aALjja/xFnf9aFt6ovA/njK+uQJHf+PO7VPl0ySUJ7IgJHAkiCZa8X5BrmRB9WKHvBEMEnr9FwvoCpnQmD8aMRBTosPTCejxjna1smSQuWKUfIF+25KbFlormqD/VF3xDi1cGsGU1L7RmR08+zXzfdwFVHJGKhH7lYOgUJtOyxSrEZbLqZBwwy94UaxtVLpgh24uVZUuMi4X61kV8sk9SYQuNzJmak9HtBWNLrfhLF9YC75i/T40VE9WTPlFTTAX5Fwl/oOczqNS/0u04aHhRCU5OQkiNYo21Vjh+PBygSKIpe7dVDcz456fZHs0FkSopXLus9Fd766F3GLgPvVjaHkbxH9xJ/zbH2g0D/y3vPF+vhH/XB8Z+SxE7UMvT/znG6VrZ1zfeB0s9I3oRCbUWuLZ/T3thlAj9UC3gUhqta9v5j0S/QJNtyvCjeZHRd2434YPL2ecUH3bvfh+gVo3N8PttHx27E2j+z07pT2nYOi/n5q6Rt7IO9yk/3eD9/gb0Hdfzm/oIyu6j87cb+ZgjKNbVS7LEre/IDEfHv4LmU0i9g==
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 'Verify domain address via DKIM' (create-domain-dkim)"
---

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"}>Verify domain address via DKIM</h1>

<MethodEndpoint method={"post"} path={"/verified-domains"}></MethodEndpoint>



Create a domain to be verified via DKIM (DomainKeys Identified Mail)

## 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={"domain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sailpoint.com","description":"A domain address"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

List of DKIM tokens required for the verification process.

</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"123b45b0-aaaa-bbbb-a7db-123456a56abc","description":"New UUID associated with domain to be verified"}}></SchemaItem><SchemaItem collapsible={false} name={"domain"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sailpoint.com","description":"A domain address"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimEnabled"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"default":false,"example":true,"description":"DKIM is enabled for this domain"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimTokens"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["token1","token2","token3"],"description":"DKIM tokens required for authentication"}}></SchemaItem><SchemaItem collapsible={false} name={"dkimVerificationStatus"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"PENDING","description":"Status of DKIM authentication"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"123b45b0-aaaa-bbbb-a7db-123456a56abc\",\n  \"domain\": \"sailpoint.com\",\n  \"dkimEnabled\": true,\n  \"dkimTokens\": [\n    \"token1\",\n    \"token2\",\n    \"token3\"\n  ],\n  \"dkimVerificationStatus\": \"PENDING\"\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={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</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={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\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={"405"} value={"405"}><div>

Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.

</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={"errorName"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"NotSupportedException"}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessage"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"Description of the error","example":"Cannot consume content type"}}></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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorName\": \"NotSupportedException\",\n  \"errorMessage\": \"Cannot consume content type\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\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>