Pibisi API documentation version v1

https://api.pibisi.com/{version}

  • version: required(v1)

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 main workflows are very easy.

MONITORING PERSONS

  1. Add a new customer to be managed by Pibisi using the endpoint [POST]/accounts/{account}/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]]/accounts/{account}/customers/{customer} to get updated information about any of your customers.

QUERYING PERSONS

  1. Make a new query using the endpoint [POST]/accounts/{account}/subjects/find and expect in the response an list of possible matches ordered by similarity for the given input.
  2. You can ask for full information about every single match using their unique identifier (UUID) with [GET]/accounts/{account}/subjects/{subject}
  3. If the search did not return any matches, or none of them is a valid match, you can ask for a negative report using the endpoint [POST]/accounts/{account}/subjects/negative-report.

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

Data types

In the following sections you can find a detailed explanation of the main datat types.

POI (Piece Of Information)

Object properties:

  • type (string). Type of information.
  • content (object). The actual piece of information. Depending on the type the content object will allow/require some specific fields.

Main POI types and content fields:

  • person (string). Type of person. One of the following:
    • P (natural person)
    • E (legal person)

  • name.full (string). Full name, including first name, second name and surname.

  • nationality (string ISO 3166-1 alfa-3). Nationality.

  • gender (char). One of the following:
    • M (male)
    • F (female)
  • birth.date (string YYYY-MM-DD). Birth date.
  • birth.place (object). Birth place. Fields:
    • city (string). (Opt.) City
    • country (string ISO 3166-1 alfa-3). (Opt.) Country.
  • id.passport (object). Passport ID. Fields:
    • country (string ISO 3166-1 alfa-3). Country issuing the document number.
    • number (string). Passport ID number.
  • id.national (object). National id. Fields:
    • country (string ISO 3166-1 alfa-3). Country issuing the document number.
    • number ((string)). Document number.
  • function.public (object). Public charge. Fields:
    • charge (string). Denomination of the public charge.
    • organization (string). Organization holding the public charge.
    • scope (string). Scope (Tipically the jurisdiction) of the public charge.
    • country (string ISO 3166-1 alfa-3). Country.
    • from (string YYYY-MM-DD). Date accessing the public charge.
    • to (string YYYY-MM-DD). Date releasing the public charge.
  • sanction (object). International sanction. Fields:
    • types (set of strings). Sanction types. Can be several of:
      • ARE (Arms embargo),
      • FOA (Assets freeze),
      • TRB (Travel ban),
      • IBC (Ineligible to become a Bank Counterparty),
      • EPD (Export privileges denial),
      • EAR (Export administrations regulation),
      • FMT (Forbid military assets trade),
      • FFT (Forbid financial assets trade),
      • FDT (Forbid dual use assets trade),
      • FPT (Forbid prospecting assets trade).
    • reason (text). Reason for getting sanctioned.
    • issuer (string). Institution issuing the sanction.
    • scope (string). Scope (Tipically the jurisdiction) of the public charge.
    • country (string ISO 3166-1 alfa-3). Country.
    • from (string YYYY-MM-DD). Date when the sanction started.
    • to (string YYYY-MM-DD). Date when the sanction finished.
  • media (object). Adverse media. Fields:
    • action (string). One of the following:
      • Absolved
      • Arrested
      • Blacklisted
      • Convicted
      • Investigated
      • Indicted
      • Released
      • Wanted
    • issue (string). Charges or topics. Can be several of the following:
      • Corruption
      • Fiscal fraud
      • Fraud
      • Money laundering
      • Narcotraffic
      • Terrorism
    • issuer (string). Institution issuing the adverse information.
    • from (string YYYY-MM-DD). Publishing date.
    • url (string). Public url to the media content.

Endpoints

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

/accounts/{account}

post

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.

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: (json)

    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:

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

/accounts/{account}/alerts

get

get

Returns all pending alerts

Returns all pending alerts

URI Parameters

  • account: required(string)

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:

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

get

get

Returns all information about one alert

Returns all information about one alert

URI Parameters

  • account: required(string)
  • 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:

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

post

post

Accepts and finishes the alert

Accepts and finishes the alert

URI Parameters

  • account: required(string)
  • 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:

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

post

post

Puts the alert on-hold to handle it later

Puts the alert on-hold to handle it later

URI Parameters

  • account: required(string)
  • 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:

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

post

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.

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)
  • alert: required(string)

    Alert's UUID identifier

Headers

  • X-AUTH-TOKEN: required(string)

    Valid JWT API token

    Example:

    eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

/accounts/{account}/customers

get post

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

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

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

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)

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

post

post

Uploads a CSV file with new customers to be registered.

You can upload one single file each time, in CSV format and including the following fields separated by a semi colon (';'):

  • Type: (P) Natural person / (E) Legal person,
  • Full name,
  • National Identity Number (DNI, NIF),
  • Country issuing the document: coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,
  • Nationality: coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,
  • Birth date, formatted as AAAA-MM-DD
  • Passport (OPTIONAL if national id already provided),
  • Country issuing the passport (OPTIONAL if national id provided): coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,

Uploads a CSV file with new customers to be registered.

You can upload one single file each time, in CSV format and including the following fields separated by a semi colon (';'):

  • Type: (P) Natural person / (E) Legal person,
  • Full name,
  • National Identity Number (DNI, NIF),
  • Country issuing the document: coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,
  • Nationality: coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,
  • Birth date, formatted as AAAA-MM-DD
  • Passport (OPTIONAL if national id already provided),
  • Country issuing the passport (OPTIONAL if national id provided): coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,

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
  • file: required(file)

    CSV file to be added

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "result": "ok"
}

get

get

Returns all information (visible for the given company account) of a 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:

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

get

get

Returns all alerts related to a given customer

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:

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

post

post

Sets a new risk value

You can change the risk and add a comment. As response you will get the whole customer object.

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: any

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

get

get

Returns all uploaded documents related to a given customer

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:

[
  {
    "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/..."
  }
]

get

get

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

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

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:

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

get

get

Returns all notes related to a given customer

Returns all notes 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:

[
  {
    "customer_uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "comment": "Hemos solicitado más información de origen de fondos",
    "registered_at": "2018-08-28T05:36:11+00:00",
    "deleted_at": ""
  },
  {
    "customer_uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "comment": "Recibió una herencia por valor de 10 millones de euros",
    "registered_at": "2018-08-28T05:36:11+00:00",
    "deleted_at": ""
  }
]

post

post

Removes a customer

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

Removes a customer

You normally remove a customer when he/she is no longer your 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:

{
  "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
  "status": "inactive"
}

post

post

Notifies a wrong match on a given person.

This endpoint sends a request to split two different persons that were automatically merged by the algorithm. This normally happens when a customer and a person of risk have very similar names.

Notifies a wrong match on a given person.

This endpoint sends a request to split two different persons that were automatically merged by the algorithm. This normally happens when a customer and a person of risk have very similar names.

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",
  "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": []
    }
  }
}

/accounts/{account}/invoices

get

get

Returns all invoices for the given account

Returns all invoices for the given account

URI Parameters

  • account: required(string)

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:

[
  {
    "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "number": "2020-15-03",
    "status": "pending",
    "date_from": "2020-01-01",
    "date_to": "2020-01-31",
    "total": "1.000,34",
    "amount": "1.000,34",
    "vat": "121,21",
    "document":
      {
        "created_at": "2018-08-28T05:36:11+00:00",
        "name": "Factura",
        "original_name": "Factura Pibisi enero 2020.pdf",
        "type": "invoice",
        "url":"https://pibisi.com/es/docs/..."
      },
  },
  {
    "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "number": "2020-15-04",
    "status": "paid",
    "date_from": "2020-01-01",
    "date_to": "2020-01-31",
    "total": "1.000,34",
    "amount": "1.000,34",
    "vat": "121,21",
    "document":
      {
        "created_at": "2018-08-28T05:36:11+00:00",
        "name": "Factura",
        "original_name": "Factura Pibisi enero 2020.pdf",
        "type": "invoice",
        "url":"https://pibisi.com/es/docs/..."
      },
  },
]

get

get

Returns the PDF for the given invoice

Returns the PDF for the given invoice

URI Parameters

  • account: required(string)
  • invoice: required(string)

Headers

  • X-AUTH-TOKEN: required(string)

    Valid JWT API token

    Example:

    eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

HTTP status code 200

Body

Media type: application/pdf

Type: any

Example:

{}

/accounts/{account}/subjects

post

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.

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.75)

    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:

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

get

get

Returns a PDF document describing a negative report (in case no results are found) for a given query of a generic subject

Returns a PDF document describing a negative report (in case no results are found) for a given query of a generic subject

URI Parameters

  • account: required(string)

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

HTTP status code 200

Body

Media type: application/pdf

Type: any

Example:

{}

get

get

Returns all information (visible for the given company account) of a generic 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:

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

get

get

Returns a PDF document describing a report for a given subject

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

HTTP status code 200

Body

Media type: application/pdf

Type: any

Example:

{}

/accounts/{account}/wallets

post

post

Uploads a CSV file with new operations to be registered.

You can upload one single file each time, in CSV format, including the following fields separated by a semi colon (';'):

  • Customer Wallet Identifier,
  • Transaction Identifier: It must be unique,
  • Date of transaction, with format YYYY-MM-DDTH:mm:SS+00:00,
  • Type of transaction. Any of: 'cash.incoming', 'cash.outgoing', 'transfer.incoming', 'transfer.outgoing', 'self.incoming', 'self.outgoing'
  • Amount of transaction: in absolute value, without thousand separator and with the dot ('.') as decimal separator,
  • Currency of transaction according to the norm ISO 4217,
  • Linked wallet identifier, if any. If not, leave empty.
  • Linked wallet IBAN, if any. If not, leave empty.

Uploads a CSV file with new operations to be registered.

You can upload one single file each time, in CSV format, including the following fields separated by a semi colon (';'):

  • Customer Wallet Identifier,
  • Transaction Identifier: It must be unique,
  • Date of transaction, with format YYYY-MM-DDTH:mm:SS+00:00,
  • Type of transaction. Any of: 'cash.incoming', 'cash.outgoing', 'transfer.incoming', 'transfer.outgoing', 'self.incoming', 'self.outgoing'
  • Amount of transaction: in absolute value, without thousand separator and with the dot ('.') as decimal separator,
  • Currency of transaction according to the norm ISO 4217,
  • Linked wallet identifier, if any. If not, leave empty.
  • Linked wallet IBAN, if any. If not, leave empty.

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
  • file: required(file)

    CSV file to be processed

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "result": "ok"
}

get

get

Returns all information of the given wallet

Returns all information of the given wallet

URI Parameters

  • account: required(string)
  • wallet: required(string)

    Wallet'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:

{
  "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
  "status": "active",
  "risk": "low",
  "created_at": "2019-06-03T17:29:23+00:00",
  "external_id": "",
  "iban": "ES12345678123456781234",
  "last_position_at": "2020-08-21",
}

get

get

Returns all alerts related to a given wallet

Returns all alerts related to a given wallet

URI Parameters

  • account: required(string)
  • wallet: required(string)

    Wallet'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:

[
  {
    "uuid": "0a31f1d5-f94f-459b-9021-f78b68f1633c",
    "wallet_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
    "type": "max_xfer_in_amount",
    "comment": "Comment",
    "registered_at": "2019-01-12T12:34:56+00:00",
    "status": "pending",
    "processed_at": ""
  },
  {
    "uuid": "459bf1d5-f94f-0a31-9021-f78b68f1633c",
    "wallet_uuid": "f94ff1d5-0a31-459b-9021-f78b68f1633c",
    "type": "max_cash_in_rate",
    "comment": "Comment",
    "registered_at": "2019-01-12T12:34:56+00:00",
    "status": "accepted",
    "processed_at": "2019-01-12T13:34:56+00:00"
  }
]

post

post

Sets a new risk value

You can change the risk and add a comment. As response you will get the whole wallet object.

Sets a new risk value

You can change the risk and add a comment. As response you will get the whole wallet object.

URI Parameters

  • account: required(string)
  • wallet: required(string)

    Wallet'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",
  "risk": "low",
  "created_at": "2019-06-03T17:29:23+00:00",
  "external_id": "",
  "iban": "ES12345678123456781234",
  "last_position_at": "2020-08-21",
}

/users

get

get

get

get

Returns information about all your related company accounts