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.

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
47
48
49
50
51
52
53
54
55
mutation {
  partyScreen(
    input: {
      location: {
        countryCode: CA
        line1: "909-4005 Bayview Ave"
        locality: "Toronto"
        administrativeAreaCode: "ON"
        postalCode: "M2M 3Z9"
      }
      person: { firstName: "Ali", lastName: "Bakshien" }
    }
  ) {
    action
    createdAt
    createdBy
    id
    mode
    party {
      id
      organization
      person {
        firstName
        lastName
      }
    }
    matches {
      name
      companyName
      administrativeAreaCode
      countryCode
      locality
      line1
      line2
      scores {
        location
        name
        overall
      }
      deniedParty {
        id
        aliases
        name
        countryCode
        locality
        line1
        line2
        administrativeAreaCode
        source
        sourceUrls
        postalCode
      }
    }
  }
}

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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "data": {
    "partyScreen": {
      "action": "REVIEW",
      "createdAt": "2024-06-28T22:41:25.057Z",
      "createdBy": "organization_d117848d-320e-4a28-a2c5-f4a7e991b282",
      "id": "0cf29ea2-d391-4c73-9871-c964be81e136",
      "mode": "LIVE",
      "party": {
        "id": "party_ab91c3fb-6e62-4b2b-8232-e112f1389a77",
        "organization": "organization_d117848d-320e-4a28-a2c5-f4a7e991b282",
        "person": {
          "firstName": "Ali",
          "lastName": "Bakshien"
        }
      },
      "matches": [
        {
          "name": "EXACT_MATCH",
          "companyName": "NO_MATCH",
          "administrativeAreaCode": "EXACT_MATCH",
          "countryCode": "EXACT_MATCH",
          "locality": "EXACT_MATCH",
          "line1": "EXACT_MATCH",
          "line2": "NO_MATCH",
          "scores": {
            "location": 0.99,
            "name": 0.97,
            "overall": 0.98
          },
          "deniedParty": {
            "id": "denied_party_dc2609d9-80fe-382d-b274-fcd1f30c0342",
            "aliases": [],
            "name": "BAKHSHIEN, ALI",
            "countryCode": "CA",
            "locality": "TORONTO",
            "line1": "909-4005 Bayview Ave",
            "line2": null,
            "administrativeAreaCode": "ON",
            "source": "US Dept. of Commerce",
            "sourceUrls": null,
            "postalCode": "M2M 3Z9"
          }
        },
        {
          "name": "NO_MATCH",
          "companyName": "NO_MATCH",
          "administrativeAreaCode": "EXACT_MATCH",
          "countryCode": "EXACT_MATCH",
          "locality": "EXACT_MATCH",
          "line1": "EXACT_MATCH",
          "line2": "NO_MATCH",
          "scores": {
            "location": 0.99,
            "name": 0.0,
            "overall": 0.49
          },
          "deniedParty": {
            "id": "denied_party_cf51e6f1-63b1-39f2-9f73-cf500a29b4d7",
            "aliases": [],
            "name": "KITRO CORPORATION",
            "countryCode": "CA",
            "locality": "TORONTO",
            "line1": "909-4005 Bayview Ave",
            "line2": null,
            "administrativeAreaCode": "ON",
            "source": "US Dept. of Commerce",
            "sourceUrls": null,
            "postalCode": "M2M 3Z9"
          }
        }
      ]
    }
  }
}

Was this page helpful?