Sync API Documentation

2025-10-24 03:44

Overview

API Path: POST /api/v1/zoloz/realdoc/parse

Request Parameters

Field Name	Type	Required	Description	Example
bizId	String	Yes	Business ID	-
fileContent	String	No	Document file to parse. Maximum size: 10 MB.	invoice.pdf
fileUrl	String	No	Provide either `fileUrl` or `fileContent`. If you provide both, fileUrl takes precedence.	-
fileType	String	No	File type (pdf, jpg, png, etc.)	pdf
schemaId	String	No	Schema ID for document validation rules if `productType` is set to `REALDOC_DOCUMENT_EXTRACTION` `general_text_parsing_v1`：Intelligent recognition `companies_registry_v1`：Company registration certificate `business_registration_certificate_v1`：Business registration certificate if `productType` is set to `REALDOC_FORGERY_DETECTION` not required，`schemaId` is not required.	`general_text_parsing_v1`：Intelligent recognition `companies_registry_v1`：Company registration certificate `business_registration_certificate_v1`：Business registration certificate

Request Example

copy
{
  "bizId": "biz-id",
  "fileType": "PDF",
  "fileContent": "base64content",
  "schemaId": "general_text_parsing_v1"
}

Response Parameters

Field Name	Type	Description
transactionId	String	Transaction ID
data	Map	Extracted information in string format
result	Result	Business result

Result Parameters

Field Name	Type	Description
resultStatus	String	Result status `S`: Success `F`: Failure
resultCode	String	`SUCCESS`: Success `PARAMETER_ERROR`: Input parameter error `AUTHORIZATION_ERROR`: Authentication or authorization error `CLIENT_BUSINESS_ERROR`: Client business error `INTERNAL_BUSINESS_ERROR`: Internal business error `SYSTEM_ERROR`: System error
resultMessage	String	Result message On success, returns `success` On failure, returns a specific failure message

Response Example

copy
{
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "success"
    },
    "data": {
        "raw_text": [
            {
                "bbox": [
                    267,
                    18,
                    534,
                    59
                ],
                "text": "ACOINVOICE"
            },
            {
                "bbox": [
                    49,
                    96,
                    249,
                    117
                ],
                "text": "Invoice #: INV-2024-001"
            },
            {
                "bbox": [
                    503,
                    96,
                    655,
                    117
                ],
                "text": "Date: 2024-01-15"
            },
            {
                "bbox": [
                    49,
                    173,
                    115,
                    194
                ],
                "text": "BILL TO:"
            },
            {
                "bbox": [
                    49,
                    203,
                    142,
                    220
                ],
                "text": "ABC Company Ltd."
            },
            {
                "bbox": [
                    49,
                    228,
                    147,
                    245
                ],
                "text": "Suite 100"
            },
            {
                "bbox": [
                    49,
                    253,
                    184,
                    270
                ],
                "text": "New York, NY 10001"
            },
            {
                "bbox": [
                    49,
                    278,
                    169,
                    295
                ],
                "text": "Phone: (555) 123-4567"
            },
            {
                "bbox": [
                    49,
                    326,
                    167,
                    343
                ],
                "text": "DESCRIPTION"
            }
        ]
    },
    "transactionId": "R000000202510111032563d0e515f"
}

Examples of data formats:

general_text_parsing_v1

copy
{
    "raw_text": [
        {
            "bbox": [
                267,
                18,
                534,
                59
            ],
            "text": "ACOINVOICE"
        },
        {
            "bbox": [
                49,
                96,
                249,
                117
            ],
            "text": "Invoice #: INV-2024-001"
        },
        {
            "bbox": [
                503,
                96,
                655,
                117
            ],
            "text": "Date: 2024-01-15"
        },
        {
            "bbox": [
                49,
                173,
                115,
                194
            ],
            "text": "BILL TO:"
        },
        {
            "bbox": [
                49,
                203,
                142,
                220
            ],
            "text": "ABC Company Ltd."
        },
        {
            "bbox": [
                49,
                228,
                147,
                245
            ],
            "text": "Suite 100"
        },
        {
            "bbox": [
                49,
                253,
                184,
                270
            ],
            "text": "New York, NY 10001"
        },
        {
            "bbox": [
                49,
                278,
                169,
                295
            ],
            "text": "Phone: (555) 123-4567"
        },
        {
            "bbox": [
                49,
                326,
                167,
                343
            ],
            "text": "DESCRIPTION"
        }
    ]
}

bank_statement_v1

copy
{
        "account_holders_name": "MS. IxxG",
        "account_number": "91802xxxxx04",
        "bank_name": "AXIS BANK",
        "starting_balance": "47315.01",
        "ending_balance": "115368.01",
        "deposits_and_credits": "372700.00",
        "withdrawals_and_debits": "304647.00",
        "scheme_code": "CA- LARGE RETAILERS AND DISTRIBUTORS",
        "customer_id": "88xxx0",
        "currency": "INR",
        "lien_amount": "0.00",
        "nomination_details": "NOMINATION REGISTERED",
        "PIN": "11xxx1",
        "details": [
            {
                "date": "10/04/2019",
                "description": "MOB/SELFFT/SURJEET SINGH/9130100",
                "balance": "315.01"
            },
            {
                "date": "13/04/2019",
                "description": "GST @18% on Charge",
                "balance": "2028.81"
            }
        ]
    }

mys_birth_certificate_v1

copy
{
    "BASIC": {
        "Registration_Area": "MALAYSIA BARAT",
        "Registration_Centre": "JPN NEGERI JOHOR"
    },
    "CHILD": {
        "Full_Name": "xxUYO",
        "Date_and_Time_of_Birth": "15 FEBRUARI 2018 05:21 AM",
        "Race": "INDONESIA",
        "Place_of_Birth": "PUSAT PAKAR SAKITPUAN DAN PERBIDANAN KHOR & LOH SKUDAI",
        "Status_of_Citizenship": "WARGANEGARA",
        "Gender": "LELAKI",
        "Religion": "ISLAM"
    },
    "FATHER": {
        "Name": "xxONO",
        "Identity_Card_Number": "7xx3",
        "Age": "47 TAHUN",
        "Status_of_Citizenship": "BUKAN WARGANEGARA",
        "Status_of_Residence": "PEMASTAUTIN TETAP",
        "Race": "INDONESIA",
        "Religion": "ISLAM",
        "Types_and_Number_of_Other_Document": "Maklumat Tidak Berkenaan"
    }
,
    "MOTHER": {
        "Name": "xxRTI",
        "Identity_Card_Number": "7xx3",
        "Age": "37 TAHUN",
        "Status_of_Citizenship": "BUKAN WARGANEGARA",
        "Status_of_Residence": "Maklumat Tidak Berkenaan",
        "Race": "INDONESIA",
        "Religion": "ISLAM",
        "Types_and_Number_of_Other_Document": "PASPORT INDONESIA Bxx4",
        "Residence_Address": "LOT 368 A JALAN AHAD KAMPUNG UNGKU MOHSIN 80350 JOHOR BAHRU JOHOR"
    },
    "INFORMANT": {
        "Name": "xxONO",
        "Identity_Card_Number": "7xx3",
        "Date_of_Registration": "21 FEBRUARI 2018",
        "Types_and_Number_of_Other_Document": "Maklumat Tidak Berkenaan"
    }
}