Errors

The /status endpoint contains an errors field at the FVR level to indicate whether any operations have failed.

Example:

[
  {
    "type": "https://docs.securefinancing.com/v1/errors/cancellations",
    "title": "Cancel fvr consumer with message id: 3432b8bf-8a9e-476b-a40c-2416f53e8c51",
    "status": "404 NOT_FOUND",
    "detail": "[404] during [POST] to [http://ghr-fvr-ms:8080/v1/hash_cancellations] [GhrServiceClient#cancelFvrHashes(GHRPostDataSetCancellation1,String)]: [{\"type\":\"FVR_NOT_FOUND\",\"title\":\"An error occurred. The following FvrDataSetId couldn't be found: [1f0f24c1-5b99-42c5-be0d-fb91e49d4e13, 473a94e5-0feb-4518-bff4-e7ccfc43a717, fd8ac77a-051f-4ea7-b9e1-6... (2877 bytes)]",
    "error": "[404] during [POST] to [http://ghr-fvr-ms:8080/v1/hash_cancellations] [GhrServiceClient#cancelFvrHashes(GHRPostDataSetCancellation1,String)]: [{\"type\":\"FVR_NOT_FOUND\",\"title\":\"An error occurred. The following FvrDataSetId couldn't be found: [1f0f24c1-5b99-42c5-be0d-fb91e49d4e13, 473a94e5-0feb-4518-bff4-e7ccfc43a717, fd8ac77a-051f-4ea7-b9e1-6... (2877 bytes)]",
    "path": "/cancellations",
    "timestamp": "2024-10-24T03:06:17.437Z",
    "sub_errors":
    []
  }
]

The path field indicates what operation was applied that failed. The type field then gives a URI that represents the specific error that occurred. The detail and error fields give further advice on what went wrong during the operation.

The potential error paths and types are (see each documentation page for further details):