Skip to main content
POST
/
pirimid
/
analytics
/
pdf
/
push
Error
A valid request URL is required to generate request examples
{
  "status": "success",
  "data": {
    "ref_token": "34b11d14-1bee-4966-bcdc-c2c7ce9ff9a5",
    "message": "PDF uploaded successfully. Use ref_token to check status."
  }
}

​
Overview

The Push PDF API is the first step in the PDF Analytics flow. It allows you to upload one or more bank statement PDF files (as Base64-encoded data) for analytics processing. After a successful upload, the API returns a ref_token that you use in subsequent steps to check processing status and retrieve the analytics results.

​
PDF Analytics Flow

1

Push PDF (this API)

Upload bank statement PDFs with customer details. Receive a ref_token for tracking.
2

Check Status

Poll the Pull Status API using the ref_token to check if processing is complete.
3

Pull Analytics JSON

Once processing is complete, retrieve the analytics results using the Pull Analytics JSON API.

​
Authentication

This API requires authentication using the following headers:
​
client_id
string
required
Your unique client identifier provided by FinPro during onboarding.
​
client_secret
string
required
Your confidential client secret key provided by FinPro. Must be kept secure.
​
appIdentifier
string
required
The unique identifier for your application.
​
organisationId
string
required
Your organization’s unique identifier assigned by FinPro.
​
content-Type
string
required
Must be set to application/json.

​
Request Body

​
customer_name
string
required
Full name of the customer whose bank statement is being uploaded.
​
mobile_number
string
required
Customer’s mobile number.
​
loan_account_number
string
required
The loan account number associated with this customer.
​
fileData
object[]
required
An array of file objects, each representing a bank statement PDF to be processed.

​
Request Example

{
  "customer_name": "John Doe",
  "mobile_number": "9876543210",
  "loan_account_number": "LOAN123456",
  "fileData": [
    {
      "bank_account_number": "1234567890",
      "file": "SBI.pdf",
      "file_blob": "<Base64-encoded PDF content>",
      "password": "",
      "remarks": "Savings account statement"
    }
  ]
}

​
Code Examples

curl --location --request POST '{{Base_URL}}/pirimid/analytics/pdf/push' \
--header 'client_id: {{Client_Id}}' \
--header 'client_secret: {{Client_Secret}}' \
--header 'organisationId: {{Organisation_Id}}' \
--header 'appIdentifier: {{App_Identifier}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_name": "John Doe",
    "mobile_number": "9876543210",
    "loan_account_number": "LOAN123456",
    "fileData": [
        {
            "bank_account_number": "1234567890",
            "file": "SBI.pdf",
            "file_blob": "<Base64-encoded PDF content>",
            "password": "",
            "remarks": "Savings account statement"
        }
    ]
}'

Authorizations

​
client_id
string
header
required

Your unique client identifier provided by MoneyOne during FIU onboarding

​
client_secret
string
header
required

Your confidential client secret provided by MoneyOne

​
organisationId
string
header
required

Your organization's unique identifier in the FinPro system

​
appIdentifier
string
header
required

Application-specific identifier for tracking API calls

Body

application/json

Request body for uploading bank statement PDFs for analytics processing.

​
customer_name
string
required

Full name of the customer.

Example:

"John Doe"

​
mobile_number
string
required

Customer's mobile number.

Example:

"9876543210"

​
loan_account_number
string
required

Loan account number associated with the customer.

Example:

"LOAN123456"

​
fileData
object[]
required

Array of PDF file objects to be processed.

Response

PDF uploaded successfully for processing

Response after successfully pushing a PDF for processing.

​
status
string

API call status.

Example:

"success"

​
data
object