Create a screening

POST/screenings

Screen a name against the sanctions lists

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

countrystringOptional

dobstringOptional

YYYY-MM-DD, a discriminator against the list's dates of birth

namestringRequired

requested_bystringOptional

subject_idstringOptional

The customer id when screening a customer

subject_typestringRequired

Returns

201 Created

The Screening object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/screenings' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "subject_type": "string"
  }'

Response201

{
  "id": "scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "list_age_days": 0,
  "list_stale": false,
  "list_version": "string",
  "list_versions": [
    {
      "age_days": 0,
      "entries": 0,
      "fetch_age_days": 0,
      "hash": "string",
      "id": "string",
      "published_on": "string",
      "version": "string"
    }
  ],
  "lists": "string",
  "matches": [
    {
      "alias_type": "string",
      "dob_match": false,
      "list_id": "string",
      "matched_name": "string",
      "score": 0
    }
  ],
  "name": "string",
  "result": "string",
  "unreadable_script": false
}