Code Examples

Complete code examples for integrating with the SNH AI Public Records API in various programming languages.

For detailed request/response documentation, see the individual endpoint pages under API Reference. When sending cases[], include is_excluded on every row (true keeps the pair for mapping/count gate but strips that offense_id from data.decision).

For evaluate examples below, set xml to a sample from Supported XML Schemas — do not leave a placeholder string.

Python

Basic Authentication and Evaluation

import requests

API_KEY = "YOUR_API_KEY_HERE"
BASE_URL = "https://cra.pr.snh-ai.com"

def get_token():
    response = requests.post(
        f"{BASE_URL}/auth/token",
        headers={"X-API-Key": API_KEY}
    )
    response.raise_for_status()
    return response.json()["access_token"]

def evaluate_record(token, record_data):
    response = requests.post(
        f"{BASE_URL}/evaluate",
        headers={
            "Authorization": f"Bearer {token}",
            "Content-Type": "application/json"
        },
        json={"record": record_data}
    )
    response.raise_for_status()
    return response.json()

# Use a ScreeningResults sample from Supported XML Schemas (/xml-schemas)
screening_results_xml = "..."  # paste sample from /xml-schemas

token = get_token()
result = evaluate_record(token, {
    "xml": screening_results_xml,
    "search_id": "test-123",
    "search_date": "2025-04-30",
    "order_id": "12345",
    "order_number": "12345.1",
    "cases": [
        {"court_search_id": "CS40929433A", "offense_id": "34789896", "is_excluded": False}
    ],
    "applicant_state": "CA",
    "candidate_info": {
        "first_name": "John",
        "middle_name": "A",
        "last_name": "Doe",
        "date_of_birth": "1990-05-15",
        "ssn": "123-45-6789"
    }
})
decision = result["data"]["decision"]
print(f"Search queue: {decision['search_queue']}")
for court in decision["court_decisions"]:
    for case in court["case_decisions"]:
        for offense in case["offenses"]:
            print(offense["offense_id"], offense["charge_decision"], offense["routing"]["queue"])

Token Caching with Auto-Refresh

import requests
import time
from typing import Optional

class PublicRecordsAPIClient:
    def __init__(self, api_key: str, base_url: str):
        self.api_key = api_key
        self.base_url = base_url
        self.token: Optional[str] = None
        self.token_expires_at: float = 0

    def get_token(self) -> str:
        if self.token and time.time() < self.token_expires_at:
            return self.token

        response = requests.post(
            f"{self.base_url}/auth/token",
            headers={"X-API-Key": self.api_key}
        )
        response.raise_for_status()
        data = response.json()

        self.token = data["access_token"]
        self.token_expires_at = time.time() + data["expires_in"] - 300
        return self.token

    def evaluate(self, record_data: dict) -> dict:
        token = self.get_token()
        response = requests.post(
            f"{self.base_url}/evaluate",
            headers={
                "Authorization": f"Bearer {token}",
                "Content-Type": "application/json"
            },
            json={"record": record_data}
        )
        response.raise_for_status()
        return response.json()

    def check_health(self) -> dict:
        response = requests.get(f"{self.base_url}/health")
        response.raise_for_status()
        return response.json()

client = PublicRecordsAPIClient(
    api_key="YOUR_API_KEY_HERE",
    base_url="https://cra.pr.snh-ai.com"
)

# Use a ScreeningResults sample from Supported XML Schemas (/xml-schemas)
result = client.evaluate({
    "xml": screening_results_xml,  # paste sample from /xml-schemas
    "search_id": "test-123",
    "search_date": "2025-04-30",
    "order_id": "12345",
    "order_number": "12345.1",
    "applicant_state": "CA",
    "candidate_info": {
        "first_name": "John",
        "last_name": "Doe",
        "date_of_birth": "1990-05-15"
    }
})

Identity Match (Compliance Engine)

CE_BASE_URL = "https://cra.pr.snh-ai.com"

def identity_match(candidate_to_verify: dict, candidate_in_record: dict) -> dict:
    response = requests.post(
        f"{CE_BASE_URL}/complianceEngine/identity-match",
        headers={"Content-Type": "application/json"},
        json={
            "candidate_to_verify": candidate_to_verify,
            "candidate_in_record": candidate_in_record
        }
    )
    response.raise_for_status()
    return response.json()

result = identity_match(
    candidate_to_verify={
        "first_name": "EDGAR",
        "last_name": "LINARES",
        "date_of_birth": "1997-05-05",
        "ssn": "",
        "aliases": [],
        "addresses": [{
            "street_one": "200 AVANT ST APT C1 DEL RIO, TX 78840",
            "address_type": "DOMESTIC",
            "country": "US"
        }]
    },
    candidate_in_record={
        "first_name": "EDGAR",
        "last_name": "LINARES",
        "date_of_birth": "1997-05-05",
        "ssn": "",
        "aliases": [],
        "addresses": [{
            "street_one": "200 AVANT ST APT C1 DEL RIO, TX 78840",
            "address_type": "DOMESTIC",
            "country": "US"
        }]
    }
)
print(f"Match: {result['is_match']}, Score: {result['match_score']}")

JavaScript/Node.js

Basic Authentication and Evaluation

const API_KEY = 'YOUR_API_KEY_HERE';
const BASE_URL = 'https://cra.pr.snh-ai.com';

async function getToken() {
  const response = await fetch(`${BASE_URL}/auth/token`, {
    method: 'POST',
    headers: { 'X-API-Key': API_KEY }
  });
  const data = await response.json();
  return data.access_token;
}

async function evaluateRecord(token, recordData) {
  const response = await fetch(`${BASE_URL}/evaluate`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ record: recordData })
  });
  return response.json();
}

// Use a ScreeningResults sample from Supported XML Schemas (/xml-schemas)
const screeningResultsXml = '...'; // paste sample from /xml-schemas

const token = await getToken();
const result = await evaluateRecord(token, {
  xml: screeningResultsXml,
  search_id: 'test-123',
  search_date: '2025-04-30',
  order_id: '12345',
  order_number: '12345.1',
  cases: [
    { court_search_id: 'CS40929433A', offense_id: '34789896', is_excluded: false }
  ],
  applicant_state: 'CA',
  candidate_info: {
    first_name: 'John',
    middle_name: 'A',
    last_name: 'Doe',
    date_of_birth: '1990-05-15',
    ssn: '123-45-6789'
  }
});
const decision = result.data.decision;
console.log(`Search queue: ${decision.search_queue}`);
for (const court of decision.court_decisions) {
  for (const c of court.case_decisions) {
    for (const offense of c.offenses) {
      console.log(offense.offense_id, offense.charge_decision, offense.routing.queue);
    }
  }
}

Token Caching with Auto-Refresh

class PublicRecordsAPIClient {
  constructor(apiKey, baseUrl) {
    this.apiKey = apiKey;
    this.baseUrl = baseUrl;
    this.token = null;
    this.tokenExpiresAt = 0;
  }

  async getToken() {
    if (this.token && Date.now() < this.tokenExpiresAt - 300000) {
      return this.token;
    }

    const response = await fetch(`${this.baseUrl}/auth/token`, {
      method: 'POST',
      headers: { 'X-API-Key': this.apiKey }
    });
    const data = await response.json();

    this.token = data.access_token;
    this.tokenExpiresAt = Date.now() + (data.expires_in * 1000);
    return this.token;
  }

  async evaluate(recordData) {
    const token = await this.getToken();
    const response = await fetch(`${this.baseUrl}/evaluate`, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${token}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({ record: recordData })
    });
    return response.json();
  }

}

const client = new PublicRecordsAPIClient(
  'YOUR_API_KEY_HERE',
  'https://cra.pr.snh-ai.com'
);

// Use a ScreeningResults sample from Supported XML Schemas (/xml-schemas)
const result = await client.evaluate({
  xml: screeningResultsXml, // paste sample from /xml-schemas
  search_id: 'test-123',
  search_date: '2025-04-30',
  order_id: '12345',
  order_number: '12345.1',
  applicant_state: 'CA',
  candidate_info: {
    first_name: 'John',
    last_name: 'Doe',
    date_of_birth: '1990-05-15'
  }
});
console.log(result);

cURL

Get Token

curl -X POST https://cra.pr.snh-ai.com/auth/token \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Evaluate Record (Full)

Paste a ScreeningResults sample from Supported XML Schemas into record.xml (or build the JSON payload from a saved file).

curl -X POST https://cra.pr.snh-ai.com/evaluate \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "record": {
      "xml": "...",
      "search_id": "76190bc0-e58c-494f-92c5-0c9a47389528",
      "search_date": "2025-04-30",
      "order_id": "41115779",
      "order_number": "41115779.1",
      "applicant_state": "CA",
      "candidate_info": {
        "first_name": "John",
        "middle_name": "A",
        "last_name": "Doe",
        "date_of_birth": "1990-05-15",
        "ssn": "123-45-6789"
      },
      "cases": [
        { "court_search_id": "CS40929433A", "offense_id": "34789896", "is_excluded": false }
      ]
    }
  }'

Identity Match

curl -X POST https://cra.pr.snh-ai.com/complianceEngine/identity-match \
  -H "Content-Type: application/json" \
  -d '{
    "candidate_to_verify": {
      "first_name": "EDGAR",
      "last_name": "LINARES",
      "date_of_birth": "1997-05-05",
      "ssn": "",
      "aliases": [],
      "addresses": [{
        "street_one": "200 AVANT ST APT C1 DEL RIO, TX 78840",
        "address_type": "DOMESTIC",
        "country": "US"
      }]
    },
    "candidate_in_record": {
      "first_name": "EDGAR",
      "last_name": "LINARES",
      "date_of_birth": "1997-05-05",
      "ssn": "",
      "aliases": [],
      "addresses": [{
        "street_one": "200 AVANT ST APT C1 DEL RIO, TX 78840",
        "address_type": "DOMESTIC",
        "country": "US"
      }]
    }
  }'

Health Check

curl https://cra.pr.snh-ai.com/health

Error Handling

Python — Retry with Token Refresh

import requests
import time

def evaluate_with_retry(client, record_data, max_retries=3):
    for attempt in range(max_retries):
        try:
            token = client.get_token()
            response = requests.post(
                f"{client.base_url}/evaluate",
                headers={
                    "Authorization": f"Bearer {token}",
                    "Content-Type": "application/json"
                },
                json={"record": record_data}
            )

            if response.status_code == 401:
                client.token = None
                continue

            if response.status_code == 206:
                result = response.json()
                print(f"Partial success: {result['data'].get('errors', [])}")
                return result

            response.raise_for_status()
            return response.json()

        except requests.exceptions.RequestException as e:
            if attempt == max_retries - 1:
                raise
            time.sleep(2 ** attempt)

    raise Exception("Max retries exceeded")

Core Concepts

Guides

Examples

Support

Python

Basic Authentication and Evaluation

Token Caching with Auto-Refresh

Identity Match (Compliance Engine)

JavaScript/Node.js

Basic Authentication and Evaluation

Token Caching with Auto-Refresh

cURL

Get Token

Evaluate Record (Full)

Identity Match

Health Check

Error Handling

Python — Retry with Token Refresh

​Python

​Basic Authentication and Evaluation

​Token Caching with Auto-Refresh

​Identity Match (Compliance Engine)

​JavaScript/Node.js

​Basic Authentication and Evaluation

​Token Caching with Auto-Refresh

​cURL

​Get Token

​Evaluate Record (Full)

​Identity Match

​Health Check

​Error Handling

​Python — Retry with Token Refresh

Python

Basic Authentication and Evaluation

Token Caching with Auto-Refresh

Identity Match (Compliance Engine)

JavaScript/Node.js

Basic Authentication and Evaluation

Token Caching with Auto-Refresh

cURL

Get Token

Evaluate Record (Full)

Identity Match

Health Check

Error Handling

Python — Retry with Token Refresh