Case Management
Create a Case
Creates a new investigation case, linking it to an entity and related issues (activities, alerts, behavioural insights, or custom issues), with an assigned investigator and case stages/tasks.
POST
/
v2
/
api
/
cases
Create a Case
curl --request POST \
--url https://api.youverify.co/v2/api/cases \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data @- <<EOF
{
"caseTitle": "KYC data Mismatch",
"caseType": "KYC",
"description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
"severity": "High",
"entityId": "6880a452495dce07d2f7ff5a",
"investigator": {
"investigatorId": "681d7b32cd275833cb856fff"
},
"linkedIssues": [
{
"issueId": "6880f7d527309cf76eb5db2e",
"issueType": "Activity",
"status": "Mismatch"
}
],
"caseStage": [
{
"stage": "Investigation",
"level": "LV1",
"tasks": [
{
"task": "Investigate KYC verification"
}
]
}
]
}
EOFimport requests
url = "https://api.youverify.co/v2/api/cases"
payload = {
"caseTitle": "KYC data Mismatch",
"caseType": "KYC",
"description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
"severity": "High",
"entityId": "6880a452495dce07d2f7ff5a",
"investigator": { "investigatorId": "681d7b32cd275833cb856fff" },
"linkedIssues": [
{
"issueId": "6880f7d527309cf76eb5db2e",
"issueType": "Activity",
"status": "Mismatch"
}
],
"caseStage": [
{
"stage": "Investigation",
"level": "LV1",
"tasks": [{ "task": "Investigate KYC verification" }]
}
]
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
caseTitle: 'KYC data Mismatch',
caseType: 'KYC',
description: 'The case was created because there\'s a complete mismatch between the NIN and BVN data of the client.',
severity: 'High',
entityId: '6880a452495dce07d2f7ff5a',
investigator: {investigatorId: '681d7b32cd275833cb856fff'},
linkedIssues: [
{issueId: '6880f7d527309cf76eb5db2e', issueType: 'Activity', status: 'Mismatch'}
],
caseStage: [
{
stage: 'Investigation',
level: 'LV1',
tasks: [{task: 'Investigate KYC verification'}]
}
]
})
};
fetch('https://api.youverify.co/v2/api/cases', 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://api.youverify.co/v2/api/cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'caseTitle' => 'KYC data Mismatch',
'caseType' => 'KYC',
'description' => 'The case was created because there\'s a complete mismatch between the NIN and BVN data of the client.',
'severity' => 'High',
'entityId' => '6880a452495dce07d2f7ff5a',
'investigator' => [
'investigatorId' => '681d7b32cd275833cb856fff'
],
'linkedIssues' => [
[
'issueId' => '6880f7d527309cf76eb5db2e',
'issueType' => 'Activity',
'status' => 'Mismatch'
]
],
'caseStage' => [
[
'stage' => 'Investigation',
'level' => 'LV1',
'tasks' => [
[
'task' => 'Investigate KYC verification'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/api/cases"
payload := strings.NewReader("{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/api/cases")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Case created successfully!"
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Title of the case
Type of case being created
Detailed reason or context for creating the case
Available options:
High, Medium, Low ID of the entity the case is associated with
Response
Success
⌘I
Create a Case
curl --request POST \
--url https://api.youverify.co/v2/api/cases \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data @- <<EOF
{
"caseTitle": "KYC data Mismatch",
"caseType": "KYC",
"description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
"severity": "High",
"entityId": "6880a452495dce07d2f7ff5a",
"investigator": {
"investigatorId": "681d7b32cd275833cb856fff"
},
"linkedIssues": [
{
"issueId": "6880f7d527309cf76eb5db2e",
"issueType": "Activity",
"status": "Mismatch"
}
],
"caseStage": [
{
"stage": "Investigation",
"level": "LV1",
"tasks": [
{
"task": "Investigate KYC verification"
}
]
}
]
}
EOFimport requests
url = "https://api.youverify.co/v2/api/cases"
payload = {
"caseTitle": "KYC data Mismatch",
"caseType": "KYC",
"description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
"severity": "High",
"entityId": "6880a452495dce07d2f7ff5a",
"investigator": { "investigatorId": "681d7b32cd275833cb856fff" },
"linkedIssues": [
{
"issueId": "6880f7d527309cf76eb5db2e",
"issueType": "Activity",
"status": "Mismatch"
}
],
"caseStage": [
{
"stage": "Investigation",
"level": "LV1",
"tasks": [{ "task": "Investigate KYC verification" }]
}
]
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
caseTitle: 'KYC data Mismatch',
caseType: 'KYC',
description: 'The case was created because there\'s a complete mismatch between the NIN and BVN data of the client.',
severity: 'High',
entityId: '6880a452495dce07d2f7ff5a',
investigator: {investigatorId: '681d7b32cd275833cb856fff'},
linkedIssues: [
{issueId: '6880f7d527309cf76eb5db2e', issueType: 'Activity', status: 'Mismatch'}
],
caseStage: [
{
stage: 'Investigation',
level: 'LV1',
tasks: [{task: 'Investigate KYC verification'}]
}
]
})
};
fetch('https://api.youverify.co/v2/api/cases', 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://api.youverify.co/v2/api/cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'caseTitle' => 'KYC data Mismatch',
'caseType' => 'KYC',
'description' => 'The case was created because there\'s a complete mismatch between the NIN and BVN data of the client.',
'severity' => 'High',
'entityId' => '6880a452495dce07d2f7ff5a',
'investigator' => [
'investigatorId' => '681d7b32cd275833cb856fff'
],
'linkedIssues' => [
[
'issueId' => '6880f7d527309cf76eb5db2e',
'issueType' => 'Activity',
'status' => 'Mismatch'
]
],
'caseStage' => [
[
'stage' => 'Investigation',
'level' => 'LV1',
'tasks' => [
[
'task' => 'Investigate KYC verification'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/api/cases"
payload := strings.NewReader("{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/api/cases")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"caseTitle\": \"KYC data Mismatch\",\n \"caseType\": \"KYC\",\n \"description\": \"The case was created because there's a complete mismatch between the NIN and BVN data of the client.\",\n \"severity\": \"High\",\n \"entityId\": \"6880a452495dce07d2f7ff5a\",\n \"investigator\": {\n \"investigatorId\": \"681d7b32cd275833cb856fff\"\n },\n \"linkedIssues\": [\n {\n \"issueId\": \"6880f7d527309cf76eb5db2e\",\n \"issueType\": \"Activity\",\n \"status\": \"Mismatch\"\n }\n ],\n \"caseStage\": [\n {\n \"stage\": \"Investigation\",\n \"level\": \"LV1\",\n \"tasks\": [\n {\n \"task\": \"Investigate KYC verification\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Case created successfully!"
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}