404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
The following FIB API endpoints are available for implementation into the code of your own application or system:
auth-controllerwallet-controllerpeer-controllercontribution-controllerpremium-provider-controllerProtocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/authentication-management/session
Method: PATCH
Header: Authorization is represented by a string that is the refreshToken value that was returned either at the authorization, or the previous time the token has been refreshed.
Parameters: —
Input/request structure:
A PATCH request to the endpoint, where the Authorization header is required.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}| Response Code | Description |
|---|---|
200 | Authentication tokens have been refreshed successfully. |
401 | Either the signature or refresh token are not valid, or the Bearer token could not be parsed from the Authorization header. |
404 | User not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/authentication-management/salt
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Deterministic salt persisted on the blockchain has been retrieved successfully. |
404 | User not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-manager/contribution/flag/assemble
Method: PATCH
Parameters: —
Input/request structure:
{
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+}{
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+}Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Contribution flag has been assembled and its transaction data has been retrieved successfully. |
400 | The request body of the contribution flag is incorrect or premium contribution can't be changed. |
404 | Asset not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/assemble
Method: POST
Parameters: —
Input/request structure:
[
+ {
+ id: 'string', //fraud identifier value
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ destination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ expiryDate: 0 //integer($int32), Unix Epoch Time in seconds
+ }
+][
+ {
+ id: 'string', //fraud identifier value
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ destination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ expiryDate: 0 //integer($int32), Unix Epoch Time in seconds
+ }
+]Note
This endpoint accepts requests with up to 500 entries.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Contribution has been assembled and its transaction data has been retrieved successfully. |
400 | Contribution type is invalid. |
404 | Account not found or the rewards table doesn't exist. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/flag
Method: PATCH
Parameters: —
Input/request structure:
'string''string'Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ rewarded: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ rewarded: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
200 | Contribution has been flagged and its transaction data has been retrieved successfully. |
400 | Invalid transaction. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/{contributionID}
Method: GET
Parameters:
| Field | Value Type | Description |
|---|---|---|
contributionID | string(path) | Range of id values (Fraud Identifiers), or a single one. |
Input/request structure:
A GET request to the endpoint, where {contributionID} is a required parameter.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Contribution has been successfully retrieved by its ID. |
400 | Contribution ID is incorrect or the fraud type could not be resolved by code. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: GET
Parameters:
| Field | Value Type | Description |
|---|---|---|
size | integer($int32) | The number of entries, starting with the latest, shown in the response. Set to 50 by default. |
from and to | string | The timeframe that the response entries are filtered by (set as Unix Epoch time in seconds). The from parameter is set to 0 by default. |
ft | array[string] | The type of the fraud event. Could be one of the following:
|
org | array[string] | The country of origination of the fraud event. Set as a two-digit country code (Alpha-2, ISO 3166; e.g., US, GA) |
self-only | boolean | A boolean that defines whether the response should only contain contributions submitted by the requesting peer. The self-only parameter is set to false by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
DEFAULT — includes all of the entries.The fetch-mode parameter is set to DEFAULT by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
The fetch-mode parameter is set to DEFAULT by default. |
confidence-score | boolean | A boolean that defines whether the price of the retrieved contributions is affected by the confidence index. If set to true, the price of any given contribution is expected to rise above the default conversion rate. The confidence-score parameter is set to false by default. |
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ contributions: [
+ {
+ id: 'string',
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string',
+ destination: 'string',
+ expiryDate: 0, //integer($int32)
+ fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
+ confidenceIndex: 0, //number($double)
+ isPremium: true, //boolean
+ peerId: 'string',
+ flagger: 'string',
+ premium: true //boolean
+ }
+ ],
+ details: {
+ self: 0,
+ old: 0,
+ new: 0,
+ creditsSpent: 0
+ }
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ contributions: [
+ {
+ id: 'string',
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string',
+ destination: 'string',
+ expiryDate: 0, //integer($int32)
+ fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
+ confidenceIndex: 0, //number($double)
+ isPremium: true, //boolean
+ peerId: 'string',
+ flagger: 'string',
+ premium: true //boolean
+ }
+ ],
+ details: {
+ self: 0,
+ old: 0,
+ new: 0,
+ creditsSpent: 0
+ }
+ }
+}| Response Code | Description |
|---|---|
200 | Contributions have been successfully retrieved and filtered by the specified parameters. |
400 | Request parameters are invalid or the fraud type could not be resolved by code. |
404 | Contribution subscription has not been found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: POST
Parameters: —
Input/request structure:
'string''string'Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ],
+ rewarded: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ],
+ rewarded: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
| 200 | Contribution has been submitted and its transaction data has been retrieved successfully. |
| 400 | Invalid transaction. |
| 500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/peer-management/details
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accountId: 'string',
+ domainId: 'string',
+ accountMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ },
+ domainMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ }
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accountId: 'string',
+ domainId: 'string',
+ accountMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ },
+ domainMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ }
+ }
+}| Response Code | Description |
|---|---|
200 | Peer details have been retrieved successfully. |
404 | User/domain/account/asset not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/peer-management/premium
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ peerId: 'string' //A unique identifier of a peer
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ peerId: 'string' //A unique identifier of a peer
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | All premium peers have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/peer-management/limit
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0,
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ used: 0,
+ total: 0,
+ updatePeriod: 0,
+ nextUpdate: 0
+ }
+}{
+ status: {
+ code: 0,
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ used: 0,
+ total: 0,
+ updatePeriod: 0,
+ nextUpdate: 0
+ }
+}| Response Code | Description |
|---|---|
200 | Peer limit status has been retrieved successfully |
404 | Metadata key not found or Trigger's period not specified |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/application?peer={peerID}
Method: POST
Parameters:
| Field | Value Type | Description |
|---|---|---|
peer | string | A unique peer identifier. peer is a required parameter. See Retrieving all premium peer. |
Input/request structure:
A POST request to the endpoint, where peer is a unique peer identifier.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'PENDING' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'PENDING' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Access to premium contributions by a certain peer has been requested. |
400 | The Entity field is not set. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/incoming
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Incoming premium contribution requests have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/outgoing
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Outgoing premium contribution requests have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/wallet-management/balance
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenId: {
+ definitionId: 'credit#admin',
+ accountId: 'user@peerId'
+ },
+ balance: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenId: {
+ definitionId: 'credit#admin',
+ accountId: 'user@peerId'
+ },
+ balance: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
200 | Credit balance has been retrieved successfully. |
500 | Internal server error. |
The following FIB API endpoints are available for implementation into the code of your own application or system:
auth-controllerwallet-controllerpeer-controllercontribution-controllerpremium-provider-controllerProtocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/authentication-management/session
Method: POST
Parameters: —
Input/request structure:
{
+ email: 'string', //The user’s email address
+ signature: 'string', //The encoded signature of a user’s email address
+ publicKey: 'string' //The public key of the authentication key pair
+}{
+ email: 'string', //The user’s email address
+ signature: 'string', //The encoded signature of a user’s email address
+ publicKey: 'string' //The public key of the authentication key pair
+}Note
For instructions on how to generate signature and publicKey strings, see Generating key pairs and Signing user email addresses.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}| Response Code | Description |
|---|---|
200 | User authorization has been successful. |
401 | User signature is incorrect or failed to be decoded. |
404 | User not found. |
422 | User signature either could not be decoded or verified, or the publicKey string is not valid. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/authentication-management/session
Method: PATCH
Header: Authorization is represented by a string that is the refreshToken value that was returned either at the authorization, or the previous time the token has been refreshed.
Parameters: —
Input/request structure:
A PATCH request to the endpoint, where the Authorization header is required.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accessToken: 'string',
+ refreshToken: 'string',
+ expirationTime: 0 //integer($int64)
+ }
+}| Response Code | Description |
|---|---|
200 | Authentication tokens have been refreshed successfully. |
401 | Either the signature or refresh token are not valid, or the Bearer token could not be parsed from the Authorization header. |
404 | User not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/authentication-management/salt
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Deterministic salt persisted on the blockchain has been retrieved successfully. |
404 | User not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-manager/contribution/flag/assemble
Method: PATCH
Parameters: —
Input/request structure:
{
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+}{
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+}Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Contribution flag has been assembled and its transaction data has been retrieved successfully. |
400 | The request body of the contribution flag is incorrect or premium contribution can't be changed. |
404 | Asset not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/assemble
Method: POST
Parameters: —
Input/request structure:
[
+ {
+ id: 'string', //fraud identifier value
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ destination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ expiryDate: 0 //integer($int32), Unix Epoch Time in seconds
+ }
+][
+ {
+ id: 'string', //fraud identifier value
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ destination: 'string', //two-digit country code (Alpha-2, ISO 3166)
+ expiryDate: 0 //integer($int32), Unix Epoch Time in seconds
+ }
+]Note
This endpoint accepts requests with up to 500 entries.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: 'string'
+}| Response Code | Description |
|---|---|
200 | Contribution has been assembled and its transaction data has been retrieved successfully. |
400 | Contribution type is invalid. |
404 | Account not found or the rewards table doesn't exist. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/flag
Method: PATCH
Parameters: —
Input/request structure:
'string''string'Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ rewarded: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ rewarded: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
200 | Contribution has been flagged and its transaction data has been retrieved successfully. |
400 | Invalid transaction. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution/{contributionID}
Method: GET
Parameters:
| Field | Value Type | Description |
|---|---|---|
contributionID | string(path) | Range of id values (Fraud Identifiers), or a single one. |
Input/request structure:
A GET request to the endpoint, where {contributionID} is a required parameter.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ assetIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ]
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Contribution has been successfully retrieved by its ID. |
400 | Contribution ID is incorrect or the fraud type could not be resolved by code. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: GET
Parameters:
| Field | Value Type | Description |
|---|---|---|
size | integer($int32) | The number of entries, starting with the latest, shown in the response. Set to 50 by default. |
from and to | string | The timeframe that the response entries are filtered by (set as Unix Epoch time in seconds). The from parameter is set to 0 by default. |
ft | array[string] | The type of the fraud event. Could be one of the following:
|
org | array[string] | The country of origination of the fraud event. Set as a two-digit country code (Alpha-2, ISO 3166; e.g., US, GA) |
self-only | boolean | A boolean that defines whether the response should only contain contributions submitted by the requesting peer. The self-only parameter is set to false by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
DEFAULT — includes all of the entries.The fetch-mode parameter is set to DEFAULT by default. |
fetch-mode | string | The parameter that filters the response entries based on whether the requesting user has already seen them. Could be one of the following:
The fetch-mode parameter is set to DEFAULT by default. |
confidence-score | boolean | A boolean that defines whether the price of the retrieved contributions is affected by the confidence index. If set to true, the price of any given contribution is expected to rise above the default conversion rate. The confidence-score parameter is set to false by default. |
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ contributions: [
+ {
+ id: 'string',
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string',
+ destination: 'string',
+ expiryDate: 0, //integer($int32)
+ fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
+ confidenceIndex: 0, //number($double)
+ isPremium: true, //boolean
+ peerId: 'string',
+ flagger: 'string',
+ premium: true //boolean
+ }
+ ],
+ details: {
+ self: 0,
+ old: 0,
+ new: 0,
+ creditsSpent: 0
+ }
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ contributions: [
+ {
+ id: 'string',
+ fraudType: 'string(enum)', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
+ origination: 'string',
+ destination: 'string',
+ expiryDate: 0, //integer($int32)
+ fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
+ confidenceIndex: 0, //number($double)
+ isPremium: true, //boolean
+ peerId: 'string',
+ flagger: 'string',
+ premium: true //boolean
+ }
+ ],
+ details: {
+ self: 0,
+ old: 0,
+ new: 0,
+ creditsSpent: 0
+ }
+ }
+}| Response Code | Description |
|---|---|
200 | Contributions have been successfully retrieved and filtered by the specified parameters. |
400 | Request parameters are invalid or the fraud type could not be resolved by code. |
404 | Contribution subscription has not been found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/contribution-management/contribution
Method: POST
Parameters: —
Input/request structure:
'string''string'Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ],
+ rewarded: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenIds: [
+ {
+ definitionId: 'Id_range#domain', //IP/telephone number/IMEI
+ accountId: 'user@peerId'
+ }
+ ],
+ rewarded: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
| 200 | Contribution has been submitted and its transaction data has been retrieved successfully. |
| 400 | Invalid transaction. |
| 500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/peer-management/details
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accountId: 'string',
+ domainId: 'string',
+ accountMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ },
+ domainMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ }
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ accountId: 'string',
+ domainId: 'string',
+ accountMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ },
+ domainMetadata: {
+ additionalProp1: {},
+ additionalProp2: {},
+ additionalProp3: {}
+ }
+ }
+}| Response Code | Description |
|---|---|
200 | Peer details have been retrieved successfully. |
404 | User/domain/account/asset not found. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /auth/api/v1/peer-management/premium
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ peerId: 'string' //A unique identifier of a peer
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ peerId: 'string' //A unique identifier of a peer
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | All premium peers have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/peer-management/limit
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0,
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ used: 0,
+ total: 0,
+ updatePeriod: 0,
+ nextUpdate: 0
+ }
+}{
+ status: {
+ code: 0,
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ used: 0,
+ total: 0,
+ updatePeriod: 0,
+ nextUpdate: 0
+ }
+}| Response Code | Description |
|---|---|
200 | Peer limit status has been retrieved successfully |
404 | Metadata key not found or Trigger's period not specified |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/application?peer={peerID}
Method: POST
Parameters:
| Field | Value Type | Description |
|---|---|---|
peer | string | A unique peer identifier. peer is a required parameter. See Retrieving all premium peer. |
Input/request structure:
A POST request to the endpoint, where peer is a unique peer identifier.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'PENDING' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'PENDING' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Access to premium contributions by a certain peer has been requested. |
400 | The Entity field is not set. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/incoming
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Incoming premium contribution requests have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/premium-provider-management/outgoing
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: [
+ {
+ domainId: 'string',
+ requestedByPeer: 'string',
+ status: 'string(enum)' //Could be one of the following: PENDING, DECLINED, APPROVED, NONE
+ }
+ ]
+}| Response Code | Description |
|---|---|
200 | Outgoing premium contribution requests have been retrieved successfully. |
500 | Internal server error. |
Protocol: HTTP
Encoding: JSON
Endpoint: /data/api/v1/wallet-management/balance
Method: GET
Parameters: —
Input/request structure:
A GET request to the endpoint.
Output/response structure:
{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenId: {
+ definitionId: 'credit#admin',
+ accountId: 'user@peerId'
+ },
+ balance: 0 //integer($int32)
+ }
+}{
+ status: {
+ code: 0, //integer($int32)
+ name: 'string',
+ message: 'string'
+ },
+ data: {
+ tokenId: {
+ definitionId: 'credit#admin',
+ accountId: 'user@peerId'
+ },
+ balance: 0 //integer($int32)
+ }
+}| Response Code | Description |
|---|---|
200 | Credit balance has been retrieved successfully. |
500 | Internal server error. |
This section is designed to help you integrate the FIB API seamlessly into your application or system by providing instructions on how to register an account, check the API availability, call API endpoints, and test your implementation in a sandbox environment.
It is advised to read the following topics in the order that they are presented:
',4),s=[r];function o(l,d,c,g,h,p){return e(),a("div",null,s)}const u=t(n,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/getting-started.md.0f93915a.lean.js b/assets/getting-started.md.0f93915a.lean.js new file mode 100644 index 0000000..9cf7ee5 --- /dev/null +++ b/assets/getting-started.md.0f93915a.lean.js @@ -0,0 +1 @@ +import{_ as t,o as e,c as a,Q as i}from"./chunks/framework.c4d6cd72.js";const m=JSON.parse('{"title":"Getting started","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started.md","filePath":"getting-started.md"}'),n={name:"getting-started.md"},r=i("",4),s=[r];function o(l,d,c,g,h,p){return e(),a("div",null,s)}const u=t(n,[["render",o]]);export{m as __pageData,u as default}; diff --git a/assets/getting-started_calling-api-endpoints.md.14779e05.js b/assets/getting-started_calling-api-endpoints.md.14779e05.js new file mode 100644 index 0000000..de52cd6 --- /dev/null +++ b/assets/getting-started_calling-api-endpoints.md.14779e05.js @@ -0,0 +1 @@ +import{_ as e,o as t,c as i,Q as n}from"./chunks/framework.c4d6cd72.js";const m=JSON.parse('{"title":"Calling API endpoints","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/calling-api-endpoints.md","filePath":"getting-started/calling-api-endpoints.md"}'),a={name:"getting-started/calling-api-endpoints.md"},o=n('Once your registration application has been approved, the connection credentials are sent to the email address you provided during registration.
Using these credentials, you can implement calls to the FIB API endpoints into the code of your own application or system.
Following the basic API architecture, your application or system—the API client in this relationship—connects to the FIB API server.
To integrate your API client with the FIB API server, you can use different programming languages and frameworks, including Python, Java, Node.js, RUST, depending on the requirements of your own application or system.
Some tutorials in this documentation provide code snippets in Kotlin/Java that are required in order to perform Iroha-related operations.
The provided FIB API endpoints allow users to access the network's blockchain data, enabling users to perform operations such as submitting, retrieving and flagging contributions, etc.
For examples of scenarios where FIB API endpoints are being called, check out Tutorials.
',8),r=[o];function s(p,l,c,d,h,g){return t(),i("div",null,r)}const _=e(a,[["render",s]]);export{m as __pageData,_ as default}; diff --git a/assets/getting-started_calling-api-endpoints.md.14779e05.lean.js b/assets/getting-started_calling-api-endpoints.md.14779e05.lean.js new file mode 100644 index 0000000..3bad465 --- /dev/null +++ b/assets/getting-started_calling-api-endpoints.md.14779e05.lean.js @@ -0,0 +1 @@ +import{_ as e,o as t,c as i,Q as n}from"./chunks/framework.c4d6cd72.js";const m=JSON.parse('{"title":"Calling API endpoints","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/calling-api-endpoints.md","filePath":"getting-started/calling-api-endpoints.md"}'),a={name:"getting-started/calling-api-endpoints.md"},o=n("",8),r=[o];function s(p,l,c,d,h,g){return t(),i("div",null,r)}const _=e(a,[["render",s]]);export{m as __pageData,_ as default}; diff --git a/assets/getting-started_checking-api-availability.md.f10291ac.js b/assets/getting-started_checking-api-availability.md.f10291ac.js new file mode 100644 index 0000000..b48ca9f --- /dev/null +++ b/assets/getting-started_checking-api-availability.md.f10291ac.js @@ -0,0 +1 @@ +import{_ as e,o as t,c as a,Q as i}from"./chunks/framework.c4d6cd72.js";const _=JSON.parse('{"title":"Checking API availability","description":"","frontmatter":{},"headers":[],"relativePath":"getting-started/checking-api-availability.md","filePath":"getting-started/checking-api-availability.md"}'),n={name:"getting-started/checking-api-availability.md"},o=i('Before implementing any API calls, it's important to ensure that the API is available and accessible to your application. To do so, authorize your account and retrieve a JSON token.
To check the API availability, follow the Authorizing an account tutorial.
If the JSON token is retrieved successfully, then the FIB API is available and you can proceed with Calling API endpoints.
Otherwise, a response with an error code is displayed indicating the issue that needs to be resolved before proceeding.
For a list of possible responses, see Authorizing a user in the system > Responses.
Note
There are a variety of external issues that may be preventing you from successfully retrieving a JSON token. Examples include blocked outgoing HTTP requests and no Internet connection.
The test environment is a safe and controlled environment where you can try out and experiment with the FIB API without affecting the production system. Here, you can make mistakes, test different scenarios, and learn how to use the API.
To access the test environment, you need to follow the same steps as for the production environment. The only difference is that you will be provided with test credentials instead of production credentials (see Connection details below).
Using the test environment is beneficial for at least the following several reasons:
To connect to the FIB test environment, use the following credentials:
443HTTPS 443HTTPSTo begin using FIB as a peer and accessing API endpoints, you need to register a user account.
To register an account, perform the following steps:
You have now submitted your registration application which is then manually reviewed by the Consortium Administrator.
As soon as your application is approved, you receive an email notifying you that you become a peer in the FIB network and, depending on the chosen access method, you can access the FIB functionality via Web UI and/or API endpoints.
For Web UI tutorials, see Tutorials: Web interface.
For API tutorials, see Tutorials: API.
If you have forgotten the password on your account, you can reset it by performing the following steps:
Welcome to the Fraud Intelligence Blockchain (FIB) documentation.
FIB is a blockchain-based platform designed to combat fraud in various industries, including telecommunications, finance, and e-commerce.
This platform provides a secure and decentralized system for storing and sharing fraud-related information among participants to prevent potential fraudulent activities.
FIB operates on the Iroha 2 Hyperledger blockchain and uses smart contracts to automate the exchange of fraud intelligence data. This platform enables organizations to securely share and access real-time information about known fraud events and other relevant data, allowing them to identify potential fraud attempts quicker and more accurately.
If you are new to FIB, start with the Overview section, which provides a high-level introduction to the technology. This section explains what the FIB is, how it works, and other related concepts and terms.
For instructions on how to get started with the FIB, see the Getting Started section. This section covers everything from setting up your FIB account to accessing the API, and integrating it into your existing workflows and systems.
For assistance with FIB Web UI, try the Tutorials: Web UI section that walks you through basic operations that you can perform using the web interface.
If you're looking for step-by-step guidance on how to interact with the FIB API, check out the Tutorials: API section where you can find a variety of scenarios to help you get started with the API.
Finally, the API Specification section provides technical specification for the available endpoints explaining their internals exhaustively.
Iroha 2 is a blockchain hyperledger used to manage accounts, assets, and on-chain data storage with efficient smart contracts. The ledger is written in Rust and provides the following SDKs:
Check out the Iroha 2 Documentation as it provides an introduction to Iroha 2 as well as language-specific guides for Bash, Python, Rust, Kotlin/Java, and Javascript/TypeScript.
If, at any point, you’re experiencing any issues, please submit them at Fraud Intelligence Blockchain Freshdesk. Upon review, someone will get back to you to resolve the issue.
Additionally, you may contact FIL via email at support@fraudintelligencelimited.com