UAE Broker Invoice OCR API
Introduction
The UAE Broker Invoice OCR API automatically extracts key information from real estate broker invoices and commission statements submitted by users. Using OCR and document intelligence techniques, the API identifies and captures relevant fields from invoices, converting unstructured document data into a structured JSON response.
This API helps organizations digitize real estate transaction workflows, reduce manual data entry, improve operational efficiency, and enable faster KYB, payment processing, and financial reconciliation workflows.
API Details
Endpoint:
POST https://api.signzy.ae/api/v3/extraction/broker_invoice_real-estate-UAEPOST https://api-preproduction.signzy.app/api/v3/extraction/broker_invoice_real-estate-UAERequest Parameters
Request Body Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
file_url | string | Yes | Persist file URL (Supported file types are jpg, jpeg, png, pdf, tiff) |
Request Headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Yes | The type of content that the request body contains. |
Authorization | XXXXXXXXXXX | Yes | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
JSON
Code samples
curl --location 'https://api-preproduction.signzy.app/api/v3/extraction/broker_invoice_real-estate-UAE' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_key>' \
--data '{
"file_url": "file url"
}'Response body parameters
Group | Parameter | Data Type | Description |
|---|---|---|---|
banking_details | account_number | string | Bank account number for payment transfer. Returns null if not present on the document. |
banking_details | bank_address | string | Physical address of the bank branch. Returns null if not present on the document. |
banking_details | bank_branch | string | Bank branch name or identifier. Returns null if not present on the document. |
banking_details | bank_country | string | Country where the bank is located. Returns null if not present on the document. |
banking_details | bank_name | string | Name of the bank handling the transaction. |
banking_details | beneficiary_name | string | Name of the payment beneficiary or recipient entity. |
banking_details | currency | string | Currency code for transactions (e.g., AED, USD). Returns null if not specified on the document. |
banking_details | swift_code | string | SWIFT code for international bank transfers. Returns null if not present on the document. |
broker_identity | trade_license_number | string | Trade license number of the real estate broker. Returns null if not present on the document. |
document_identity | invoice_date | string | Date when the invoice was issued (format: MM/DD/YYYY). |
document_identity | invoice_number | string | Unique invoice identification number. |
payment_details | mode_of_payment | string | Method of payment (e.g., Bank Transfer, Check, Cash). Returns null if not present on the document. |
property_and_commission | commission_amount_aed | string | Commission amount payable in AED. |
property_and_commission | commission_payable_pct | string | Commission percentage applied to the purchase price. |
property_and_commission | project_name | string | Name of the real estate project or property development. |
property_and_commission | purchase_price_aed | string | Total purchase price of the property in AED. |
property_and_commission | total_amount_incl_vat_aed | string | Total invoice amount including VAT in AED. |
property_and_commission | tranche_installment_name | string | Identifier for the payment tranche or installment plan. Returns null if not present on the document. |
property_and_commission | unit_number | string | Property unit number or identifier within the project. |
property_and_commission | vat_amount | string | Value Added Tax (VAT) amount charged on the commission. Returns null if not present on the document. |
Response examples
{
"result": {
"banking_details": {
"account_number": "123456789012",
"bank_address": "Sheikh Zayed Road, Dubai, UAE",
"bank_branch": "Dubai Main Branch",
"bank_country": "United Arab Emirates",
"bank_name": "ABC Bank PJSC",
"beneficiary_name": "XYZ REAL ESTATE L.L.C",
"currency": "AED",
"swift_code": "ABCDAEADXXX"
},
"broker_identity": {
"trade_license_number": "CN-1234567"
},
"document_identity": {
"invoice_date": "15/07/2026",
"invoice_number": "INV/2026/00125"
},
"payment_details": {
"mode_of_payment": "Bank Transfer"
},
"property_and_commission": {
"commission_amount_aed": "25,000.00",
"commission_payable_pct": "2%",
"project_name": "Sunrise Residences Tower A",
"purchase_price_aed": "1,250,000.00",
"total_amount_incl_vat_aed": "26,250.00",
"tranche_installment_name": "Second Installment",
"unit_number": "SR-A-1205",
"vat_amount": "1,250.00"
}
}
}
Best Practices
- File Quality: Ensure broker invoices are clear, legible, and not heavily watermarked or damaged for optimal extraction accuracy
- Supported Formats: Use supported file formats (JPG, JPEG, PNG, PDF, TIFF) for best results
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.