NAV navbar
logo

Pibisi Documentation

version v1
baseUri https://api.pibisi.com/{version}
protocols HTTPS

Introduction

This document describes the elegant, easy-to-use REST API to communicate with Pibisi.

How to use it

First of all you will need to have a valid credential i.e. a JWT, which you can request at integrations@pibisi.com

Once you have a valid credential the workflow is very easy:

  1. Add a new customer to be managed by Pibisi using the endpoint [POST]/customers and expect in the response a unique identifier (uuid) for this customer.
  2. Repeat the step 1 with every customer in your database.
  3. Provide the cool team of Pibisi with your custom endpoint which we should call back when a new relevant piece of information is gathered about any of your customers managed by Pibisi.
  4. Call alternatively the endpoint [GET]]/persons/{uuid} to get updated information about any of your customers.

And that's it, you are now fully integrated with Pibisi!

Endpoints

In the following sections you can find a detailed explanation of all endpoints. Enjoy!

/users


/me get

GET: /users/me


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/me get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/users/me" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

{
  "email": "email@pibisi.com",
  "name": "User Pibisi"
}
Type
object


/account get

GET: /users/me/account

Returns information about your company account


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/account get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/users/me/account" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

{
  "type": "Account type",
}
Type
object


/customers get

GET: /users/me/persons

Lists all added persons for the current company account


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/persons get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/users/me/persons" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

[
  {
    "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "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",
    "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
          }
        ],
      }
    ]
  }
]
Type
object

/customers


/persons post

POST: /persons

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


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/persons post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/persons" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
	-d @request_body

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

REQUEST BODY

[
  {
    "type": "person",
    "content": "P"
  },
  {
    "type": "name.full",
    "content": "Sandor Clegane"
  },
  {
    "type": "id.national",
    "content": {
      "number": "12345678A",
      "country":"ESP",
    }
  },
  {
    "type": "birth.date",
    "content": {
      "date": "1991-12-25",
    }
  }
]
Type
object

RESPONSE BODY

{
  "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
  "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": []
    }
  }
}
Type
object


/{uuid} get

GET: /customers/{uuid}

Returns all information (visible for the current company account) of a person


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid} get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/persons/{uuid}" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

{
  "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": {
      "is_pep": false,
      "is_sanctioned": true,
      "value": 10
      "info": {
        "pep": []
        "sanctioned": ["0a31f1d5-f94f-459b-9021-f78b68f1633c"]
      }
  }
}
Type
object


/{uuid}/remove post

POST: /customers/{uuid}/remove

Removes a person

You normally remove a person when he/she is no longer your customer.


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid}/remove post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/persons/{uuid}/remove" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
	-d @request_body

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

REQUEST BODY

[]
Type
object

RESPONSE BODY

{
  "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
  "status": "removed"
}
Type
object


/{uuid}/split post

POST: /customers/{uuid}/split

Splits a person's pieces of information based on the source of the information

This endpoint allows to separate two persons that were merged by mistake by the matching algorithm.


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid}/split post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/persons/{uuid}/split" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
	-d @request_body

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

REQUEST BODY

[]
Type
object

RESPONSE BODY

{
  "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
  "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": []
    }
  }
}
Type
object


/events get

GET: /customers/events

Returns all events (visible for the current account) related to a person


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/events get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/persons/events" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

[
  {
    "event": "data.subject_updated",
    "registered_at": "2018-08-28 05:36:11"
  },
  {
    "event": "data.subject_updated",
    "registered_at": "2018-09-01 09:56:23"
  }
]
Type
object

/alerts


/alerts get

GET: /alerts

Returns all pending alerts


Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/alerts get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/alerts" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

[
  {
    "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": ""
  }
]
Type
object


/{uuid} get

GET: /alerts/{uuid}

Returns all information about one alert


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid} get

CURL EXAMPLE

curl -X GET "https://api.pibisi.com/{version}/alerts/{uuid}" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

RESPONSE BODY

{
  "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": ""
}
Type
object


/{uuid}/accept post

POST: /alerts/{uuid}/accept

Accepts and finishes the alert


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid}/accept post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/alerts/{uuid}/accept" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
	-d @request_body

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

REQUEST BODY

[]
Type
object

RESPONSE BODY

{
  "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"
}
Type
object


/{uuid}/ignore post

POST: /alerts/{uuid}/ignore

Ignores and finishes the alert


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

Header Parameters

X-AUTH-TOKEN
Valid JWT APP token

PropertyValue
requiredtrue
typestring
exampleseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Possible Responses

200


/{uuid}/ignore post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/alerts/{uuid}/ignore" \
	-H "X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
	-d @request_body

REQUEST HEADERS

X-AUTH-TOKEN: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

REQUEST BODY

[]
Type
object

RESPONSE BODY

{
  "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"
}
Type
object


/{uuid}/reject post

POST: /alerts/{uuid}/reject


URI Parameters

uuid

PropertyValue
requiredtrue
typestring

/{uuid}/reject post

CURL EXAMPLE

curl -X POST "https://api.pibisi.com/{version}/alerts/{uuid}/reject" \
	-d @request_body