Skip to main content
POST
/
case
/
id
/
{caseId}
/
add
/
services
Add to order
curl --request POST \
  --url https://api-stage.karmacheck.io/case/id/{caseId}/add/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "services": [
    {
      "id": "service-cplc"
    }
  ],
  "orderData": [
    {
      "caseOrderDataTypeId": "codt-cplc",
      "serviceId": "service-cplc",
      "metadata": {
        "cplcId": "1d16c91d-c2da-47d1-b102-bd67d5b8b1ee",
        "fields": [
          {
            "fieldId": "licenseNumber",
            "value": "L1234567"
          },
          {
            "fieldId": "firstName",
            "value": "Matt"
          },
          {
            "fieldId": "lastName",
            "value": "Williams"
          },
          {
            "fieldId": "state",
            "value": "NY"
          }
        ]
      }
    }
  ],
  "orderConfig": {
    "serviceConfigs": {
      "9ac65633-b4c4-4062-875c-3556db9d2a08": {
        "verificationMethod": "psv-first"
      },
      "85307784-1f84-471a-8596-c8ea088c3a62": {
        "verificationMethod": "psv-first"
      }
    }
  }
}
'
import requests

url = "https://api-stage.karmacheck.io/case/id/{caseId}/add/services"

payload = {
    "services": [{ "id": "service-cplc" }],
    "orderData": [
        {
            "caseOrderDataTypeId": "codt-cplc",
            "serviceId": "service-cplc",
            "metadata": {
                "cplcId": "1d16c91d-c2da-47d1-b102-bd67d5b8b1ee",
                "fields": [
                    {
                        "fieldId": "licenseNumber",
                        "value": "L1234567"
                    },
                    {
                        "fieldId": "firstName",
                        "value": "Matt"
                    },
                    {
                        "fieldId": "lastName",
                        "value": "Williams"
                    },
                    {
                        "fieldId": "state",
                        "value": "NY"
                    }
                ]
            }
        }
    ],
    "orderConfig": { "serviceConfigs": {
            "9ac65633-b4c4-4062-875c-3556db9d2a08": { "verificationMethod": "psv-first" },
            "85307784-1f84-471a-8596-c8ea088c3a62": { "verificationMethod": "psv-first" }
        } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    services: [{id: 'service-cplc'}],
    orderData: [
      {
        caseOrderDataTypeId: 'codt-cplc',
        serviceId: 'service-cplc',
        metadata: {
          cplcId: '1d16c91d-c2da-47d1-b102-bd67d5b8b1ee',
          fields: [
            {fieldId: 'licenseNumber', value: 'L1234567'},
            {fieldId: 'firstName', value: 'Matt'},
            {fieldId: 'lastName', value: 'Williams'},
            {fieldId: 'state', value: 'NY'}
          ]
        }
      }
    ],
    orderConfig: {
      serviceConfigs: {
        '9ac65633-b4c4-4062-875c-3556db9d2a08': {verificationMethod: 'psv-first'},
        '85307784-1f84-471a-8596-c8ea088c3a62': {verificationMethod: 'psv-first'}
      }
    }
  })
};

fetch('https://api-stage.karmacheck.io/case/id/{caseId}/add/services', 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-stage.karmacheck.io/case/id/{caseId}/add/services",
  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([
    'services' => [
        [
                'id' => 'service-cplc'
        ]
    ],
    'orderData' => [
        [
                'caseOrderDataTypeId' => 'codt-cplc',
                'serviceId' => 'service-cplc',
                'metadata' => [
                                'cplcId' => '1d16c91d-c2da-47d1-b102-bd67d5b8b1ee',
                                'fields' => [
                                                                [
                                                                                                                                'fieldId' => 'licenseNumber',
                                                                                                                                'value' => 'L1234567'
                                                                ],
                                                                [
                                                                                                                                'fieldId' => 'firstName',
                                                                                                                                'value' => 'Matt'
                                                                ],
                                                                [
                                                                                                                                'fieldId' => 'lastName',
                                                                                                                                'value' => 'Williams'
                                                                ],
                                                                [
                                                                                                                                'fieldId' => 'state',
                                                                                                                                'value' => 'NY'
                                                                ]
                                ]
                ]
        ]
    ],
    'orderConfig' => [
        'serviceConfigs' => [
                '9ac65633-b4c4-4062-875c-3556db9d2a08' => [
                                'verificationMethod' => 'psv-first'
                ],
                '85307784-1f84-471a-8596-c8ea088c3a62' => [
                                'verificationMethod' => 'psv-first'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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-stage.karmacheck.io/case/id/{caseId}/add/services"

	payload := strings.NewReader("{\n  \"services\": [\n    {\n      \"id\": \"service-cplc\"\n    }\n  ],\n  \"orderData\": [\n    {\n      \"caseOrderDataTypeId\": \"codt-cplc\",\n      \"serviceId\": \"service-cplc\",\n      \"metadata\": {\n        \"cplcId\": \"1d16c91d-c2da-47d1-b102-bd67d5b8b1ee\",\n        \"fields\": [\n          {\n            \"fieldId\": \"licenseNumber\",\n            \"value\": \"L1234567\"\n          },\n          {\n            \"fieldId\": \"firstName\",\n            \"value\": \"Matt\"\n          },\n          {\n            \"fieldId\": \"lastName\",\n            \"value\": \"Williams\"\n          },\n          {\n            \"fieldId\": \"state\",\n            \"value\": \"NY\"\n          }\n        ]\n      }\n    }\n  ],\n  \"orderConfig\": {\n    \"serviceConfigs\": {\n      \"9ac65633-b4c4-4062-875c-3556db9d2a08\": {\n        \"verificationMethod\": \"psv-first\"\n      },\n      \"85307784-1f84-471a-8596-c8ea088c3a62\": {\n        \"verificationMethod\": \"psv-first\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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-stage.karmacheck.io/case/id/{caseId}/add/services")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"services\": [\n    {\n      \"id\": \"service-cplc\"\n    }\n  ],\n  \"orderData\": [\n    {\n      \"caseOrderDataTypeId\": \"codt-cplc\",\n      \"serviceId\": \"service-cplc\",\n      \"metadata\": {\n        \"cplcId\": \"1d16c91d-c2da-47d1-b102-bd67d5b8b1ee\",\n        \"fields\": [\n          {\n            \"fieldId\": \"licenseNumber\",\n            \"value\": \"L1234567\"\n          },\n          {\n            \"fieldId\": \"firstName\",\n            \"value\": \"Matt\"\n          },\n          {\n            \"fieldId\": \"lastName\",\n            \"value\": \"Williams\"\n          },\n          {\n            \"fieldId\": \"state\",\n            \"value\": \"NY\"\n          }\n        ]\n      }\n    }\n  ],\n  \"orderConfig\": {\n    \"serviceConfigs\": {\n      \"9ac65633-b4c4-4062-875c-3556db9d2a08\": {\n        \"verificationMethod\": \"psv-first\"\n      },\n      \"85307784-1f84-471a-8596-c8ea088c3a62\": {\n        \"verificationMethod\": \"psv-first\"\n      }\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-stage.karmacheck.io/case/id/{caseId}/add/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"services\": [\n    {\n      \"id\": \"service-cplc\"\n    }\n  ],\n  \"orderData\": [\n    {\n      \"caseOrderDataTypeId\": \"codt-cplc\",\n      \"serviceId\": \"service-cplc\",\n      \"metadata\": {\n        \"cplcId\": \"1d16c91d-c2da-47d1-b102-bd67d5b8b1ee\",\n        \"fields\": [\n          {\n            \"fieldId\": \"licenseNumber\",\n            \"value\": \"L1234567\"\n          },\n          {\n            \"fieldId\": \"firstName\",\n            \"value\": \"Matt\"\n          },\n          {\n            \"fieldId\": \"lastName\",\n            \"value\": \"Williams\"\n          },\n          {\n            \"fieldId\": \"state\",\n            \"value\": \"NY\"\n          }\n        ]\n      }\n    }\n  ],\n  \"orderConfig\": {\n    \"serviceConfigs\": {\n      \"9ac65633-b4c4-4062-875c-3556db9d2a08\": {\n        \"verificationMethod\": \"psv-first\"\n      },\n      \"85307784-1f84-471a-8596-c8ea088c3a62\": {\n        \"verificationMethod\": \"psv-first\"\n      }\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
caseId
string
required

The ID of the case to add services to.

Body

application/json

services and orderData are both optional, but at least one of them is required to call this endpoint.

​
services
object[]
​
orderData
CaseOrderData · object[]
​
orderConfig
OrderConfig · object

Updated configurations [blocked] that describe how to run certain screenings for the case. The current configurations for the case can be overridden only if there has not already been a screening dispatched where that configuration applies. For example, if a criminal screening was ordered during case creation, then aliasNameConfiguration cannot be updated.

Response

success