Skip to main content
POST
/
pirimid
/
analytics
/
pdf
/
pull
/
json
Error
A valid request URL is required to generate request examples
{
  "ver": "1.21.0",
  "status": "success",
  "data": {
    "status": "SUCCESS",
    "message": "Success",
    "data": {
      "bankingAnalysis": {
        "overallAnalysis": {},
        "completeCategoryWiseAnalysis": {},
        "accountProfiles": [],
        "fcuIndicators": {},
        "bounceAnalysis": {}
      }
    }
  }
}

​
Overview

The Pull Analytics JSON API is the final step in the PDF Analytics flow. After the PDF processing is complete (confirmed via the Pull Status API), use this endpoint to retrieve the analytics results in JSON format. The response contains comprehensive banking analytics derived from the uploaded bank statement PDFs, similar to the Analytics JSON API output.

​
PDF Analytics Flow

1

Push PDF

Upload bank statement PDFs using the Push PDF API. Receive a ref_token.
2

Check Status

Poll the Pull Status API until processing is complete.
3

Pull Analytics JSON (this API)

Retrieve the analytics results using the ref_token.

​
Important Notes

  • Only call this API after the Pull Status API confirms processing is complete.
  • The response structure is similar to the Analytics JSON API, containing banking analysis, category-wise breakdowns, and account profiles.

​
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

​
ref_token
string
required
The reference token returned by the Push PDF API. This uniquely identifies the PDF processing job whose results you want to retrieve.

​
Request Example

{
  "ref_token": "34b11d14-1bee-4966-bcdc-c2c7ce9ff9a5"
}

​
Code Examples

curl --location --request POST '{{Base_URL}}/pirimid/analytics/pdf/pull/json' \
--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 '{
    "ref_token": "34b11d14-1bee-4966-bcdc-c2c7ce9ff9a5"
}'

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 containing the reference token for PDF processing status or results.

​
ref_token
string
required

Reference token returned by the Push PDF API.

Example:

"34b11d14-1bee-4966-bcdc-c2c7ce9ff9a5"

Response

Analytics data retrieved successfully

Response containing analytics data for a consent journey.

​
ver
string

API version that processed the request.

Example:

"1.21.0"

​
status
string

Overall API call status.

Example:

"success"

​
data
object

Analytics response payload.