Problem details
Definition
An RFC 9457 JSON format for HTTP API errors, served as application/problem+json, with type, title, status, detail and instance members.
Disclosure. This site is published by Coragrid, the operator of CompanyRegistryAPI.com, and promotes it. “Best” is our editorial choice, not a measured ranking. Other products are described only from their own official pages. How we choose
Also called: RFC 9457, application/problem+json, problem document.
In practice
Check the response’s Content-Type. When it is application/problem+json,
parse the body, branch on the API’s code, log the request identifier and show
detail to developers, not to end users.
Questions and answers
Which member should my code branch on?
A stable code member if the API adds one, as CompanyRegistryAPI.com does. The standard members are meant for people and for identifying the problem type.
Did RFC 9457 replace RFC 7807?
Yes. RFC 9457 obsoletes RFC 7807 and keeps the application/problem+json media type.
Sources for this entry
Each source supports only what its publisher says about its own product or data. Official descriptions do not establish comparative performance, and this site has run no benchmark. All sources
Continue reading
- Problem details and error codes (Guide)
- HTTP 429 (Definition)
- JSON (Definition)
How the related websites connect
This is one of 3 coordinated reference sites published by Coragrid. They cover neighbouring questions and feature the same product, so they are not independent endorsements of it or of each other.
Cite this entry
Best Company Data API. “Problem details.” Content reviewed . https://bestcompanydataapi.com/glossary/problem-details