DOCS

Screen parties

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.

1mutation ScreenParty($input: PartyScreenInput!) {
2 partyScreen(input: $input) {
3 action
4 createdAt
5 createdBy
6 id
7 mode
8 party {
9 id
10 organization
11 person {
12 firstName
13 lastName
14 }
15 }
16 matches {
17 name
18 companyName
19 administrativeAreaCode
20 countryCode
21 locality
22 line1
23 line2
24 scores {
25 location
26 name
27 overall
28 }
29 deniedParty {
30 id
31 aliases
32 name
33 countryCode
34 locality
35 line1
36 line2
37 administrativeAreaCode
38 source
39 sourceUrls
40 postalCode
41 }
42 }
43 }
44}
GraphQL API ReferenceTypes, inputs, and operations used in this guide

Was this page helpful?