Pliance.io (1.0.0)

Download OpenAPI specification:Download

Specification for the REST APIs of Pliance

CompanyQuery

Search for companies matchings specified criterias.

query Parameters

Page.Size	integer <int32> Select page size (Default 100).
Page.No	integer <int32> Select page (Default 0).
Filter.IsSanction	boolean or null Specify sanction status.
Filter.IsUnclassified	boolean or null Have unclassified matches.
Filter.IsSie	boolean or null Specify SIE status.
Query	string or null Strings to search for.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"result": [{"companyReferenceId": "string",
"name": [{"text": "string",
"isMatch": true
}
],
"isPep": true,
"isRca": true,
"isSanction": true,
"identity": {"identity": "string",
"country": "string"
},
"archived": true,
"isSie": true
}
]
}
}

View a specific company.

query Parameters

CompanyReferenceId

string or null

Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"companyReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"name": "string",
"beneficiaries": [{"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"birthdate": "string",
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
],
"hits": [[{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
]
],
"gender": "Unknown",
"archived": true,
"isPep": true,
"isRca": true,
"isSanction": true,
"birth": {"year": 0,
"month": 0,
"day": 0
},
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSip": true
}
],
"archived": true,
"highRiskCountry": true,
"hits": [[{"matchId": "string",
"aliasId": "string",
"isSanction": true,
"classification": "Unknown",
"name": "string",
"matchedName": [{"text": "string",
"isMatch": true
}
],
"score": 0
}
]
],
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSanction": true,
"isSie": true
}
}

View data for a specific company.

query Parameters

CompanyReferenceId

string or null

Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"name": "string",
"description": "string",
"registrationDate": "2019-08-24T14:15:22Z",
"address": "string",
"city": "string",
"zipCode": "string",
"country": "string",
"parentCompany": {"name": "string",
"identity": "string"
},
"ultimateParentCompany": {"name": "string",
"identity": "string",
"isForeign": true
},
"owners": {"persons": [{"nationalIdentityNumber": "string",
"firstName": "string",
"lastName": "string",
"shares": 0,
"stake": 0,
"votes": 0
}
],
"companies": [{"organizationNumber": "string",
"name": "string",
"shares": 0,
"stake": 0,
"votes": 0
}
]
},
"signatory": "string",
"boardmembers": [{"nationalIdentityNumber": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"zipCode": "string",
"city": "string",
"countryOfResidence": "string",
"role": "Chairman",
"name": "string",
"companyIdentityNumber": "string"
}
],
"legalForm": {"type": 0,
"description": "string"
},
"legalFormType": "LimitedCompany",
"listingType": "Listed"
}
}

List all companies.

query Parameters

Page.Size	integer <int32> Select page size (Default 100).
Page.No	integer <int32> Select page (Default 0).

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"companies": ["string"
]
}
}

PersonQuery

Search for persons matchings specified criterias.

query Parameters

Page.Size	integer <int32> Select page size (Default 100).
Page.No	integer <int32> Select page (Default 0).
Filter.IsPep	boolean or null Specify PEP status.
Filter.IsRca	boolean or null Specify RCA status.
Filter.IsSanction	boolean or null Specify sanction status.
Filter.IsSip	boolean or null Specify SIP status.
Filter.IsUnclassified	boolean or null Have unclassified matches.
Query	string or null Strings to search for.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"result": [{"personReferenceId": "string",
"firstName": [{"text": "string",
"isMatch": true
}
],
"lastName": [{"text": "string",
"isMatch": true
}
],
"isPep": true,
"isRca": true,
"isSanction": true,
"identity": {"identity": "string",
"country": "string"
},
"archived": true,
"isSip": true
}
]
}
}

View a specific person.

query Parameters

PersonReferenceId

string or null

Unique identifer for the person.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"birthdate": "string",
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
],
"hits": [[{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
]
],
"gender": "Unknown",
"archived": true,
"isPep": true,
"isRca": true,
"isSanction": true,
"birth": {"year": 0,
"month": 0,
"day": 0
},
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSip": true
}
}

List all persons.

query Parameters

Page.Size	integer <int32> Select page size (Default 100).
Page.No	integer <int32> Select page (Default 0).

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"persons": ["string"
]
}
}

Ping

Test the accessable of service without mutating the system.

query Parameters

(PingQuery (object or null))

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

ReportQuery

Generate a report for a specific person. Optional period can be specified.

query Parameters

PersonReferenceId	string or null Unique identifer for the person.
From	string or null <date-time> Start date.
To	string or null <date-time> End date.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"result": [{"date": "2019-08-24T14:15:22Z",
"details": "string",
"activity": "Matched",
"name": "string",
"identity": "string",
"personReferenceId": "string"
}
]
}
}

Generate a report for all persons/companies registered in the api. Specified by a period.

query Parameters

From	string or null <date-time> Start date.
To	string or null <date-time> End date.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"result": [{"date": "2019-08-24T14:15:22Z",
"details": "string",
"activity": "Matched",
"name": "string",
"identity": "string"
}
]
}
}

Generate a report for a specific company. Optional period can be specified.

query Parameters

CompanyReferenceId	string or null Unique identifer for the company.
From	string or null <date-time> Start date.
To	string or null <date-time> End date.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"result": [{"date": "2019-08-24T14:15:22Z",
"details": "string",
"activity": "Matched",
"name": "string",
"identity": "string",
"companyReferenceId": "string"
}
]
}
}

WatchlistQuery

View detailed information about the PEP or sanction matches.

query Parameters

Id	string or null MatchId for watchlist match.
FirstName	string or null First name to be used to make matching.
LastName	string or null Last name to be used to make matching.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"listId": "string",
"nationalIdentificationNumber": "string",
"names": [{"firstName": "string",
"lastName": "string",
"selectedFirstName": [{"text": "string",
"isMatch": true
}
],
"selectedLastName": [{"text": "string",
"isMatch": true
}
],
"type": "string"
}
],
"birthdates": [{"circa": true,
"year": 0,
"month": 0,
"day": 0,
"fromYear": 0,
"toYear": 0,
"type": "Date"
}
],
"addresses": [{"street1": "string",
"street2": "string",
"streetNo": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
],
"countries": ["string"
],
"isPep": true,
"isRca": true,
"isSanction": true,
"nationalities": ["string"
],
"images": ["string"
],
"roles": [{"description": "string",
"isActive": true,
"sinceYear": "string",
"sinceMonth": "string",
"sinceDay": "string",
"toYear": "string",
"toMonth": "string",
"toDay": "string"
}
],
"relations": [{"firstName": "string",
"lastName": "string",
"relationPersonId": "string",
"isPep": true,
"isRca": true,
"isSanction": true,
"relationType": "string",
"isSip": true
}
],
"gender": "Unknown",
"lists": ["string"
],
"active": true,
"deceased": true,
"isSip": true,
"watchlistSource": {"filename": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"source": "string"
},
"sources": ["string"
],
"notes": ["string"
]
}
}

View detailed information about the PEP or sanction matches.

query Parameters

MatchId	string or null MatchId for watchlist match.
PersonReferenceId	string or null Unique identifer for the person.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"listId": "string",
"nationalIdentificationNumber": "string",
"names": [{"firstName": "string",
"lastName": "string",
"selectedFirstName": [{"text": "string",
"isMatch": true
}
],
"selectedLastName": [{"text": "string",
"isMatch": true
}
],
"type": "string"
}
],
"birthdates": [{"circa": true,
"year": 0,
"month": 0,
"day": 0,
"fromYear": 0,
"toYear": 0,
"type": "Date"
}
],
"addresses": [{"street1": "string",
"street2": "string",
"streetNo": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
],
"countries": ["string"
],
"isPep": true,
"isRca": true,
"isSanction": true,
"nationalities": ["string"
],
"images": ["string"
],
"roles": [{"description": "string",
"isActive": true,
"sinceYear": "string",
"sinceMonth": "string",
"sinceDay": "string",
"toYear": "string",
"toMonth": "string",
"toDay": "string"
}
],
"relations": [{"firstName": "string",
"lastName": "string",
"relationPersonId": "string",
"isPep": true,
"isRca": true,
"isSanction": true,
"relationType": "string",
"isSip": true
}
],
"gender": "Unknown",
"lists": ["string"
],
"active": true,
"deceased": true,
"isSip": true,
"watchlistSource": {"filename": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"source": "string"
},
"sources": ["string"
],
"notes": ["string"
]
}
}

View detailed information about the sanction matches.

query Parameters

MatchId	string or null MatchId of watchlist match.
CompanyReferenceId	string or null Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"listId": "string",
"isSanction": true,
"names": [{"type": "string",
"name": "string",
"selectedName": [{"text": "string",
"isMatch": true
}
]
}
],
"sanctionLists": ["string"
],
"watchlistSource": {"filename": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"source": "string"
},
"isSie": true,
"addresses": [{"street1": "string",
"street2": "string",
"streetNo": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
],
"active": true,
"notes": ["string"
]
}
}

View detailed information about the company sanction matches.

query Parameters

MatchId	string or null MatchId of watchlist match.
CompanyReferenceId	string or null Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"listId": "string",
"isSanction": true,
"names": [{"type": "string",
"name": "string",
"selectedName": [{"text": "string",
"isMatch": true
}
]
}
],
"sanctionLists": ["string"
],
"watchlistSource": {"filename": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"source": "string"
},
"isSie": true,
"addresses": [{"street1": "string",
"street2": "string",
"streetNo": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
],
"active": true,
"notes": ["string"
]
}
}

View detailed information about the company link PEP or sanction matches.

query Parameters

MatchId	string or null MatchId of watchlist match.
CompanyReferenceId	string or null Unique identifer for the company.
LinkId	string or null Id of the company link.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"listId": "string",
"nationalIdentificationNumber": "string",
"names": [{"firstName": "string",
"lastName": "string",
"selectedFirstName": [{"text": "string",
"isMatch": true
}
],
"selectedLastName": [{"text": "string",
"isMatch": true
}
],
"type": "string"
}
],
"birthdates": [{"circa": true,
"year": 0,
"month": 0,
"day": 0,
"fromYear": 0,
"toYear": 0,
"type": "Date"
}
],
"addresses": [{"street1": "string",
"street2": "string",
"streetNo": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
],
"countries": ["string"
],
"isPep": true,
"isRca": true,
"isSanction": true,
"nationalities": ["string"
],
"images": ["string"
],
"roles": [{"description": "string",
"isActive": true,
"sinceYear": "string",
"sinceMonth": "string",
"sinceDay": "string",
"toYear": "string",
"toMonth": "string",
"toDay": "string"
}
],
"relations": [{"firstName": "string",
"lastName": "string",
"relationPersonId": "string",
"isPep": true,
"isRca": true,
"isSanction": true,
"relationType": "string",
"isSip": true
}
],
"gender": "Unknown",
"lists": ["string"
],
"active": true,
"deceased": true,
"isSip": true,
"watchlistSource": {"filename": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"source": "string"
},
"sources": ["string"
],
"notes": ["string"
]
}
}

WebhookQuery

View current webhook settings.

query Parameters

(WebhookQuery (object or null))

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"enabled": true,
"url": "string",
"secret": "string"
}
}

Test webhook integration.

Request Body schema: application/json

	WebhookPokeType (string) Send a test message of the following type.
referenceId	string or null PersonReferenceId / CompanyReferenceId for the test message.

Responses

Request samples

Payload

Content type

application/json

{"type": "PersonSanctionMatched",
"referenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"remoteBody": "string",
"remoteStatusCode": 0
}

List webhook delivery failures.

query Parameters

(WebhookDeliveryFailuresQuery (object or null))

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"items": [{"timestamp": "2019-08-24T14:15:22Z",
"referenceId": "string",
"type": "string",
"id": "string",
"reason": "string",
"onCreated": true
}
]
}
}

CompanyV2Command

Register or update an already registered company.

Request Body schema: application/json

companyReferenceId required	string Unique identifer for the company.
	(CompanyIdentity (object or null)) Identity of the company.
name	string or null Name of the company.
	(RegisterCompanyOptions (object or null)) Configurable options.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"name": "string",
"options": {"order": "Any",
"fuzziness": "Metaphone",
"omitUltimateBenefitOwner": true,
"validateCompany": true
}
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"name": "string",
"companyReferenceId": "string",
"hits": [[{"matchId": "string",
"aliasId": "string",
"isSanction": true,
"classification": "Unknown",
"name": "string",
"matchedName": [{"text": "string",
"isMatch": true
}
],
"score": 0
}
]
],
"isSanction": true,
"isSie": true,
"archived": true,
"links": [{"id": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"linkDescriptions": [{"type": "Owner",
"roles": ["Chairman"
]
}
],
"personIdentityNumber": "string",
"organizationIdentityNumber": "string",
"matches": [{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
],
"birthDate": {"year": 0,
"month": 0,
"day": 0
},
"gender": "Unknown",
"entityType": "Unspecified"
}
],
"legalForm": "LimitedCompany",
"identity": {"identity": "string",
"country": "string"
},
"description": "string",
"signatory": "string",
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"address": "string",
"city": "string",
"zipcode": "string",
"sni": {"classification": "string",
"classificationCode": "string"
}
}
}

Delete a company. All company data will be deleted from the system.

query Parameters

CompanyReferenceId

string or null

Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Archive a company. An archived company will no longer be daily monitored, also if the company has been archived for the entire billing month, it will be excluded from billing.

Request Body schema: application/json

companyReferenceId

required

string

Unique identifer for the company.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Unarchive a company and add it back to the daily monitoring.

Request Body schema: application/json

companyReferenceId

required

string

Unique identifer for the company.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Classify a match as either Unknown, Match or FalsePositive.

Request Body schema: application/json

companyReferenceId required	string Unique identifer for the company.
matchId required	string Watchlist identifier on the match.
aliasId required	string Alias identifier for the specific match.
required	ClassificationType (string) Status of the specific match.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string",
"matchId": "string",
"aliasId": "string",
"classification": "Unknown"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Classify a company link match as either Unknown, Match or FalsePositive.

Request Body schema: application/json

companyReferenceId required	string Unique identifer for the company.
linkId required	string Unique identifer for the link.
matchId required	string Watchlist identifier on the match.
aliasId required	string Alias identifier for the specific match.
required	ClassificationType (string) Status of the specific match.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string",
"linkId": "string",
"matchId": "string",
"aliasId": "string",
"classification": "Unknown"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

CompanyV2Query

View a specific company.

query Parameters

CompanyReferenceId

string or null

Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"name": "string",
"companyReferenceId": "string",
"hits": [[{"matchId": "string",
"aliasId": "string",
"isSanction": true,
"classification": "Unknown",
"name": "string",
"matchedName": [{"text": "string",
"isMatch": true
}
],
"score": 0
}
]
],
"isSanction": true,
"isSie": true,
"archived": true,
"links": [{"id": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"linkDescriptions": [{"type": "Owner",
"roles": ["Chairman"
]
}
],
"personIdentityNumber": "string",
"organizationIdentityNumber": "string",
"matches": [{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
],
"birthDate": {"year": 0,
"month": 0,
"day": 0
},
"gender": "Unknown",
"entityType": "Unspecified"
}
],
"legalForm": "LimitedCompany",
"identity": {"identity": "string",
"country": "string"
},
"description": "string",
"signatory": "string",
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"address": "string",
"city": "string",
"zipcode": "string",
"sni": {"classification": "string",
"classificationCode": "string"
}
}
}

CompanyCommand

Register or update an already registered company.

Request Body schema: application/json

companyReferenceId required	string Unique identifer for the company.
	(CompanyIdentity (object or null)) Identity of the company.
name required	string Name of the company.
	(RegisterCompanyOptions (object or null)) Configurable options.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"name": "string",
"options": {"order": "Any",
"fuzziness": "Metaphone",
"omitUltimateBenefitOwner": true,
"validateCompany": true
}
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"companyReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"name": "string",
"beneficiaries": [{"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"birthdate": "string",
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
],
"hits": [[{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
]
],
"gender": "Unknown",
"archived": true,
"isPep": true,
"isRca": true,
"isSanction": true,
"birth": {"year": 0,
"month": 0,
"day": 0
},
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSip": true
}
],
"archived": true,
"highRiskCountry": true,
"hits": [[{"matchId": "string",
"aliasId": "string",
"isSanction": true,
"classification": "Unknown",
"name": "string",
"matchedName": [{"text": "string",
"isMatch": true
}
],
"score": 0
}
]
],
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSanction": true,
"isSie": true
}
}

Delete a company. All company data will be deleted from the system.

query Parameters

CompanyReferenceId

string or null

Unique identifer for the company.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Archive a company. An archived company will no longer be daily monitored, also if the company has been archived for the entire billing month, it will be excluded from billing.

Request Body schema: application/json

companyReferenceId

required

string

Unique identifer for the company.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Unarchive a company and add it back to the daily monitoring.

Request Body schema: application/json

companyReferenceId

required

string

Unique identifer for the company.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Classify a match as either Unknown, Match or FalsePositive.

Request Body schema: application/json

companyReferenceId required	string Unique identifer for the company.
matchId required	string Watchlist identifier on the match.
aliasId required	string Alias identifier for the specific match.
required	ClassificationType (string) Status of the specific match.

Responses

Request samples

Payload

Content type

application/json

{"companyReferenceId": "string",
"matchId": "string",
"aliasId": "string",
"classification": "Unknown"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

PersonCommand

Register or update an already registered person.

Request Body schema: application/json

personReferenceId required	string Unique identifer for the person.
	(PersonIdentity (object or null)) Identity of the person.
firstName required	string First name.
lastName required	string Last name.
gender	string or null Valid values: `f`, `female`, `m` or `male`.
	(Birthdate (object or null)) Date of birth.
	Array of objects or null (Address) Residential address.
	(RegisterPersonOptions (object or null)) Configurable options.

Responses

Request samples

Payload

Content type

application/json

{"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthdate": {"year": 0,
"month": 0,
"day": 0
},
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
],
"options": {"order": "Any",
"fuzziness": "Metaphone",
"pepCountries": ["string"
]
}
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"data": {"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"birthdate": "string",
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
],
"hits": [[{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
]
],
"gender": "Unknown",
"archived": true,
"isPep": true,
"isRca": true,
"isSanction": true,
"birth": {"year": 0,
"month": 0,
"day": 0
},
"highRiskCountry": true,
"lastChanged": {"timestampUtc": "2019-08-24T14:15:22Z",
"checkpoint": "string"
},
"isSip": true
},
"hits": [[{"aliasId": "string",
"referenceId": "string",
"matchedFirstName": [{"text": "string",
"isMatch": true
}
],
"matchedLastName": [{"text": "string",
"isMatch": true
}
],
"isSanction": true,
"isPep": true,
"isRca": true,
"isSip": true,
"firstName": "string",
"lastName": "string",
"matchId": "string",
"classification": "Unknown",
"score": 0
}
]
]
}

Delete a person. All person data will be deleted from the system.

query Parameters

PersonReferenceId

string or null

Unique identifer for the person.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Archive a person. An archived person will no longer be daily monitored, also if the person has been archived for the entire billing month, it will be excluded from billing. Use Unarchive to reverse this operation.

Request Body schema: application/json

personReferenceId

required

string

Unique identifer for the company.

Responses

Request samples

Payload

Content type

application/json

{"personReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Unarchive a person and add it back to the daily monitoring.

Request Body schema: application/json

personReferenceId

required

string

Unique identifer for the person.

Responses

Request samples

Payload

Content type

application/json

{"personReferenceId": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Classify a match as either Unknown, Match or FalsePositive.

Request Body schema: application/json

personReferenceId required	string Unique identifer for the person.
matchId required	string Watchlist identifier on the match.
aliasId required	string Alias identifier for the specific match.
required	ClassificationType (string) Status of the specific match.

Responses

Request samples

Payload

Content type

application/json

{"personReferenceId": "string",
"matchId": "string",
"aliasId": "string",
"classification": "Unknown"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Register or update an already registered person.

Request Body schema: application/json

	Array of objects or null (BatchPerson)
	(RegisterPersonOptions (object or null)) Configurable options.

Responses

Request samples

Payload

Content type

application/json

{"persons": [{"personReferenceId": "string",
"identity": {"identity": "string",
"country": "string"
},
"firstName": "string",
"lastName": "string",
"gender": "string",
"birthdate": {"year": 0,
"month": 0,
"day": 0
},
"addresses": [{"street1": "string",
"street2": "string",
"city": "string",
"streetNo": "string",
"postalCode": "string",
"country": "string"
}
]
}
],
"options": {"order": "Any",
"fuzziness": "Metaphone",
"pepCountries": ["string"
]
}
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string",
"personStatuses": [{"personReferenceId": "string",
"status": "Success",
"message": "string"
}
]
}

WebhookCommand

Change webhook settings.

Request Body schema: application/json

enabled	boolean Operational status of the webhook integration.
url	string or null Webhook target URL.
secret	string or null Secret accompanied by requests for `HTTPS` endpoints.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"url": "string",
"secret": "string"
}

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}

Delete failed webhook delivery item with id.

query Parameters

Id	string or null Id of the specific webhook delivery failture that is requested for deletion.

Responses

Response samples

Content type

application/json

{"status": "Success",
"success": true,
"message": "string",
"checkpoint": "string",
"correlationId": "string"
}