Skip to main content
API docs by Redocly

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.

Query
string or null

Strings to search for.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

View a specific company.

query Parameters
CompanyReferenceId
string

Unique identifer for the company.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

View data for a specific company.

query Parameters
CompanyReferenceId
string

Unique identifer for the company.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

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",
  • "data": {
    }
}

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",
  • "data": {
    }
}

View a specific person.

query Parameters
PersonReferenceId
string

Unique identifer for the person.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

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",
  • "data": {
    }
}

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"
}

ReportQuery

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

query Parameters
PersonReferenceId
string

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",
  • "data": {
    }
}

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",
  • "data": {
    }
}

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

query Parameters
CompanyReferenceId
string

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",
  • "data": {
    }
}

WatchlistQuery

View detailed information about the PEP or sanction matches.

query Parameters
Id
string

MatchId for watchlist match.

FirstName
string

First name to be used to make matching.

LastName
string

Last name to be used to make matching.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

View detailed information about the PEP or sanction matches.

query Parameters
MatchId
string

MatchId for watchlist match.

PersonReferenceId
string

Unique identifer for the person.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

View detailed information about the sanction matches.

query Parameters
MatchId
string

MatchId of watchlist match.

CompanyReferenceId
string

Unique identifer for the company.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

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",
  • "data": {
    }
}

Test webhook integration.

Request Body schema: application/json
WebhookPokeType (string)

Send a test message of the following type.

One of
string (WebhookPokeType)
Enum: "PersonSanctionMatched" "PersonSanctionMatchRemoved" "CompanySanctionMatched" "CompanySanctionMatchRemoved"

Send a test message of the following type.

Responses

Request samples

Content type
application/json
{
  • "type": "PersonSanctionMatched"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "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",
  • "data": {
    }
}

CompanyCommand

Register or update an already registered company.

Request Body schema: application/json
companyReferenceId
string

Unique identifer for the company.

(CompanyIdentity (object or null))

Identity of the company.

name
string

Name of the company.

(RegisterCompanyOptions (object or null))

Configurable options.

Responses

Request samples

Content type
application/json
{
  • "companyReferenceId": "string",
  • "identity": {
    },
  • "name": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    }
}

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

query Parameters
CompanyReferenceId
string

Unique identifer for the company.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "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
string

Unique identifer for the company.

Responses

Request samples

Content type
application/json
{
  • "companyReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string"
}

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

Request Body schema: application/json
companyReferenceId
string

Unique identifer for the company.

Responses

Request samples

Content type
application/json
{
  • "companyReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string"
}

Classify a match as either Unknown, Match or FalsePositive.

Request Body schema: application/json
companyReferenceId
string

Unique identifer for the company.

matchId
string

Watchlist identifier on the match.

aliasId
string

Alias identifier for the specific match.

ClassificationType (string)

Status of the specific match.

Responses

Request samples

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"
}

PersonCommand

Register or update an already registered person.

Request Body schema: application/json
personReferenceId
string

Unique identifer for the person.

(PersonIdentity (object or null))

Identity of the person.

firstName
string

First name.

lastName
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

Content type
application/json
{
  • "personReferenceId": "string",
  • "identity": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "birthdate": {
    },
  • "addresses": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string",
  • "data": {
    },
  • "hits": [
    ]
}

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

query Parameters
PersonReferenceId
string

Unique identifer for the person.

Responses

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "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
string

Unique identifer for the company.

Responses

Request samples

Content type
application/json
{
  • "personReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string"
}

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

Request Body schema: application/json
personReferenceId
string

Unique identifer for the person.

Responses

Request samples

Content type
application/json
{
  • "personReferenceId": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string"
}

Classify a match as either Unknown, Match or FalsePositive.

Request Body schema: application/json
personReferenceId
string

Unique identifer for the person.

matchId
string

Watchlist identifier on the match.

aliasId
string

Alias identifier for the specific match.

ClassificationType (string)

Status of the specific match.

Responses

Request samples

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"
}

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

Content type
application/json
{
  • "enabled": true,
  • "url": "string",
  • "secret": "string"
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "success": true,
  • "message": "string",
  • "checkpoint": "string"
}