curl --request GET \
--url https://core.us.api.frayme.io/cases/{caseId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://core.us.api.frayme.io/cases/{caseId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core.us.api.frayme.io/cases/{caseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.us.api.frayme.io/cases/{caseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.us.api.frayme.io/cases/{caseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.us.api.frayme.io/cases/{caseId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.us.api.frayme.io/cases/{caseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"caseId": "<string>",
"requestId": "<string>",
"workflowId": "<string>",
"workflowVersion": 123,
"type": "KYC",
"status": "received",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"payload": {},
"metadata": {},
"subject": {
"displayName": "<string>",
"transaction": {
"amount": 123,
"currency": "<string>",
"direction": "outbound",
"parties": [
{
"role": "sender",
"displayName": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
]
}
],
"amountUsd": 123,
"type": "<string>",
"externalTransactionId": "<string>"
},
"person": {
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
],
"dateOfBirth": "2023-12-25"
},
"business": {
"legalName": "<string>",
"country": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
],
"relatedParties": [
{
"role": "owner",
"displayName": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
]
}
]
}
},
"result": {
"decision": {
"value": "approved",
"source": "workflow",
"actor": "<string>",
"decidedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"queueName": "<string>",
"riskScore": 123,
"notes": "<string>"
},
"decisionHistory": [
{
"value": "approved",
"source": "workflow",
"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",
"status": "ok",
"action": "deny",
"highestSeverity": "low",
"triggeredRules": [
{
"id": "<string>",
"name": "<string>",
"severity": "low",
"conditions": [
"<string>"
],
"ruleVersion": "<string>"
}
]
},
"dataSources": [
{
"nodeId": "<string>",
"providerId": "<string>",
"status": "<string>"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}Get a case
Fetch a case by id, including its decision result once the workflow
has completed. Requires the cases:read scope.
The status field reflects only lifecycle (received / completed),
not the outcome — read result.decision.value for the decision.
curl --request GET \
--url https://core.us.api.frayme.io/cases/{caseId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://core.us.api.frayme.io/cases/{caseId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core.us.api.frayme.io/cases/{caseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.us.api.frayme.io/cases/{caseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.us.api.frayme.io/cases/{caseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.us.api.frayme.io/cases/{caseId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.us.api.frayme.io/cases/{caseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"caseId": "<string>",
"requestId": "<string>",
"workflowId": "<string>",
"workflowVersion": 123,
"type": "KYC",
"status": "received",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"payload": {},
"metadata": {},
"subject": {
"displayName": "<string>",
"transaction": {
"amount": 123,
"currency": "<string>",
"direction": "outbound",
"parties": [
{
"role": "sender",
"displayName": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
]
}
],
"amountUsd": 123,
"type": "<string>",
"externalTransactionId": "<string>"
},
"person": {
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
],
"dateOfBirth": "2023-12-25"
},
"business": {
"legalName": "<string>",
"country": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
],
"relatedParties": [
{
"role": "owner",
"displayName": "<string>",
"identifiers": [
{
"type": "cpf",
"value": "<string>",
"country": "<string>"
}
]
}
]
}
},
"result": {
"decision": {
"value": "approved",
"source": "workflow",
"actor": "<string>",
"decidedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"queueName": "<string>",
"riskScore": 123,
"notes": "<string>"
},
"decisionHistory": [
{
"value": "approved",
"source": "workflow",
"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",
"status": "ok",
"action": "deny",
"highestSeverity": "low",
"triggeredRules": [
{
"id": "<string>",
"name": "<string>",
"severity": "low",
"conditions": [
"<string>"
],
"ruleVersion": "<string>"
}
]
},
"dataSources": [
{
"nodeId": "<string>",
"providerId": "<string>",
"status": "<string>"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
A tenant-scoped API key provisioned by Frayme.
Path Parameters
The case identifier returned by POST /cases.
Response
The case.
KYC, KYB, Transaction 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.
received, in_review, completed 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.
Show child attributes
Show child attributes
Present only once the workflow has completed.
Show child attributes
Show child attributes