List screening evidence

GET

/monitoring/screenings

GET

/api/v1/monitoring/screenings

curl https://sandbox-api.toden.co/api/v1/monitoring/screenings \
     -H "Authorization: Bearer <apiKey>"

{
  "screenings": [
    {
      "id": "string",
      "subject": {
        "type": null,
        "id": "string",
        "name": "string"
      },
      "type": "sanctions",
      "status": "queued",
      "matchScore": 1.1,
      "matches": [
        {
          "score": 1.1,
          "name": "string",
          "wallet": "string",
          "matchTypes": [
            "string"
          ],
          "aliases": [
            "string"
          ],
          "birthDates": [
            "string"
          ],
          "nationalities": [
            "string"
          ],
          "identifiers": [
            "string"
          ],
          "programmes": [
            "string"
          ],
          "matchedFields": [
            "string"
          ]
        }
      ],
      "alertId": "string",
      "isOngoing": true,
      "screenedAt": "2024-01-15T09:30:00Z",
      "nextScreenAt": "2024-01-15T09:30:00Z",
      "latestAttempt": {
        "status": "running",
        "assurance": "limited",
        "reasonCode": "string",
        "startedAt": "2024-01-15T09:30:00Z",
        "completedAt": "2024-01-15T09:30:00Z",
        "matchThreshold": 1.1,
        "result": {
          "outcome": "CLEAR",
          "matchCount": 1,
          "topScore": 1.1,
          "matches": [
            {
              "score": 1.1,
              "name": "string",
              "wallet": "string",
              "matchTypes": [
                "string"
              ],
              "aliases": [
                "string"
              ],
              "birthDates": [
                "string"
              ],
              "nationalities": [
                "string"
              ],
              "identifiers": [
                "string"
              ],
              "programmes": [
                "string"
              ],
              "matchedFields": [
                "string"
              ]
            }
          ]
        },
        "failureCode": "string"
      },
      "attempts": [
        {
          "status": "running",
          "assurance": "limited",
          "reasonCode": "string",
          "startedAt": "2024-01-15T09:30:00Z",
          "completedAt": "2024-01-15T09:30:00Z",
          "matchThreshold": 1.1,
          "result": {
            "outcome": "CLEAR",
            "matchCount": 1,
            "topScore": 1.1,
            "matches": [
              {
                "score": 1.1,
                "name": "string",
                "wallet": "string",
                "matchTypes": [
                  "string"
                ],
                "aliases": [
                  "string"
                ],
                "birthDates": [
                  "string"
                ],
                "nationalities": [
                  "string"
                ],
                "identifiers": [
                  "string"
                ],
                "programmes": [
                  "string"
                ],
                "matchedFields": [
                  "string"
                ]
              }
            ]
          },
          "failureCode": "string"
        }
      ],
      "adjudicationHistory": [
        {
          "adjudicatedAt": "2024-01-15T09:30:00Z",
          "outcome": "false_positive",
          "note": "string",
          "matchScore": 1.1
        }
      ]
    }
  ],
  "pagination": {
    "nextCursor": "string"
  }
}

Authentication

AuthorizationBearer

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

Query parameters

limitintegerOptional1-100Defaults to 50

cursorstringOptional

Response

Success

screeningslist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

503

Service Unavailable Error

Authentication

Headers

Query parameters

Response

Errors