Skip to content

Corgi BankDocumentation

OpenAPI

The authorisation's merchant-screening flag from clearing and every screening attempt

GET/authorizations/{id}/merchant-screening

Path parameters

idstringRequired

Returns

200 OK

attemptsarray of objectsRequired

7 child attributes

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

block_idstringOptional

detailstringOptional

idintegerRequired

outcomestringRequired

Unscreened, clear, potential_match, hit

recorded_atstring · date-timeRequired

screening_idstringOptional

Example scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm

authorization_idstringRequired

Example auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm

block_idstringOptional

detailstringOptional

outcomestringRequired

screening_idstringOptional

Example scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/authorizations/{id}/merchant-screening' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "attempts": [
    {
      "authorization_id": "auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "block_id": "string",
      "detail": "string",
      "id": 0,
      "outcome": "string",
      "recorded_at": "2026-09-17T14:30:00Z",
      "screening_id": "scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
    }
  ],
  "authorization_id": "auth_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "block_id": "string",
  "detail": "string",
  "outcome": "string",
  "screening_id": "scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
}