Ironbark API Reference

Copyconst res = await fetch(
  "https://api.ironbarkaml.com.au/v1/oauth/token",
  {
    method: "POST",
    headers: { "Content-Type": "application/x-www-form-urlencoded" },
    body: new URLSearchParams({
      grant_type: "client_credentials",
      client_id: "your_client_id",
      client_secret: "your_client_secret",
    }),
  }
);
const { access_token } = await res.json();

// Use token in subsequent requests
const headers = { Authorization: `Bearer ${access_token}` };

Copyrequire 'net/http'
require 'json'

uri = URI('https://api.ironbarkaml.com.au/v1/oauth/token')
res = Net::HTTP.post_form(uri, {
  'grant_type'  => 'client_credentials',
  'client_id'    => 'your_client_id',
  'client_secret' => 'your_client_secret'
})
token = JSON.parse(res.body)['access_token']

# Use token in subsequent requests
headers = { 'Authorization' => "Bearer #{token}" }

Copyimport java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
String body = "grant_type=client_credentials"
    + "&client_id=your_client_id"
    + "&client_secret=your_client_secret";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.ironbarkaml.com.au/v1/oauth/token"))
    .header("Content-Type", "application/x-www-form-urlencoded")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request,
    HttpResponse.BodyHandlers.ofString());
// Parse access_token from response.body() with a JSON library

Copycurl -X POST https://api.ironbarkaml.com.au/v1/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=YOUR_ID&client_secret=YOUR_SECRET"

Copyconst scan = await fetch(
  "https://api.ironbarkaml.com.au/v1/scans/full",
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      entity_type: "person",
      name: "Anthony Albanese",
      dob: "1963-03-02",
      nationality_code: "AU",
      risk_profile: {
        resident_status: "resident",
        profession: "politician",
        client_visit_type: "non_face_to_face",
      },
    }),
  }
).then(r => r.json());
console.log(scan.scan_id, scan.risk_assessment.risk_level);

Copyrequire 'net/http'
require 'json'

uri = URI('https://api.ironbarkaml.com.au/v1/scans/full')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri.path, {
  'Authorization' => "Bearer #{token}",
  'Content-Type'  => 'application/json'
})
req.body = {
  entity_type: 'person',
  name: 'Anthony Albanese',
  dob: '1963-03-02',
  nationality_code: 'AU'
}.to_json

scan = JSON.parse(http.request(req).body)

CopyString body = """
    {
        "entity_type": "person",
        "name": "Anthony Albanese",
        "dob": "1963-03-02",
        "nationality_code": "AU"
    }
    """;

HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.ironbarkaml.com.au/v1/scans/full"))
    .header("Authorization", "Bearer " + token)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(req,
    HttpResponse.BodyHandlers.ofString());

Copycurl -X POST https://api.ironbarkaml.com.au/v1/scans/full \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "person",
    "name": "Anthony Albanese",
    "dob": "1963-03-02",
    "nationality_code": "AU",
    "risk_profile": {
      "resident_status": "resident",
      "profession": "politician"
    }
  }'

Copyconst scanId = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
const scan = await fetch(`https://api.ironbarkaml.com.au/v1/scans/${scanId}`, {
  headers: { Authorization: `Bearer ${token}` },
}).then(r => r.json());

Copyscan_id = "3fa85f64-5717-4562-b3fc-2c963f66afa6"
uri = URI("https://api.ironbarkaml.com.au/v1/scans/#{scan_id}")
req = Net::HTTP::Get.new(uri, { 'Authorization' => "Bearer #{token}" })
scan = JSON.parse(Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }.body)

CopyHttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.ironbarkaml.com.au/v1/scans/" + scanId))
    .header("Authorization", "Bearer " + token)
    .GET()
    .build();
HttpResponse<String> response = client.send(req,
    HttpResponse.BodyHandlers.ofString());

Copycurl https://api.ironbarkaml.com.au/v1/scans/SCAN_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Copyconst { job_id } = await fetch(
  "https://api.ironbarkaml.com.au/v1/scans/batch",
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      entities: [
        { entity_type: "person", name: "John Smith", nationality_code: "AU" },
        { entity_type: "organisation", name: "Acme Pty Ltd", country_code: "AU" },
      ],
      webhook_url: "https://yourapp.com/webhooks/ironbark",
    }),
  }
).then(r => r.json());

Copyuri = URI('https://api.ironbarkaml.com.au/v1/scans/batch')
req = Net::HTTP::Post.new(uri, {
  'Authorization' => "Bearer #{token}",
  'Content-Type'  => 'application/json'
})
req.body = {
  entities: [
    { entity_type: 'person', name: 'John Smith', nationality_code: 'AU' }
  ],
  webhook_url: 'https://yourapp.com/webhooks/ironbark'
}.to_json
result = JSON.parse(Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }.body)
job_id = result['job_id']

CopyString body = """
    {
        "entities": [
            {"entity_type": "person", "name": "John Smith", "nationality_code": "AU"},
            {"entity_type": "organisation", "name": "Acme Pty Ltd", "country_code": "AU"}
        ],
        "webhook_url": "https://yourapp.com/webhooks/ironbark"
    }
    """;
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.ironbarkaml.com.au/v1/scans/batch"))
    .header("Authorization", "Bearer " + token)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

Copycurl -X POST https://api.ironbarkaml.com.au/v1/scans/batch \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entities": [
      {"entity_type": "person", "name": "John Smith", "nationality_code": "AU"},
      {"entity_type": "organisation", "name": "Acme Pty Ltd", "country_code": "AU"}
    ],
    "webhook_url": "https://yourapp.com/webhooks/ironbark"
  }'

Copyawait fetch(`https://api.ironbarkaml.com.au/v1/cases/${caseId}/decision`, {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    decision: "false_positive",
    reviewer: "compliance@yourfirm.com.au",
    notes: "Name match only — DOB and nationality do not match.",
  }),
});

Copyuri = URI("https://api.ironbarkaml.com.au/v1/cases/#{case_id}/decision")
req = Net::HTTP::Patch.new(uri, {
  'Authorization' => "Bearer #{token}",
  'Content-Type'  => 'application/json'
})
req.body = { decision: 'false_positive', reviewer: 'compliance@yourfirm.com.au' }.to_json

CopyHttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("...v1/cases/" + caseId + "/decision"))
    .header("Authorization", "Bearer " + token)
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(
        "{\"decision\":\"false_positive\",\"reviewer\":\"compliance@yourfirm.com.au\"}"
    ))
    .build();

Copycurl -X PATCH https://api.ironbarkaml.com.au/v1/cases/CASE_ID/decision \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "decision": "false_positive",
    "reviewer": "compliance@yourfirm.com.au",
    "notes": "Name match only — DOB and nationality do not match."
  }'

Copyconst res = await fetch(
  `https://api.ironbarkaml.com.au/v1/cases/${caseId}/report`,
  { headers: { Authorization: `Bearer ${token}` } }
);
const buffer = await res.arrayBuffer();
fs.writeFileSync(`ironbark-case-${caseId.slice(0,8)}.pdf`, Buffer.from(buffer));

Copycurl https://api.ironbarkaml.com.au/v1/cases/CASE_ID/report \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o ironbark-case.pdf

Copyconst crypto = require("crypto");

function verifySignature(body, secret, signatureHeader) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(body)
    .digest("hex");
  const provided = signatureHeader.replace("sha256=", "");
  return crypto.timingSafeEqual(
    Buffer.from(expected), Buffer.from(provided)
  );
}

Copyrequire 'openssl'

def verify_signature(body, secret, signature_header)
  expected = OpenSSL::HMAC.hexdigest('SHA256', secret, body)
  provided = signature_header.sub('sha256=', '')
  ActiveSupport::SecurityUtils.secure_compare(expected, provided)
end