We propose multiples services through our Platform and API. Below are the main endpoints:
| # | Service category | Service | Endpoint | Method | Description | Usage |
|---|---|---|---|---|---|---|
| Verify | ||||||
| 1 | Verify | Option 1: VoP + Fraudulent IBAN | vop/v1/verify |
POST |
Verification: beneficiary (IBAN + Name) | API and/or Platform |
| 2 | Verify | Option 2: Fraudulent IBAN | sharing/v1/verify |
POST |
Verification: check if IBAN is listed in the FNC-RF | API and/or Platform |
| Report | ||||||
| 3 | Report | Create a report | sharing/v1/report |
POST |
Create a “suspicious account” alert | API and/or Platform |
| 4 | Report | Delete a report | sharing/v1/report/{id} |
DELETE |
Request deletion of an alert (error case) | API and/or Platform |
| 5 | Report | Update a report | /sharing/v1/report/{reportId} |
POST |
Update the fraud context of an existing report. | API and/or Platform |
| Respond | ||||||
| 6 | Respond | Account holder PSP qualification | sharing/v1/report/{id}/holder-qualification |
POST |
Respond to an alert for an internal account | API and/or Platform |
| 7 | Respond | Participant qualification | /sharing/v1/report/{reportId}/holder-qualification |
POST |
Respond to an alert for an external account | API and/or Platform |
| Get notified | ||||||
| 8 | Get notified | Risk detected: previously verified IBAN | Defined by the client | Receive notification for an external account | Webhook / Slack / Email | |
| 9 | Get notified | Risk detected: internal IBAN | Defined by the client | Receive notification for an internal account | Webhook / Slack / Email | |
| Extract | ||||||
| 10 | Extract | Retrieve FNC-RF dataset | /sharing/v1/alerts/export |
GET |
Extract the Banque de France FNC-RF dataset | API or Manual (CSV) |
| 11 | Extract | Retrieve verified accounts | /vop/v1/logs/request/search |
POST |
Extract previously verified accounts | API |
| 12 | Extract | Retrieve sent alerts | /sharing/v1/alerts/sent/search |
POST |
Extract sent alerts | API |
| 13 | Extract | Retrieve received alerts | /sharing/v1/alerts/received/search |
POST |
Extract received alerts | API |
| 14 | Extract | Retrieve alert details | /sharing/v1/alerts/{alertId} |
GET |
Get alert details | API |
| Import | ||||||
| 15 | Import | Add IBANs to internal whitelist | /sharing/v1/whitelist |
POST |
Add legitimate internal IBANs | API and/or Platform |
| 16 | Import | Add IBANs to internal blacklist | /sharing/v1/blacklist |
POST |
Add fraudulent internal IBANs | API and/or Platform |
| 17 | Import | Retrieve internal blacklist | /sharing/v1/whitelist |
GET |
Get the whole blacklist | API and/or Platform |
| 18 | Import | Retrieve internal blacklist | /sharing/v1/blacklist |
GET |
Get the whole whitelist | API and/or Platform |
| 19 | Import | Remove IBANs from whitelist | /sharing/v1/whitelist |
DELETE |
Delete a list of IBANs from whitelist | API and/or Platform |
| 20 | Import | Remove IBANs from blacklist | /sharing/v1/blacklist |
DELETE |
Delete a list of IBANs from blacklist | API and/or Platform |