Non Success Responses

All errors will adhere to the problem response format as defined by Problem Details for HTTP API’s

Below are some sample response examples

When the request contains “invalid” Identity field data

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "InputValidationError",
    "status": 400,
    "detail": "See the errors field for details.",
    "instance": "/identity/score",
    "traceId": "|bad4a210-4b51729b279dd00f.",
    "errors": {
        "Identity.FirstName": [
            "'First Name' must not be empty."
        ]
    }
}

When the request is made with an “API version” that is not supported

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "UnsupportedApiVersion",
    "status": 400,
    "detail": "The HTTP resource that matches the request URI 'http://localhost:5000/identity/score' does not support the API version '2'.",
    "traceId": "|bad4a211-4b51729b279dd00f."
}

When an “unexpected” server processing error occurs

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "InternalServerError.",
    "status": 500,
    "detail": "Please contact Ingo money client services.",
    "instance": "/identity/score",
    "traceId": "|c1ecee92-4f4cec828884a904.",
    "errors": {}
}

When multiple “conflicting versions” are used in the “header” and “querystring” parameters

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "AmbiguousApiVersion",
    "status": 400,
    "detail": "The following API versions were requested: 1, 2. At most, only a single API version may be specified. Please update the intended API version and retry the request.",
    "traceId": "|31f77797-4a8da50f4fd3a851."
}

When an “authorization” failure occurs

{
    "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
    "title": "Unauthorized",
    "status": 401,
    "detail": "Authorization failure.",
    "instance": "/identity/score",
    "traceId": "|b56c1133-4c83cf831979499e."
}

When making a request to an “invalid” resource url

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "ResourceNotFound",
    "status": 404,
    "detail": "Resource '/resource-not-located' not found.",
    "instance": "/resource-not-located",
    "traceId": "|ddcf5087-4b680597207c67c5."
}

Clients should record the traceId for all failed requests that can be used for troubleshooting.