Pibisi API documentation version v2
https://api.pibisi.com/v2
Introduction
This document describes the endpoints of the elegant, easy-to-use REST API to communicate with Pibisi and is of the full Pibisi API documentation.
Endpoints
In the following sections you can find a detailed explanation of all endpoints. Enjoy!
/accounts/{account}/alerts
get
Returns all type of alerts with all statuses
get /accounts/{account}/alerts/
Returns all type of alerts with all statuses
URI Parameters
- account: required(string)
Account's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- entity: (string)
Optional type of entity to get alerts of. It must be one of 'customer','wallet','all'.
- type: (string)
Optional alert type to be returned. Some examples are 'is_pep', 'is_terrorist', 'was_pep'...
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "pending",
"processed_at": ""
},
{
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "pending",
"processed_at": ""
},
{
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"wallet_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "max_cash_out",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "pending",
"processed_at": ""
}
],
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
get
Returns all information about one alert
get /accounts/{account}/alerts/{alert}
Returns all information about one alert
URI Parameters
- account: required(string)
Account's UUID identifier
- alert: required(string)
Alert's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "pending",
"processed_at": ""
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Accepts and finishes the alert
post /accounts/{account}/alerts/{alert}/accept
Accepts and finishes the alert
URI Parameters
- account: required(string)
Account's UUID identifier
- alert: required(string)
Alert's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- comment: required(string)
Optional comment to be added
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "accepted",
"processed_at": "2019-01-12 14:34:56"
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Puts the alert on-hold to handle it later
post /accounts/{account}/alerts/{alert}/monitor
Puts the alert on-hold to handle it later
URI Parameters
- account: required(string)
Account's UUID identifier
- alert: required(string)
Alert's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- comment: required(string)
Optional comment to be added
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "monitored",
"processed_at": ""
}
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Rejects and finishes the alert.
You reject an alert when it was based on a wrong person matching. When this occurs, our team will review a request to resolve this wrong match. Until then the person information will still appear merged.
post /accounts/{account}/alerts/{alert}/reject
Rejects and finishes the alert.
You reject an alert when it was based on a wrong person matching. When this occurs, our team will review a request to resolve this wrong match. Until then the person information will still appear merged.
URI Parameters
- account: required(string)
Account's UUID identifier
- alert: required(string)
Alert's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- comment: required(string)
Optional comment to be added
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "rejected",
"processed_at": "2019-01-12 14:34:56"
}
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
/accounts/{account}/customers
get
Lists all added customers for the given company account
post
Registers a new person (customer) to follow up.
You can send multiple pieces of information (aka. pois), but at least the types 'person' (allowed values: 'P' for natural person, and 'E' for legal person) and 'name.full' must be included.
Following pieces of information are mandatory: person, name.full, id.national, birth.date, etc
get /accounts/{account}/customers/
Lists all added customers for the given company account
URI Parameters
- account: required(string)
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- page: (integer)
Optional number of page
- status: (string)
One of 'active', 'inactive', or 'all'.
- risk: (string)
One of 'low', 'medium', 'high' or 'blocked'.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
]
},
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"status": "active",
"risk": "medium",
"expires_at": "",
"created_at": "2019-06-04 12:11:35",
"info": [
{
"type": "name.full",
"content": "Tyrion Lannister",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
},
{
"type": "name.alias",
"content": "The Halfman",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
},
{
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
}
]
}
],
"meta": {
"count": 5,
"total_count": 1125,
"query": {
"page": "2",
"status": "active",
"risk": "all"
},
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post /accounts/{account}/customers/
Registers a new person (customer) to follow up.
You can send multiple pieces of information (aka. pois), but at least the types 'person' (allowed values: 'P' for natural person, and 'E' for legal person) and 'name.full' must be included.
Following pieces of information are mandatory: person, name.full, id.national, birth.date, etc
URI Parameters
- account: required(string)
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- pois: required(string)
Mandatory Points of Information describing the customers (JSON encoded).
- lifetime: (number)
Lifetime of the customer in days until he/she turns automatically to inactive status. This parameter overwrites the default configuration, but only for this customer.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"uuid": "0a31f1d5-f94f-459b-9021-asdf68f1633c",
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
],
"scoring": {
"value": 10,
"flags": {
"is_pep": false,
"is_sanctioned": true,
"is_terrorist": false,
}
"info": {
"pep": [],
"sanctioned": ["0a31f1d5-f94f-459b-9021-f78b68f1633c"],
"terrorist": []
}
}
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Make a search in customers.
The search term will be matched against names and document ids of the customers.
post /accounts/{account}/customers/find
Make a search in customers.
The search term will be matched against names and document ids of the customers.
URI Parameters
- account: required(string)
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- search: required(string)
Search term to look for.
- status: (string)
You can search only inside the active or inactive customers.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
]
},
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"status": "active",
"risk": "medium",
"expires_at": "",
"created_at": "2019-06-04 12:11:35",
"info": [
{
"type": "name.full",
"content": "Tyrion Lannister",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
},
{
"type": "name.alias",
"content": "The Halfman",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
},
{
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Tyrion_Lannister",
"reliability": 1
}
],
}
]
}
],
"meta": {
"count": 2,
"total_count": 1125,
"query": {
"page": "1",
"status": "active",
"risk": "all"
},
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
get
Returns all information (visible for the given company account) of a customer
get /accounts/{account}/customers/{customer}
Returns all information (visible for the given company account) of a customer
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
],
"scoring": {
"value": 10,
"flags": {
"is_pep": false,
"was_pep": true,
"was_pep_date": "1979-01-02T23:59:59+00:00",
"is_sanctioned": false,
"was_sanctioned": false,
"was_sanctioned_date": null,
"is_terrorist": false,
"has_media": true,
"has_adverse_info": false,
"is_high_risk": false,
"has_matches": true,
},
"info": {
"pep": [
"89dabe55-021e-4eec-aefe-8130548d3751"
],
"sanctioned": [],
"terrorist": [],
"media": [
"8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c"
],
"adverse_info": [],
"high_risk": [],
"matches": [
"e2152461-b8a2-4245-b414-b410f42f3b3a"
]
}
}
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Reactivates a customer after having being deactivated and starts monitoring again.
post /accounts/{account}/customers/{customer}/activate
Reactivates a customer after having being deactivated and starts monitoring again.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: any
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active"
}
get
Returns all alerts related to a given customer
get /accounts/{account}/customers/{customer}/alerts
Returns all alerts related to a given customer
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "pending",
"processed_at": ""
},
{
"uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
"customer_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
"type": "is_pep",
"comment": "Comment",
"registered_at": "2019-01-12 12:34:56",
"status": "accepted",
"processed_at": "2019-01-12 13:34:56"
}
],
"meta": {
"count": 2,
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Sets a new risk value
You can change the risk and add a comment. As response you will get the whole customer object.
post /accounts/{account}/customers/{customer}/change-risk
Sets a new risk value
You can change the risk and add a comment. As response you will get the whole customer object.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- risk: required(string)
Risk value to be set. One of 'low', 'medium', 'high' or 'blocked'.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
]
"scoring": {
"value": 10,
"flags": {
"is_pep": false,
"was_pep": true,
"was_pep_date": "1979-01-02T23:59:59+00:00",
"is_sanctioned": false,
"was_sanctioned": false,
"was_sanctioned_date": null,
"is_terrorist": false,
"has_media": true,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [
"89dabe55-021e-4eec-aefe-8130548d3751"
],
"sanctioned": [],
"terrorist": [],
"media": [
"8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c"
],
"adverse_info": [],
"high_risk": []
}
}
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Deactivates a customer and stops monitoring.
You normally deactivate a customer when he/she is no longer your customer but want or need to keep the data.
post /accounts/{account}/customers/{customer}/deactivate
Deactivates a customer and stops monitoring.
You normally deactivate a customer when he/she is no longer your customer but want or need to keep the data.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: any
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "inactive"
}
post
Deletes a customer. This operation is destructive and cannot be undone.
You normally delete a customer if the information was erroneous or when you want to eliminate the data for GDPR purposes.
post /accounts/{account}/customers/{customer}/delete
Deletes a customer. This operation is destructive and cannot be undone.
You normally delete a customer if the information was erroneous or when you want to eliminate the data for GDPR purposes.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: any
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "deleted"
}
get
Returns all uploaded documents related to a given customer
get /accounts/{account}/customers/{customer}/documents
Returns all uploaded documents related to a given customer
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"created_at": "2018-08-28T05:36:11+00:00",
"name": "Documento nacional de identidad",
"original_name": "Document de identidad - Alejandro.pdf",
"type": "doc_dni",
"url":"https://pibisi.com/es/docs/..."
},
{
"created_at": "2018-08-28T05:36:11+00:00",
"name": "Documento nacional de identidad",
"original_name": "Document de identidad - Alejandro (2).pdf",
"type": "doc_dni"
"url":"https://pibisi.com/es/docs/..."
}
],
"meta": {
"count": 2
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
get
Returns all current possible matches for the current customer
get /accounts/{account}/customers/{customer}/matches
Returns all current possible matches for the current customer
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "e2152661-b8a2-4245-b414-b4d0f42f3b3a",
"customer_id": "4103fcbd-5769-4c90-94c6-e046672f2525",
"subject_id": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"subject": {
"uuid": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"info": [
{
"uuid": "e09fc966-43f3-444b-b6fb-7b9446d3aabc",
"type": "illegal",
"content": "terrorist",
"sois": [...]
},
{
"uuid": "dd21afab-90f6-4884-a388-743250561e9e",
"type": "id.platform",
"content": {
"number": "70",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "5507b580-cb7d-4eda-b212-c3a1d3c40827",
"type": "person",
"content": "P",
"sois": [...]
},
{
"uuid": "f9ef5ff0-6982-444c-8b10-2e3e8463f9ff",
"type": "name.full",
"content": "Grace Mugabe",
"sois": [...]
},
{
"uuid": "ddb21eb0-eb41-478f-b129-5c06328f74e2",
"type": "gender",
"content": "F",
"sois": [...]
},
{
"uuid": "fdd18da5-2416-40a0-8afd-5cfc4c8f0ba5",
"type": "birth.date",
"content": "1965-07-23",
"sois": [...]
},
{
"uuid": "a956f8a7-aaff-439f-ba76-c9019439fe27",
"type": "id.national",
"content": {
"number": "AD001159",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "e642e749-2606-4618-8c6c-a331b84f0f0a",
"type": "id.national",
"content": {
"number": "63-646650",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "27a43685-5cce-4e84-86b4-bb5705577c8b",
"type": "illegal",
"content": "sanctioned",
"sois": [...]
},
{
"uuid": "1fd42508-34ea-45bd-8255-72317c5ddc17",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "d2490c4a-b87c-4276-b402-540ffca56a62",
"type": "name.full",
"content": "robert grace mugabe",
"sois": [...]
},
{
"uuid": "7fbf3466-4463-432c-8c2c-7257a839da65",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEUX"
},
"sois": [...]
}
],
"scoring": {
"value": 10,
"flags": {
"value": 10,
"is_pep": false,
"was_pep": false,
"was_pep_date": 0,
"is_sanctioned": true,
"was_sanctioned": false,
"was_sanctioned_date": "",
"is_terrorist": true,
"has_media": false,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [],
"pep_pois": [],
"pep_relations": [],
"sanctioned": [
"27a43685-5cce-4e84-86b4-bb5705577c8b"
],
"terrorist": [
"e09fc966-43f3-444b-b6fb-7b9446d3aabc"
],
"media": [],
"adverse_info": [],
"high_risk": []
}
}
},
"status": "pending",
"comment": "No es",
"similarity": 0.99995,
"cardinality": 0.00625,
"identity": true,
"compatible": false,
"vector": {
"gender": {
"exact": 0,
"fuzzy": "bk"
},
"person": {
"exact": 1,
"fuzzy": "eq"
},
"illegal": {
"exact": 1,
"fuzzy": "eq"
},
"name.full": {
"exact": 0.9998,
"fuzzy": "eq"
},
"birth.date": {
"exact": 0,
"fuzzy": "ne"
},
"id.national": {
"exact": 0,
"fuzzy": "bk"
},
"id.platform": {
"exact": 1,
"fuzzy": "eq"
}
},
"created_at": "2021-09-13T13:57:15+00:00"
}
],
"meta": {
"count": 1,
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Rejects all pending matches for the given customer.
post /accounts/{account}/customers/{customer}/matches/reject-all
Rejects all pending matches for the given customer.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: any
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "e2152661-b8a2-4245-b414-b4d0f42f3b3a",
"customer_id": "4103fcbd-5769-4c90-94c6-e046672f2525",
"subject_id": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"subject": {
"uuid": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"info": [
{
"uuid": "e09fc966-43f3-444b-b6fb-7b9446d3aabc",
"type": "illegal",
"content": "terrorist",
"sois": [...]
},
{
"uuid": "dd21afab-90f6-4884-a388-743250561e9e",
"type": "id.platform",
"content": {
"number": "70",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "5507b580-cb7d-4eda-b212-c3a1d3c40827",
"type": "person",
"content": "P",
"sois": [...]
},
{
"uuid": "f9ef5ff0-6982-444c-8b10-2e3e8463f9ff",
"type": "name.full",
"content": "Grace Mugabe",
"sois": [...]
},
{
"uuid": "ddb21eb0-eb41-478f-b129-5c06328f74e2",
"type": "gender",
"content": "F",
"sois": [...]
},
{
"uuid": "fdd18da5-2416-40a0-8afd-5cfc4c8f0ba5",
"type": "birth.date",
"content": "1965-07-23",
"sois": [...]
},
{
"uuid": "a956f8a7-aaff-439f-ba76-c9019439fe27",
"type": "id.national",
"content": {
"number": "AD001159",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "e642e749-2606-4618-8c6c-a331b84f0f0a",
"type": "id.national",
"content": {
"number": "63-646650",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "27a43685-5cce-4e84-86b4-bb5705577c8b",
"type": "illegal",
"content": "sanctioned",
"sois": [...]
},
{
"uuid": "1fd42508-34ea-45bd-8255-72317c5ddc17",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "d2490c4a-b87c-4276-b402-540ffca56a62",
"type": "name.full",
"content": "robert grace mugabe",
"sois": [...]
},
{
"uuid": "7fbf3466-4463-432c-8c2c-7257a839da65",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEUX"
},
"sois": [...]
}
],
"scoring": {
"value": 10,
"flags": {
"value": 10,
"is_pep": false,
"was_pep": false,
"was_pep_date": 0,
"is_sanctioned": true,
"was_sanctioned": false,
"was_sanctioned_date": "",
"is_terrorist": true,
"has_media": false,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [],
"pep_pois": [],
"pep_relations": [],
"sanctioned": [
"27a43685-5cce-4e84-86b4-bb5705577c8b"
],
"terrorist": [
"e09fc966-43f3-444b-b6fb-7b9446d3aabc"
],
"media": [],
"adverse_info": [],
"high_risk": []
}
}
},
"status": "rejected",
"comment": "Sí es",
"similarity": 0.99995,
"cardinality": 0.00625,
"identity": true,
"compatible": false,
"vector": {
"gender": {
"exact": 0,
"fuzzy": "bk"
},
"person": {
"exact": 1,
"fuzzy": "eq"
},
"illegal": {
"exact": 1,
"fuzzy": "eq"
},
"name.full": {
"exact": 0.9998,
"fuzzy": "eq"
},
"birth.date": {
"exact": 0,
"fuzzy": "ne"
},
"id.national": {
"exact": 0,
"fuzzy": "bk"
},
"id.platform": {
"exact": 1,
"fuzzy": "eq"
}
},
"created_at": "2021-09-13T13:57:15+00:00"
}
],
"meta": {
"count": 1,
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Accepts the given match, meaning it is the same as the customer.
post /accounts/{account}/customers/{customer}/matches/{match}/accept
Accepts the given match, meaning it is the same as the customer.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
- match: required(string)
Customer match's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- comment: required(string)
Comment to be attached to the customer match entity.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "e2152661-b8a2-4245-b414-b4d0f42f3b3a",
"customer_id": "4103fcbd-5769-4c90-94c6-e046672f2525",
"subject_id": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"subject": {
"uuid": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"info": [
{
"uuid": "e09fc966-43f3-444b-b6fb-7b9446d3aabc",
"type": "illegal",
"content": "terrorist",
"sois": [...]
},
{
"uuid": "dd21afab-90f6-4884-a388-743250561e9e",
"type": "id.platform",
"content": {
"number": "70",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "5507b580-cb7d-4eda-b212-c3a1d3c40827",
"type": "person",
"content": "P",
"sois": [...]
},
{
"uuid": "f9ef5ff0-6982-444c-8b10-2e3e8463f9ff",
"type": "name.full",
"content": "Grace Mugabe",
"sois": [...]
},
{
"uuid": "ddb21eb0-eb41-478f-b129-5c06328f74e2",
"type": "gender",
"content": "F",
"sois": [...]
},
{
"uuid": "fdd18da5-2416-40a0-8afd-5cfc4c8f0ba5",
"type": "birth.date",
"content": "1965-07-23",
"sois": [...]
},
{
"uuid": "a956f8a7-aaff-439f-ba76-c9019439fe27",
"type": "id.national",
"content": {
"number": "AD001159",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "e642e749-2606-4618-8c6c-a331b84f0f0a",
"type": "id.national",
"content": {
"number": "63-646650",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "27a43685-5cce-4e84-86b4-bb5705577c8b",
"type": "illegal",
"content": "sanctioned",
"sois": [...]
},
{
"uuid": "1fd42508-34ea-45bd-8255-72317c5ddc17",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "d2490c4a-b87c-4276-b402-540ffca56a62",
"type": "name.full",
"content": "robert grace mugabe",
"sois": [...]
},
{
"uuid": "7fbf3466-4463-432c-8c2c-7257a839da65",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEUX"
},
"sois": [...]
}
],
"scoring": {
"value": 10,
"flags": {
"value": 10,
"is_pep": false,
"was_pep": false,
"was_pep_date": 0,
"is_sanctioned": true,
"was_sanctioned": false,
"was_sanctioned_date": "",
"is_terrorist": true,
"has_media": false,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [],
"pep_pois": [],
"pep_relations": [],
"sanctioned": [
"27a43685-5cce-4e84-86b4-bb5705577c8b"
],
"terrorist": [
"e09fc966-43f3-444b-b6fb-7b9446d3aabc"
],
"media": [],
"adverse_info": [],
"high_risk": []
}
}
},
"status": "accepted",
"comment": "Sí es",
"similarity": 0.99995,
"cardinality": 0.00625,
"identity": true,
"compatible": false,
"vector": {
"gender": {
"exact": 0,
"fuzzy": "bk"
},
"person": {
"exact": 1,
"fuzzy": "eq"
},
"illegal": {
"exact": 1,
"fuzzy": "eq"
},
"name.full": {
"exact": 0.9998,
"fuzzy": "eq"
},
"birth.date": {
"exact": 0,
"fuzzy": "ne"
},
"id.national": {
"exact": 0,
"fuzzy": "bk"
},
"id.platform": {
"exact": 1,
"fuzzy": "eq"
}
},
"created_at": "2021-09-13T13:57:15+00:00"
}
],
"meta": {
"count": 1,
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Rejects the given match, meaning it is a false positive.
post /accounts/{account}/customers/{customer}/matches/{match}/reject
Rejects the given match, meaning it is a false positive.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
- match: required(string)
Customer match's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- comment: required(string)
Comment to be attached to the customer match entity.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"uuid": "e2152661-b8a2-4245-b414-b4d0f42f3b3a",
"customer_id": "4103fcbd-5769-4c90-94c6-e046672f2525",
"subject_id": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"subject": {
"uuid": "b46a4bd5-4ce8-460d-82e3-7c4709d2d169",
"info": [
{
"uuid": "e09fc966-43f3-444b-b6fb-7b9446d3aabc",
"type": "illegal",
"content": "terrorist",
"sois": [...]
},
{
"uuid": "dd21afab-90f6-4884-a388-743250561e9e",
"type": "id.platform",
"content": {
"number": "70",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "5507b580-cb7d-4eda-b212-c3a1d3c40827",
"type": "person",
"content": "P",
"sois": [...]
},
{
"uuid": "f9ef5ff0-6982-444c-8b10-2e3e8463f9ff",
"type": "name.full",
"content": "Grace Mugabe",
"sois": [...]
},
{
"uuid": "ddb21eb0-eb41-478f-b129-5c06328f74e2",
"type": "gender",
"content": "F",
"sois": [...]
},
{
"uuid": "fdd18da5-2416-40a0-8afd-5cfc4c8f0ba5",
"type": "birth.date",
"content": "1965-07-23",
"sois": [...]
},
{
"uuid": "a956f8a7-aaff-439f-ba76-c9019439fe27",
"type": "id.national",
"content": {
"number": "AD001159",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "e642e749-2606-4618-8c6c-a331b84f0f0a",
"type": "id.national",
"content": {
"number": "63-646650",
"country": "DEU"
},
"sois": [...]
},
{
"uuid": "27a43685-5cce-4e84-86b4-bb5705577c8b",
"type": "illegal",
"content": "sanctioned",
"sois": [...]
},
{
"uuid": "1fd42508-34ea-45bd-8255-72317c5ddc17",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEU"
},
"sois": [...]
},
{
"uuid": "d2490c4a-b87c-4276-b402-540ffca56a62",
"type": "name.full",
"content": "robert grace mugabe",
"sois": [...]
},
{
"uuid": "7fbf3466-4463-432c-8c2c-7257a839da65",
"type": "id.platform",
"content": {
"number": "EU.149.69",
"platform": "EuropaEUX"
},
"sois": [...]
}
],
"scoring": {
"value": 10,
"flags": {
"value": 10,
"is_pep": false,
"was_pep": false,
"was_pep_date": 0,
"is_sanctioned": true,
"was_sanctioned": false,
"was_sanctioned_date": "",
"is_terrorist": true,
"has_media": false,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [],
"pep_pois": [],
"pep_relations": [],
"sanctioned": [
"27a43685-5cce-4e84-86b4-bb5705577c8b"
],
"terrorist": [
"e09fc966-43f3-444b-b6fb-7b9446d3aabc"
],
"media": [],
"adverse_info": [],
"high_risk": []
}
}
},
"status": "rejected",
"comment": "Sí es",
"similarity": 0.99995,
"cardinality": 0.00625,
"identity": true,
"compatible": false,
"vector": {
"gender": {
"exact": 0,
"fuzzy": "bk"
},
"person": {
"exact": 1,
"fuzzy": "eq"
},
"illegal": {
"exact": 1,
"fuzzy": "eq"
},
"name.full": {
"exact": 0.9998,
"fuzzy": "eq"
},
"birth.date": {
"exact": 0,
"fuzzy": "ne"
},
"id.national": {
"exact": 0,
"fuzzy": "bk"
},
"id.platform": {
"exact": 1,
"fuzzy": "eq"
}
},
"created_at": "2021-09-13T13:57:15+00:00"
}
],
"meta": {
"count": 1,
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Adds a new Point of Information to the customer
post /accounts/{account}/customers/{customer}/pois
Adds a new Point of Information to the customer
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- data: required(string)
Points of information to be added (JSON encoded)
- fix: (bool - default: false)
True if other Points of Information of the same type should be deleted after adding the new one.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"status": "active",
"risk": "low",
"expires_at": "",
"created_at": "2019-06-03 17:29:23",
"info": [
{
"uuid": "0a31f1d5-f94f-459b-9021-asdf68f1633c",
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
],
"scoring": {
"is_pep": false,
"is_sanctioned": true,
"is_terrorist": false,
"value": 10,
"info": {
"pep": []
"sanctioned": ["0a31f1d5-f94f-459b-9021-f78b68f1633c"],
"terrorist": []
}
}
}
get
Returns a PDF document describing a report for the given customer.
get /accounts/{account}/customers/{customer}/report
Returns a PDF document describing a report for the given customer.
URI Parameters
- account: required(string)
- customer: required(string)
Customer's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
/accounts/{account}/services
post
Scans a set of image files from a single document and returns the read info.
You can upload the front and rear images separately, but it is recommended to upload both using the same request to improve performance.
post /accounts/{account}/services/scan-document
Scans a set of image files from a single document and returns the read info.
You can upload the front and rear images separately, but it is recommended to upload both using the same request to improve performance.
URI Parameters
- account: required(string)
Account's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- files: required(file)
Set of images to be processed (valid formats: .png, .jpg)
- meta: (string)
Configuration list in json format for the given image files
- view: Image view [ front | rear ]
- type: Document type. [ esp.dni | esp.passport ]
Example:
{ "files": [file1.png, file2.png] "meta": [ { "view": "front", "type": "esp.dni" }, { "view": "rear", "type": "esp.dni" }, ] }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"pois": [
{
"type": "photo",
"content": {
"data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJQAAAChCAIAAACu6QGdAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAgAElEQVR42sy925Ykx3Elahf3iMis6ga6GwRJiKKkmXM0//88HzFL68w6T5oZzUgEmkDfqiovEeFutufBIjyjsgpAg1oK=="
},
"reliability": 0.99
},
{
"type": "id.national",
"content": {
"number": "12345678Z",
"country": "ESP"
},
"reliability": 0.99
},
{
"type": "name.full",
"content": "juan español español",
"reliability": 0.85
},
{
"type": "person",
"content": "P",
"reliability": 0.99
},
{
"type": "nationality",
"content": "ESP",
"reliability": 0.99
},
{
"type": "gender",
"content": "M",
"reliability": 0.99
},
{
"type": "birth.date",
"content": "1970-01-01",
"reliability": 0.6
}
]
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
/accounts/{account}/search-results
get
Returns all information (visible for the given company account) of a specific search.
get /accounts/{account}/search-results/{search_result}
Returns all information (visible for the given company account) of a specific search.
URI Parameters
- account: required(string)
- search_result: required(string)
Search results' UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "498aa292-f8b9-9bc9-9b97-a4b5fae1f024",
"performed_at": "2021-03-13T09:36:30+00:00",
"status": "processed",
"pois": [
{
"type": "name.full",
"content": "felipe gonzalez"
}
],
"matches": [...],
"full_matches": [...],
},
"meta": {
"version": "v2"
}
}
post
Clears all sensitive data of a given search and set the status to 'cleared'.
post /accounts/{account}/search-results/{search_result}/clear
Clears all sensitive data of a given search and set the status to 'cleared'.
URI Parameters
- account: required(string)
- search_result: required(string)
Search results' UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "498aa292-f8b9-9bc9-9b97-a4b5fae1f024",
"performed_at": "2021-03-13T09:36:30+00:00",
"status": "cleared",
"pois": [],
"matches": [],
"full_matches": [],
},
"meta": {
"version": "v2"
}
}
get
Returns a PDF document describing a negative search report (no matches found) for a given query.
get /accounts/{account}/search-results/{search_result}/report
Returns a PDF document describing a negative search report (no matches found) for a given query.
URI Parameters
- account: required(string)
- search_result: required(string)
Search results' UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Query Parameters
- pois: required(string)
Points of information that will be used for the search
/accounts/{account}/subjects
post
Makes a query to find possible matches.
You can query by multiple pieces of information (aka. pois), such as name.full or id.national.
post /accounts/{account}/subjects/find
Makes a query to find possible matches.
You can query by multiple pieces of information (aka. pois), such as name.full or id.national.
URI Parameters
- account: required(string)
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- threshold: (number - default: 0.9)
Mininum similarity threshold to be considered as a valid match.
- pois: required(string)
Points of information describing the search (JSON encoded)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"matches": [
{
"uuid": "6bb32da7-1c30-4909-87bc-fd9f98bcdde4",
"info": [
{
"uuid": "5b161766-b5da-4c15-a384-20e7349829b2",
"type": "person",
"content": "P",
"sois": [
{
"description": null,
"uri": "account:76532451-4b5c-434c-a205-4a307026ded9",
"reliability": 0.5,
},
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "11929d61-b4c4-4078-8a11-5cbd12956c44",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "89dabe55-021e-4eec-aefe-8130548d3751",
"type": "function.public",
"content": {
"charge": "Diputado",
"organization": "Congreso de España",
"from": "1977-07-02",
"to": "1979-01-02"
},
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "f7f6288d-2695-44eb-9b01-21d1d6291f12",
"type": "name.full",
"content": "felipe gonzález márquez",
"sois": [
{
"description": null,
"uri": "account:76532451-4b5c-434c-a205-4a307026ded9",
"reliability": 0.5,
},
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "30de7dcf-aa67-496c-bcc4-42976c2e014c",
"type": "photo",
"content": {
"url": "http://api.pibisi.local/docs/0b1715d2f8e96a91_1570465919.jpg"
},
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c",
"type": "media",
"content": {
"types": [
"NEWS"
],
"issuer": "Libertad Digital",
"from": "2014-07-04",
"url": "http://www.libertaddigital.com/espana/2014-07-04/anticorrupcion-pide-imputar-al-sobrino-de-felipe-gonzalez-en-el-caso-invercaria-1276523046/"
},
"sois": [
{
"description": "Found adverse media using Search Engines",
"uri": "http://www.libertaddigital.com/espana/2014-07-04/anticorrupcion-pide-imputar-al-sobrino-de-felipe-gonzalez-en-el-caso-invercaria-1276523046/",
"reliability": 0.5,
}
]
}
],
"similarity": 0.9916,
"scoring": {
"value": 0,
"flags": {
"value": 0,
"is_pep": false,
"was_pep": true,
"was_pep_date": "1979-01-02T23:59:59+00:00",
"is_sanctioned": false,
"was_sanctioned": false,
"was_sanctioned_date": null,
"is_terrorist": false,
"has_media": true,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [
"89dabe55-021e-4eec-aefe-8130548d3751"
],
"sanctioned": [],
"terrorist": [],
"media": [
"8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c"
],
"adverse_info": [],
"high_risk": []
}
}
},
],
"search_result": {
"uuid": "498aa292-f8b9-9bc9-9b97-a4b5fae1f024",
"performed_at": "2021-03-13T09:36:30+00:00",
"status": "processed",
"pois": [
{
"type": "name.full",
"content": "felipe gonzalez"
}
],
"matches": [...]
}
},
"meta": {
"count": 1,
"query": {
"pois": [
{
"type": "person",
"content": "P"
},
{
"type": "name.full",
"content": "Felipe González Márquez"
}
]
},
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
post
Makes a query to find possible matches only against sanctions and terrorists lists.
You can query by multiple pieces of information (aka. pois), such as name.full or id.national.
post /accounts/{account}/subjects/find-blocked
Makes a query to find possible matches only against sanctions and terrorists lists.
You can query by multiple pieces of information (aka. pois), such as name.full or id.national.
URI Parameters
- account: required(string)
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
Media type: application/form-data
Type: object
Properties- threshold: (number - default: 0.9)
Mininum similarity threshold to be considered as a valid match.
- pois: required(string)
Points of information describing the search (JSON encoded)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"matches": [
{
"uuid": "6bb32da7-1c30-4909-87bc-fd9f98bcdde4",
"info": [
{
"uuid": "5b161766-b5da-4c15-a384-20e7349829b2",
"type": "person",
"content": "P",
"sois": [
{
"description": null,
"uri": "account:76532451-4b5c-434c-a205-4a307026ded9",
"reliability": 0.5,
},
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "11929d61-b4c4-4078-8a11-5cbd12956c44",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "89dabe55-021e-4eec-aefe-8130548d3751",
"type": "function.public",
"content": {
"charge": "Diputado",
"organization": "Congreso de España",
"from": "1977-07-02",
"to": "1979-01-02"
},
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "f7f6288d-2695-44eb-9b01-21d1d6291f12",
"type": "name.full",
"content": "felipe gonzález márquez",
"sois": [
{
"description": null,
"uri": "account:76532451-4b5c-434c-a205-4a307026ded9",
"reliability": 0.5,
},
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "30de7dcf-aa67-496c-bcc4-42976c2e014c",
"type": "photo",
"content": {
"url": "http://api.pibisi.local/docs/0b1715d2f8e96a91_1570465919.jpg"
},
"sois": [
{
"description": "Página web oficial del Congreso de los Diputados",
"uri": "http://www.congreso.es/portal/page/portal/Congreso/Congreso/Diputados/BusqForm?_piref73_1333155_73_1333154_1333154.next_page=/wc/fichaDiputado?idDiputado=175&idLegislatura=0",
"reliability": 1,
}
]
},
{
"uuid": "8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c",
"type": "media",
"content": {
"types": [
"NEWS"
],
"issuer": "Libertad Digital",
"from": "2014-07-04",
"url": "http://www.libertaddigital.com/espana/2014-07-04/anticorrupcion-pide-imputar-al-sobrino-de-felipe-gonzalez-en-el-caso-invercaria-1276523046/"
},
"sois": [
{
"description": "Found adverse media using Search Engines",
"uri": "http://www.libertaddigital.com/espana/2014-07-04/anticorrupcion-pide-imputar-al-sobrino-de-felipe-gonzalez-en-el-caso-invercaria-1276523046/",
"reliability": 0.5,
}
]
}
],
"similarity": 0.9916,
"scoring": {
"value": 0,
"flags": {
"value": 0,
"is_pep": false,
"was_pep": true,
"was_pep_date": "1979-01-02T23:59:59+00:00",
"is_sanctioned": false,
"was_sanctioned": false,
"was_sanctioned_date": null,
"is_terrorist": false,
"has_media": true,
"has_adverse_info": false,
"is_high_risk": false
},
"info": {
"pep": [
"89dabe55-021e-4eec-aefe-8130548d3751"
],
"sanctioned": [],
"terrorist": [],
"media": [
"8f58c5a4-9c52-47f8-b540-25a3ce7e1a6c"
],
"adverse_info": [],
"high_risk": []
}
}
},
],
"search_result": {
"uuid": "498aa292-f8b9-9bc9-9b97-a4b5fae1f024",
"performed_at": "2021-03-13T09:36:30+00:00",
"status": "processed",
"pois": [
{
"type": "name.full",
"content": "felipe gonzalez"
}
],
"matches": [...]
}
},
"meta": {
"count": 1,
"query": {
"pois": [
{
"type": "person",
"content": "P"
},
{
"type": "name.full",
"content": "Felipe González Márquez"
}
]
},
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
get
Returns all information (visible for the given company account) of a generic subject
get /accounts/{account}/subjects/{subject}
Returns all information (visible for the given company account) of a generic subject
URI Parameters
- account: required(string)
- subject: required(string)
Subject's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"info": [
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.full",
"content": "Sandor Clegane",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "name.alias",
"content": "The Hound",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
},
{
"uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
"type": "gender",
"content": "M",
"sois": [
{
"description": "Sandor Clegane - Wikipedia",
"uri": "https://en.wikipedia.org/wiki/Sandor_Clegane",
"reliability": 1
}
],
}
]
"scoring": {
"value": 10,
"flags": {
"is_pep": false,
"was_pep": true,
"was_pep_date": '2020-01-01',
"is_sanctioned": true,
"was_sanctioned": false,
"was_sanctioned_date": '',
"is_terrorist": false,
}
"info": {
"pep": []
"sanctioned": ["0a31f1d5-f94f-459b-9021-f78b68f1633c"]
"terrorist": []
}
}
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
get
Returns a PDF document describing a report for a given subject
get /accounts/{account}/subjects/{subject}/report
Returns a PDF document describing a report for a given subject
URI Parameters
- account: required(string)
- subject: required(string)
Subject's UUID identifier
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
/users
get
get /users/me
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": {
"email": "email@pibisi.com",
"name": "User Pibisi"
},
"meta": {
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}
get
Returns information about all your related company accounts
get /users/me/accounts
Returns information about all your related company accounts
Headers
- X-AUTH-TOKEN: required(string)
Valid JWT API token
Example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"data": [
{
"role": "owner",
"account": {
"uuid": "76532451-4b5c-434c-a205-4a307026ded9",
"config": {
"behaviour_analytics": {
"constraints": [
{
"name": "max_cash_in_amount",
"config": 45.5
},
{
"name": "max_cash_in_rate",
"config": {
"window": 2,
"value": 21.06
}
}
]
},
"person_analytics": {
"rates": 1
}
}
}
},
{
"role": "owner",
"account": {
"uuid": "b6c8c327-e4d5-4b09-9e68-fff76c785a72",
"config": {
"behaviour_analytics": {
"constraints": [
{
"name": "max_cash_in_amount",
"config": 45.5
},
{
"name": "max_cash_in_rate",
"config": {
"window": 2,
"value": 21.06
}
}
]
},
"person_analytics": []
}
}
}
],
"meta": {
"count": 2
"version": "v2",
"time": "2021-09-20T17:26:06+00:00"
}
}