DOCS

Screen parties graphql

/

Screen for denied parties

Use Screen to prevent shipping to denied parties.

GraphQL

Screen will allow you to pass names for individuals, companies, and their addresses so that you can ensure that they are not on any government-authored denied party listings.

Required details use Screen 

To use Screen, you will need to provide as much information as you have about a person or company. At minimum, you need to provide a name, countryCode, and locality.

Using Screen 

Screen can be accessed via API or Dashboard. Follow the instructions below to begin integrating Screen into your day-to-day operations.

Matches
No matches
Bulk
Dashboard

Mutation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
mutation {
  partyScreen(
    input: {
      location: {
        countryCode: RU
        line1: "Pr. Yuria Gagarina 2"
        locality: "St. Petersburg"
      }
      person: { firstName: "Yevgeniy", lastName: "Birkyukov" }
    }
  ) {
    action
    createdAt
    createdBy
    id
    mode
    party {
      id
      organization
      person {
        firstName
        lastName
      }
    }
    matches {
      name
      companyName
      countryCode
      locality
      line1
      scores {
        location
        name
        overall
      }
      deniedParty {
        id
        aliases
        name
        countryCode
        locality
        line1
      }
    }
  }
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "data": {
    "partyScreen": {
      "action": "REVIEW",
      "createdAt": "2023-06-30T20:10:53.694Z",
      "createdBy": "organization_8eb9a8fc-8d6c-470b-a887-c8876bbab79c",
      "id": "screening_f4a458b1-b508-43c2-8321-6ffaeb1009ef",
      "mode": "LIVE",
      "party": {
        "id": "party_38c08ef2-165f-434d-aa50-5ec34c05239f",
        "organization": "organization_8eb9a8fc-8d6c-470b-a887-c8876bbab79c",
        "person": {
          "firstName": "Yevgeniy",
          "lastName": "Birkyukov"
        }
      },
      "matches": [
        {
          "name": "EXACT_MATCH",
          "companyName": "NO_MATCH",
          "countryCode": "EXACT_MATCH",
          "locality": "EXACT_MATCH",
          "line1": "EXACT_MATCH",
          "scores": {
            "location": 0.99,
            "name": 0.96,
            "overall": 0.97
          },
          "deniedParty": {
            "id": "denied_party_e8f06902-d9e6-33a0-9ed3-1db0f9ffe9e5",
            "aliases": null,
            "name": "BIRYUKOV, YEVGENIY L",
            "countryCode": "RU",
            "locality": "ST. PETERSBURG",
            "line1": "Pr. Yuria Gagarina 2, Office 801"
          }
        }
      ]
    }
  }
}

Was this page helpful?