How to send historical data
Historical data are uploaded in batches.- Files must be in gZip format.
- Files should contain a JSON file with an array of all transactions.
- Make a request to the url you received from the response above to upload your data to be analyzed by sigma. For example:
Method: PUT
Endpoint: [THE URL YOU RECEIVED FROM THE RESPONSE OF THE UPLOAD ENDPOINT]
Body : [YOUR GZIP.FILE]
- The body of the request should be a gZip file containing a JSON file with an array of all transactions.
[
{
transaction_data: {
transaction_id: "d48ed552-eaef-46ed-bd0c-d230189e1de0",
status: true,
amount: "234.90",
balance_before: "9000.00",
externalPayment: false,
Provider: "atm",
type: "debit",
channel: "card",
transaction_date: "2023-04-28T20:16:12.642Z",
sender_bank_code: "255",
receiver_bank_code: "2435",
sender_account_number: "2000456355",
receiver_account_number: "25735262625",
narration: "Payment for groceries",
device: {
device_id: "d48ed552-eaef-46edbd0c-d230189e1de0",
manufacturer: "Samsung",
model: "s22 Ultra",
name: "s22 Ultra",
os_name: "Android",
os_version: "13.0",
location: {
latitude: "37.7749",
longitude: "-122.4194",
},
},
anonymized_user_data: {
unique_id: "d48ed552-eaef-46edbd0c-d230189e1de0",
is_phone_number_verified: true,
is_banned: false,
date_joined: "2023-04-28T20:16:12.642Z",
age_years: "25",
is_identity_verified: true,
state: "Lagos",
city: "Egbeda",
country: "Nigeria",
accountType: "individual",
updatedAt: "2023-04-28T20:16:12.642Z",
},
fraudulent: false,
},
},
];
| Sample Parameter Name | Description | Type |
|---|---|---|
| transaction_data | An object containing information about the transaction. | JSON object |
| transaction_id | The unique identifier of the transaction. | String e.g d48ed552-eaef-46ed-bd0c-d230189e1de0 |
| status | Before a fraud check is run on a transaction, the client must have run some pre-checks e.g. does user have enough balance? has user passed KYC checks? etc. True if all checks passed, false otherwise. | Boolean e.g true | false |
| amount | The amount of the transaction. | String e.g 234.90 |
| balance_before | The current balance of the account before the transaction. | String e.g 9000.00 |
| externalPayment | Answers: “Is this an internal transfer or an external payment?” | Boolean e.g true | false |
| Provider | The provider of the transaction. | String e.g atm, pos |
| type | The type of the transaction, such as “debit” or “credit”. | String e.g debit | credit |
| channel | Transaction channel (i.e. card, mobile, web transfer, cash withdrawal, etc.). | String e.g card |
| transaction_date | The date and time when the transaction occurred. | String in ISO-8601 format e.g 2023-04-28T20:16:12.642Z |
| sender_bank_code | The bank code of the sender (User if debit). | String e.g 255 |
| receiver_bank_code | The bank code of the receiver (User if credit). | String e.g 2435 |
| sender_account_number | The account number of the sender (User if debit). | String e.g 2000456355 |
| receiver_account_number | The account number of the receiver (User if credit). | String e.g 25735262625 |
| narration | The narration of the transaction. | — |
| device | An object containing information about the device used to make the transaction. | JSON object |
| device_id | The unique identifier of the device used to make the transaction. | String e.g d48ed552-eaef-46edbd0c-d230189e1de0 |
| manufacturer | The manufacturer of the device used to make the transaction. | String e.g Samsung |
| model | The model of the device used to make the transaction. | String e.g s22 Ultra |
| name | The name of the device used to make the transaction. | String e.g s22 Ultra |
| os_name | The name of the operating system of the device used to make the transaction. | String e.g Android |
| os_version | The version of the OS of the device used to make the transaction. | String e.g 13.0 |
| location | An object containing latitude and longitude of the transaction location. | JSON object |
| latitude | The latitude of the transaction location. | String e.g 37.7749 |
| longitude | The longitude of the transaction location. | String e.g -122.4194 |
| anonymized_user_data | An object containing anonymized info about the user. | JSON object |
| unique_id | A unique identifier for the user. | String e.g d48ed552-eaef-46edbd0c-d230189e1de0 |
| is_phone_number_verified | Indicates whether the user’s phone number has been verified. | Boolean e.g true | false |
| is_banned | Indicates whether the user’s account has been banned. | Boolean e.g true | false |
| date_joined | The date and time when the user joined the service. | String in ISO-8601 format e.g 2023-04-28T20:16:12.642Z |
| age_years | The age of the User. | String e.g 25 |
| is_identity_verified | Indicates whether the user’s identity has been verified. | Boolean e.g true | false |
| state | The state the user lives in. | String e.g Lagos |
| city | The city the user lives in. | String e.g Egbeda |
| country | The country the user lives in. | String e.g Nigeria |
| accountType | The type of the account. | String e.g business or individual |
| updatedAt | When the user data was updated last. | String in ISO-8601 format e.g 2023-04-28T20:16:12.642Z |
| fraudulent | Target variable (indicates whether the transaction was fraudulent). | Boolean e.g true | false |
Data is securely stored and anonymized to maintain confidentiality.