Skip to main content
GET
/
cases
/
{caseId}
Get a case
curl --request GET \
  --url https://core.us.api.frayme.io/cases/{caseId} \
  --header 'X-API-Key: <api-key>'
{
  "caseId": "<string>",
  "requestId": "<string>",
  "workflowId": "<string>",
  "workflowVersion": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "payload": {},
  "metadata": {},
  "subject": {
    "displayName": "<string>",
    "transaction": {
      "amount": 123,
      "currency": "<string>",
      "parties": [
        {
          "displayName": "<string>",
          "identifiers": [
            {
              "value": "<string>",
              "country": "<string>"
            }
          ]
        }
      ],
      "amountUsd": 123,
      "type": "<string>",
      "externalTransactionId": "<string>"
    },
    "person": {
      "identifiers": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "dateOfBirth": "2023-12-25"
    },
    "business": {
      "legalName": "<string>",
      "country": "<string>",
      "identifiers": [
        {
          "value": "<string>",
          "country": "<string>"
        }
      ],
      "relatedParties": [
        {
          "displayName": "<string>",
          "identifiers": [
            {
              "value": "<string>",
              "country": "<string>"
            }
          ]
        }
      ]
    }
  },
  "result": {
    "decision": {
      "actor": "<string>",
      "decidedAt": "2023-11-07T05:31:56Z",
      "declineReason": "<string>",
      "queueName": "<string>",
      "riskScore": 123,
      "notes": "<string>"
    },
    "decisionHistory": [
      {
        "actor": "<string>",
        "decidedAt": "2023-11-07T05:31:56Z",
        "declineReason": "<string>",
        "queueName": "<string>",
        "riskScore": 123,
        "notes": "<string>"
      }
    ],
    "workflow_result": {},
    "riskEvaluation": {
      "evaluatedAt": "2023-11-07T05:31:56Z",
      "triggeredRules": [
        {
          "id": "<string>",
          "name": "<string>",
          "conditions": [
            "<string>"
          ],
          "ruleVersion": "<string>"
        }
      ]
    },
    "dataSources": [
      {
        "nodeId": "<string>",
        "providerId": "<string>",
        "status": "<string>"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

A tenant-scoped API key provisioned by Frayme.

Path Parameters

​
caseId
string
required

The case identifier returned by POST /cases.

Response

The case.

​
caseId
string
​
requestId
string
​
workflowId
string
​
workflowVersion
integer
​
type
enum<string>
Available options:
KYC,
KYB,
Transaction
​
status
enum<string>

Lifecycle only, not the outcome. received — workflow not yet finished (result absent). in_review — paused in a manual-review queue. completed — inspect result.decision.value.

Available options:
received,
in_review,
completed
​
createdAt
string<date-time>
​
completedAt
string<date-time>
​
payload
object
​
metadata
object
​
subject
object

Typed business attributes used for entity resolution and review. Set exactly one sub-struct, and it must match type: transaction for Transaction, person for KYC, business for KYB.

​
result
object

Present only once the workflow has completed.