Statement Analysis - Retrieve Work Order

Introduction:

This is the 2nd API in the Statement Analysis Flow. This API is used to retrieve the status of the Work Order created in the Analyze Statement API. This API will provide a detailed description of the status of each file provided in the first API.

Sample Curl:

curl --location 'https://api.signzy.ae/api/v3/statementanalysis/retrieve-work-order' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data '{
    "authToken": "eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3klMiOiJmYWxzZSIsInJvbGVzIjpbIkFETUlOIl0sInRlbmFudElkIjoiNzAwMjkiLCJjbGllbnQiOiJjSEpsWTJsellWOTBaVzVoYm5RM01EQXlPUT09Iiwic3ViIjoiYXJhdmluZEBmaW5taXRyLmluIiwiaWF0IjoxNzc3NDg2MjU1LCJleHAiOjE3Nzc1NzI2NTV9.2GYc9ViZMAs5ifOaLfcSljJU19HjKmtl8n8QBX9hf-Y",
    "reportId": "PR1350758572297783"
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
authType	String	Authentication Token Generated in the Authenticate API	Mandatory
reportId	String	reportId you have received from the analyze-statement API	Optional
borrowerReferenceId	String	Id which was passed during create web journey link.	Optional

reportId/borrowerReferenceId one of them is mandatory to be passed in req body of retrieve work order.

Sample Response:

{
    "report": {
        "bankScore": "912",
        "reportId": "PR4818638733359423",
        "reportName": "ca9fcfcc-e01a-4d51-9e1c-ca3c37041a9c",
        "reportStatus": "ANALYSED",
        "reportStatusDescription": "ANALYSED (2 ACCOUNTS) - CAM READY",
        "reportCamStatus": "CAM READY",
        "reportType": "BSA",
        "accountStatus": "ANALYSED  - CAM READY",
        "currency": "INR",
        "currencyFormat": "##,##,###.##",
        "lastUpdatedOn": "2025-06-04 12:26:37",
        "lastUpdatedBy": "[email protected]",
        "createdOn": "2025-06-04 12:24:48",
        "createdBy": "[email protected]"
    },
    "reportAccounts": [
        {
            "account": {
                "accountId": "1671",
                "accountName": "ZAMBROTTA RETAIL PRIVATE LIMITED",
                "accountNumber": "17330200002493",
                "ifscCode": "FDRL0001733",
                "accountType": "2",
                "accountTypeName": "Current Account",
                "bankId": "71",
                "bankName": "Federal Bank",
                "status": "ANALYSED",
                "statusDescription": "ANALYSED - CAM READY",
                "camStatus": "CAM READY",
                "startDate": "2023-08-03",
                "endDate": "2024-01-30",
                "phoneNumber": "919495966402",
                "jointHolderName": "",
                "accountHolderName": "ZAMBROTTA RETAIL PRIVATE LIMITED",
                "micrCode": "695049022",
                "branchAddress": "BP 617, KATTAKADA ROAD, THIRUVANATHAPURAM DIST",
                "branchName": "BALARAMAPURAM",
                "panNumber": "",
                "email": "[email protected]",
                "customerAddress": "D 57 KRISHNA KRIPA PERUR NAGAR, AMBALAMUKKU, , KERALA, INDIA-695005.",
                "accountOpeningDate": "2022-04-02",
                "verifiedAccount": "2",
                "analysisStartDate": "",
                "analysisEndDate": "",
                "analysisPeriod": "",
                "transactionStartDate": "",
                "transactionEndDate": "",
                "currency": "INR",
                "currencyFormat": "##,##,###.##",
                "accountStatus": "ACTIVE",
                "additionalData": {
                    "accountSubType": "Current Account"
                },
                "accountReferenceNumber": "PARN1671",
                "lastModifiedDate": "2025-06-04 06:56:37"
            },
            "files": [
                {
                    "fileId": 4774,
                    "status": "PARSED",
                    "originalName": "6c8b3bb67a241c67a420154062fa5db4.pdf",
                    "documentType": "BANK_STATEMENT",
                    "password": "",
                    "fromDate": "03-08-2023",
                    "tillDate": "30-01-2024",
                    "creatorName": "PDFium",
                    "producerName": "PDFium",
                    "statusDescription": "",
                    "fraudScore": "150",
                    "authenticity": "FRAUD SUSPECTED",
                    "authenticityDetails": [
                        "PDF Creator/ Producer check failed"
                    ],
                    "invalidDates": [],
                    "pageCount": "44",
                    "txnCount": "1403"
                }
            ]
        },
        {
            "account": {
                "accountId": "1672",
                "accountName": "RESGB",
                "accountNumber": "XXXXXXXX2910",
                "ifscCode": "",
                "accountType": "1",
                "accountTypeName": "Savings Account",
                "bankId": "9",
                "bankName": "ICICI Bank",
                "status": "ANALYSED",
                "statusDescription": "ANALYSED - CAM READY",
                "camStatus": "CAM READY",
                "startDate": "2022-10-01",
                "endDate": "2022-10-31",
                "phoneNumber": "",
                "jointHolderName": "",
                "accountHolderName": "RESGB",
                "micrCode": "",
                "branchAddress": "",
                "branchName": "",
                "panNumber": "",
                "email": "",
                "customerAddress": "",
                "accountOpeningDate": "",
                "verifiedAccount": "2",
                "analysisStartDate": "",
                "analysisEndDate": "",
                "analysisPeriod": "",
                "transactionStartDate": "",
                "transactionEndDate": "",
                "currency": "INR",
                "currencyFormat": "##,##,###.##",
                "accountStatus": "",
                "additionalData": {
                    "accountSubType": "Savings Account"
                },
                "accountReferenceNumber": "PARN1672",
                "lastModifiedDate": "2025-06-04 06:56:35"
            },
            "files": [
                {
                    "fileId": 4775,
                    "status": "PARSED",
                    "originalName": "b7130f4754dc4ec521f6120b20510571.pdf",
                    "documentType": "BANK_STATEMENT",
                    "password": "390401502910",
                    "fromDate": "01-10-2022",
                    "tillDate": "17-10-2022",
                    "creatorName": "Quadient CXM AGInspire14.0.196.0",
                    "producerName": "",
                    "statusDescription": "",
                    "fraudScore": "0",
                    "authenticity": "ORIGINAL",
                    "authenticityDetails": [],
                    "invalidDates": [],
                    "pageCount": "2",
                    "txnCount": "11"
                }
            ]
        }
    ],
    "reportFiles": [],
    "reportGst": [],
    "reportCreditBureaus": []
}

Output Parameters:

Parameter	Type	Description
report	Object	Contains the overall report information.
report.bankScore	String	Bank score of the report (e.g., "925").
report.reportId	String	Unique identifier for the report.
report.reportName	String	Internal name of the report.
report.reportStatus	String	This shows the status of the report. The status of a report changes till it reaches the last status. The possible status for a report can be one of the following IN PROGRESS ANALYSED ANALYSIS ON HOLD
report.reportStatusDescription	String	This shows detailed information about accounts in the report with status. A possible status description for a report can be one of the following IN PROGRESS ANALYSED (X ACCOUNTS) ANALYSED (X OF Y ACCOUNTS) ANALYSIS ON HOLD
report.reportCamStatus	String	This shows the status of the CAM report. Possible CAM status for a report can be one of the following CAM IN PROGRESS CAM READY CAM FAILED
report.reportType	String	Type of report (e.g., "BSA").
report.accountStatus	String	Account status based on analysis (e.g., "ANALYSED - CAM READY").
report.currency	String	Currency code (e.g., "INR").
report.currencyFormat	String	Format string for displaying currency values (e.g., "##,##,###.##").
report.lastUpdatedOn	String	Date and time the report was last updated in YYYY-MM-DD HH:MM:SS format.
report.lastUpdatedBy	String	Email address of the user who last updated the report.
report.createdOn	String	Date and time the report was created in YYYY-MM-DD HH:MM:SS format.
report.createdBy	String	Email address of the user who created the report.
reportAccounts	Array of Objects	List of accounts included in the report.
reportAccounts[i].account	Object	Details of a specific account.
reportAccounts[i].account.accountId	String	Unique identifier for the account.
reportAccounts[i].account.accountName	String	Name of the account holder (if available).
reportAccounts[i].account.accountNumber	String	Account number (e.g., "6043XXXXXXX2513").
reportAccounts[i].account.ifscCode	String	IFSC code of the bank branch.
reportAccounts[i].account.accountType	String	Account type code (e.g., "1" for Savings Account, "2" for Current Account).
reportAccounts[i].account.accountTypeName	String	Name of the account type (e.g., "Savings Account").
reportAccounts[i].account.bankId	String	Unique identifier for the bank.
reportAccounts[i].account.bankName	String	Name of the bank (e.g., "Union Bank of India").
reportAccounts[i].account.status	String	Current status of the account information (e.g., "ANALYSED").
reportAccounts[i].account.statusDescription	String	Description of the account information status.
reportAccounts[i].account.camStatus	String	Current status of Cash Account Management (CAM) process for the account (e.g., "CAM READY").
reportAccounts[i].account.startDate	String	Start date of the account data included in the report (YYYY-MM-DD).
reportAccounts[i].account.endDate	String	End date of the account data included in the report (YYYY-MM-DD).
reportAccounts[i].account.phoneNumber	String	Phone number associated with the account (if available).
reportAccounts[i].account.jointHolderName	String	Name of the joint account holder (if available).
reportAccounts[i].account.accountHolderName	String	Name of the account holder (if available).
reportAccounts[i].account.micrCode	String	MICR code of the bank branch.
reportAccounts[i].account.branchAddress	String	Address of the bank branch.
reportAccounts[i].account.branchName	String	Name of the bank branch.
reportAccounts[i].account.panNumber	String	PAN number of the account holder (if available).
reportAccounts[i].account.email	String	Email address associated with the account (if available).
reportAccounts[i].account.customerAddress	String	Customer address associated with the account (if available).
reportAccounts[i].account.accountOpeningDate	String	Date the account was opened (if available).
reportAccounts[i].account.verifiedAccount	String	Verification status of the account (e.g., "2").
reportAccounts[i].account.analysisStartDate	String	Custom analysis start date.
reportAccounts[i].account.analysisEndDate	String	Custom analysis end date.
reportAccounts[i].account.analysisPeriod	String	Analysis Period of the Bank Statement
reportAccounts[i].account.transactionStartDate	String	Transaction Start Date
reportAccounts[i].account.transactionEndDate	String	Transaction End Date
reportAccounts[i].account.currency	String	Currency code (e.g., "INR").
reportAccounts[i].account.currencyFormat	String	Format string for displaying currency values (e.g., "##,##,###.##").
reportAccounts[i].account.accountStatus	String	Status of the Account
reportAccounts[i].account.accountReferenceNumber	String	Unique reference number for the account within the report (e.g., "PARN144").
reportAccounts[i].account.lastModifiedDate	String	Last Modified Date of the report
reportAccounts[i].account.accountId	Number	Unique identifier for the account
reportAccounts[i].account.accountReferenceNumber	String	The account reference number within the report
reportAccounts[i].files.fileId	Number	Unique identifier for the file
reportAccounts[i].files.status	String	Status of the file (e.g., "PARSED", "IN REVIEW")
reportAccounts[i].files.originalName	String	The original name of the file uploaded
reportAccounts[i].files.documentType	String	Type of file uploaded (e.g., "Bank Statement")
reportAccounts[i].files.password	String	The password provided while creating the account
reportAccounts[i].files.fromDate	String	Start date of the data in the file (YYYY-MM-DD format)
reportAccounts[i].files.tillDate	String	End date of the data in the file (YYYY-MM-DD format)
reportAccounts[i].files.creatorName	String	Creator of the uploaded file
reportAccounts[i].files.producerName	String	Producer of the uploaded file
reportAccounts[i].files.statusDescription	String	Description of the file status
reportAccounts[i].files.fraudScore	String	Fraud score of the file
reportAccounts[i].files.authenticity	String	Authenticity of the file
reportAccounts[i].files.authenticityDetails	Array of Strings	Details about authenticity check failure (if any)
reportAccounts[i].files.pageCount	String	The page count of the file
reportAccounts[i].files.txnCount	String	Transaction count in the file
reportFiles	Array	Contains a list of Report Files
reportGst	Array	Contains a list of GST details.
reportCreditBureaus	Array	Contains a list of credit Bureau details.

Status Codes:

{
	"error": {
		"reason": "NOT_FOUND",
		"status": 200,
		"message": "reportId not found",
		"type": "Not Found",
		"statusCode": 404,
		"name": "error"
	}
}