Skip to main content
POST
/
pirimid
/
analytics
/
pdf
/
pull
/
status
Error
A valid request URL is required to generate request examples
{
  "status": "success",
  "data": {
    "status": "COMPLETED",
    "message": "Processing complete. Use Pull Analytics JSON to retrieve results."
  }
}

​
Overview

The Pull Status API is the second step in the PDF Analytics flow. After uploading bank statement PDFs via the Push PDF API, use this endpoint to check whether the analytics processing is complete.

​
PDF Analytics Flow

1

Push PDF

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

Check Status (this API)

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

Pull Analytics JSON

Once status is complete, retrieve 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

​
ref_token
string
required
The reference token returned by the Push PDF API. This uniquely identifies the PDF processing job.

​
Request Example

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

​
Code Examples

curl --location --request POST '{{Base_URL}}/pirimid/analytics/pdf/pull/status' \
--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

Processing status retrieved

Response containing the processing status of a pushed PDF.

​
status
string

API call status.

Example:

"success"

​
data
object