Zonos logo
DOCS

Screen parties graphql

/

Screen parties to transactions with the Party Screening API 

Shipping a package internationally? Give yourself and your company peace of mind by using Zonos to screen parties prior to shipment. Denied party lists (or restricted party lists) are lists of individuals, organizations, and entities maintained by the government and international bodies around the world with whom it is forbidden to do business, in whole or in part. Our API will allow you to provide details about any person or entity that you are engaging with to ensure that those persons or entities do not appear on a denied party listing.


Party Screening with no matches 

1. Start a session and supply information for party screening 

To start a session, you will create a mutation with all the information you have for a party that you would like to screen.

POST https://api.zonos.com/graphql

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
mutation Mutation($input: ScreenPartyInput!) {
  screenParty(input: $input) {
}
  }
    )
      {
  action
  createdAt
  createdBy
  id
  mode
  party {
   id
   organizationId
   person {
    firstName
    lastName
   }
  }
  matches {
   name
   companyName
   countryCode
   locality
   deniedParty {
    aliases
    name
    countryCode
    locality
   }
  }
 }
}

Variables

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "screenParty": {
    "location": {
      "countryCode": FR,
  "line1": "71 Avenue du Commandant Barre"
  "locality": "Viry-Chatillon"
    },
    "person": {
      "firstName": "Marcel",
      "lastName": "Goldfarb"
    }
  }
}

2. Interpret the screening response 

The results for a party_screening can change if we have matches for that party on any of our denied party listings. In cases where no matches exist, the action field will return a REVIEW response as well as each of the details about the denied party listing where we found the match.

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
{
 "data": {
  "screenParty": {
   "action": "REVIEW",
   "createdAt": "2022-12-20T18:03:53.762776223Z",
   "createdBy": "organization_01111010-0110-1111-0110-1110-011011110111",
   "id": "screening_9e5922f6-c538-49b0-b37d-99c765f46d06",
   "mode": "LIVE",
   "party": {
    "id": "party_099d6540-e4bf-4c54-a58b-ff123ed977bc",
    "organizationId": "organization_01111010-0110-1111-0110-1110-011011110111",
    "person": {
     "firstName": "Marcel",
     "lastName": "Goldfarb"
    }
   },
   "matches": [
    {
     "name": "PARTIAL_MATCH",
     "companyName": "NO_MATCH",
     "countryCode": "EXACT_MATCH",
     "locality": "PARTIAL_MATCH",
     "deniedParty": {
      "aliases": [
       "GOLDFARB, MARCEL",
       "LEFEBVRE, MARCEL"
      ],
      "name": "LEFEBVRE, MARCEL",
      "countryCode": "FR",
      "locality": "VIRY-CHATILLON"
     }
    },
    {
     "name": "EXACT_MATCH",
     "companyName": "NO_MATCH",
     "countryCode": "EXACT_MATCH",
     "locality": "PARTIAL_MATCH",
     "deniedParty": {
      "aliases": [
       "GOLDFARB, MARCEL",
       "LEFEBVRE, MARCEL"
      ],
      "name": "GOLDFARB, MARCEL",
      "countryCode": "FR",
      "locality": "VIRY-CHATILLON"
     }
    }
   ]
  }
 }
}

In scenarios where no match is found, the action field will return NO_MATCHES and the matches field will return an empty array.

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
 "data": {
  "screenParty": {
   "action": "NO_MATCHES",
   "createdAt": "2022-09-12T19:26:11.687061698Z",
   "createdBy": "organization_01111010-0110-1111-0110-1110-011011110111",
   "id": "screening_8452809b-c353-4663-878f-8439a2e5a45c",
   "mode": "LIVE",
    }
   },
   "matches": []
  }
 }
}