Contract F Document- Extraction API

The Contract F Document- Extraction API is used to extract key details from Contract F document which is a system generated contract and usually is around 7-8 pages signed between Buyer and Sellers for properties in UAE.

API Details

Endpoint:

POST  https://api.signzy.ae/api/v3/extraction/Contract-F-Document-SR

POST  https://api-preproduction.signzy.app/api/v3/extraction/Contract-F-Document-SR

Request body parameters:

Parameter	Type	Required	Default	Description
url	string	Yes	Yes	Persist Img url

{
    "url": "img_url"
}

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.

Code samples:

curl --location 'https://api-preproduction.signzy.app/api/v3/extraction/Contract-F-Document-SR' \
--header 'Content-Type: application/json' \
--header 'Authorization:<auth_key>' \
--data '{
    "url":
        "img.url"
    
}'

Response body parameters:

Parameter	Data type	Description
contract	object	Contract-level metadata extracted from the Unified Sell Contract (Form F).
contract.contract_number	string	Unique DLD contract number (e.g., CF202602167479). Null if not detected.
contract.title_deed_number	string	Title deed number of the property linked to this contract. Null if not detected.
contract.status	string	Current status of the contract as printed on the document. Expected values: Signed, Cancelled, Expired. Null if not detected.
contract.start_date	string (date)	Start date of the contract in YYYY-MM-DD format. Null if not detected.
contract.end_date	string (date)	End date of the contract in YYYY-MM-DD format. Null if not detected.
property	object	Property-level details for the unit being transacted.
property.property_number	string	Property / unit number as registered with DLD (e.g., B3410). Null if not detected.
property.building_number	string	Building number on the plot. Null if not detected.
property.building_name	string	Name of the building the unit belongs to. Null if not detected.
property.project_name	string	Name of the project the building belongs to. Null if not detected.
property.plot_number	string	DLD plot number (e.g., 25/0). Null if not detected.
property.location	string	Community / sub-community where the property is located (e.g., Al Merkadh). Null if not detected.
property.type_of_property	string	Type of property as printed on the contract (e.g., Unit, Villa, Land). Null if not detected.
property.type_of_area	string	Tenure type of the property. Expected values: Free Hold, Lease Hold. Null if not detected.
property.usage	string	Permitted usage of the property (e.g., Residential, Commercial). Null if not detected.
property.area_size_sqm	number	Total area of the property in square metres. Null if not detected.
sellers	array	List of sellers (owners) party to the contract. Empty array if none detected.
sellers[].name_en	string	Full name of the seller in English.
sellers[].name_ar	string	Full name of the seller in Arabic.
sellers[].actual_share_sqm	number	Seller's actual ownership share in square metres prior to the sale.
sellers[].selling_share_sqm	number	Portion of the seller's share being sold under this contract, in square metres.
buyers_share	array	List of buyers with their share of the property being purchased. Empty array if none detected.
buyers_share[].name_en	string	Full name of the buyer in English (as printed in the Buyers Share Details section).
buyers_share[].name_ar	string	Full name of the buyer in Arabic.
buyers_share[].buying_share_sqm	number	Buyer's share of the property being purchased, in square metres.
buyers_share[].buying_share_percentage	number	Buyer's share of the property being purchased, as a percentage (0-100).
buyers_details	array	List of buyers with their per-person identity, passport, and address information. Empty array if none detected.
buyers_details[].person_type	string	Classification of the buyer as printed on the contract. Expected values: Resident, Non-Resident, Other.
buyers_details[].contract_signature_date	string	Timestamp at which the buyer digitally signed the contract.
buyers_details[].national_id	object \| null	UAE National ID details of the buyer. null when the buyer's person type does not require a UAE ID (e.g., Other, non-resident).
buyers_details[].national_id.name_en	string	Buyer's name in English as printed on the UAE National ID.
buyers_details[].national_id.name_ar	string	Buyer's name in Arabic as printed on the UAE National ID.
buyers_details[].national_id.gender	string	Buyer's gender. Expected values: Male, Female.
buyers_details[].national_id.nationality	string	Buyer's nationality as printed on the UAE National ID.
buyers_details[].national_id.uae_id_number	string	UAE National ID number of the buyer.
buyers_details[].national_id.uae_id_expiry_date	string	Expiry date of the UAE National ID in YYYY-MM-DD format.
buyers_details[].passport	object \| null	Passport details of the buyer. null when passport information is not present on the contract for this buyer.
buyers_details[].passport.passport_number	string	Passport number of the buyer.
buyers_details[].passport.nationality	string	Nationality as printed on the passport.
buyers_details[].passport.gender	string	Gender as printed on the passport. Expected values: Male, Female.
buyers_details[].passport.issue_date	string (date)	Passport issue date in YYYY-MM-DD format.
buyers_details[].passport.expiry_date	string (date)	Passport expiry date in YYYY-MM-DD format.
buyers_details[].passport.birth_place	string	Place of birth as printed on the passport.
buyers_details[].address	object	Buyer's address information as printed on the contract.
buyers_details[].address.country_of_resident_en	string	Buyer's country of residence in English. Null if not detected.
buyers_details[].address.country_of_resident_ar	string	Buyer's country of residence in Arabic. Null if not detected.
buyers_details[].address.street	string	Street component of the buyer's address. Null if not detected.
buyers_details[].address.city	string	City component of the buyer's address. Null if not detected.
buyers_details[].address.address	string	Full / free-text address as printed on the contract. Null if not detected.
seller_broker	object	Details of the broker representing the seller.
seller_broker.broker_name_en	string	Full name of the seller's broker in English. Null if not detected.
seller_broker.broker_name_ar	string	Full name of the seller's broker in Arabic. Null if not detected.
seller_broker.brn	string	Broker Registration Number (BRN) issued by RERA. Null if not detected.
seller_broker.orn	string	Office Registration Number (ORN) of the broker's office issued by RERA. Null if not detected.
seller_broker.office_name_en	string	Name of the broker's office in English. Null if not detected.
seller_broker.office_name_ar	string	Name of the broker's office in Arabic. Null if not detected.
seller_broker.email	string	Email address of the seller's broker. Null if not detected.
seller_broker.mobile_number	string	Mobile number of the seller's broker (E.164-style without +). Null if not detected.
buyer_broker	object	Details of the broker representing the buyer. May be identical to seller_broker when a single broker represents both parties.
buyer_broker.broker_name_en	string	Full name of the buyer's broker in English. Null if not detected.
buyer_broker.broker_name_ar	string	Full name of the buyer's broker in Arabic. Null if not detected.
buyer_broker.brn	string	Broker Registration Number (BRN) issued by RERA. Null if not detected.
buyer_broker.orn	string	Office Registration Number (ORN) of the broker's office issued by RERA. Null if not detected.
buyer_broker.office_name_en	string	Name of the broker's office in English. Null if not detected.
buyer_broker.office_name_ar	string	Name of the broker's office in Arabic. Null if not detected.
buyer_broker.email	string	Email address of the buyer's broker. Null if not detected.
buyer_broker.mobile_number	string	Mobile number of the buyer's broker (E.164-style without +). Null if not detected.
payment_details	array	List of payments (deposit and balance) declared on the contract. Empty array if none detected.
payment_details[].payment_type	string	Payment method. Expected values: Cheque, Manager Cheque, Cash, Bank Transfer.
payment_details[].amount	number	Amount of the payment in AED.
payment_details[].bank_name	string	Name of the bank the cheque is drawn on. Null for non-cheque payment types.
payment_details[].cheque_number	string	Cheque number. Null for non-cheque payment types.
payment_details[].cheque_date	string (date)	Cheque date in YYYY-MM-DD format. Null for non-cheque payment types.

{
    "buyer_broker": {
        "brn": "0000000",
        "broker_name_ar": "XXXXXXX",
        "broker_name_en": "XXXXXXX",
        "email": "[email protected]",
        "mobile_number": "0000000000",
        "office_name_ar": "XXXXXXX",
        "office_name_en": "XXXXXXX",
        "orn": "0000000"
    },
    "buyers_details": [
        {
            "address": {
                "address": null,
                "city": null,
                "country_of_resident_ar": "XXXXXXX",
                "country_of_resident_en": "XXXXXXX",
                "street": null
            },
            "contract_signature_date": "0000-00-00T00:00:00",
            "national_id": {
                "gender": "XXXXXXX",
                "name_ar": "XXXXXXX",
                "name_en": "XXXXXXX",
                "nationality": "XXXXXXX",
                "uae_id_expiry_date": "0000-00-00",
                "uae_id_number": "000000000000000"
            },
            "passport": {
                "birth_place": "XXXXXXX",
                "expiry_date": "0000-00-00",
                "gender": "XXXXXXX",
                "issue_date": "0000-00-00",
                "nationality": "XXXXXXX",
                "passport_number": "000000000"
            },
            "person_type": "XXXXXXX"
        },
        {
            "address": {
                "address": null,
                "city": null,
                "country_of_resident_ar": "XXXXXXX",
                "country_of_resident_en": "XXXXXXX",
                "street": null
            },
            "contract_signature_date": "0000-00-00T00:00:00",
            "national_id": null,
            "passport": null,
            "person_type": "XXXXXXX"
        }
    ],
    "buyers_share": [
        {
            "buying_share_percentage": 0,
            "buying_share_sqm": 0.00,
            "name_ar": "XXXXXXX",
            "name_en": "XXXXXXX"
        },
        {
            "buying_share_percentage": 0,
            "buying_share_sqm": 0.00,
            "name_ar": "XXXXXXX",
            "name_en": "XXXXXXX"
        }
    ],
    "contract": {
        "contract_number": "XXXXXXX",
        "end_date": "0000-00-00",
        "start_date": "0000-00-00",
        "status": "XXXXXXX",
        "title_deed_number": "0000000/0000"
    },
    "payment_details": [
        {
            "amount": 0,
            "bank_name": "XXXXXXX",
            "cheque_date": "0000-00-00",
            "cheque_number": "000000",
            "payment_type": "XXXXXXX"
        }
    ],
    "property": {
        "area_size_sqm": 0.00,
        "building_name": "XXXXXXX",
        "building_number": "0",
        "location": "XXXXXXX",
        "plot_number": "0/0",
        "project_name": "XXXXXXX",
        "property_number": "XXXXXXX",
        "type_of_area": "XXXXXXX",
        "type_of_property": "XXXXXXX",
        "usage": "XXXXXXX"
    },
    "seller_broker": {
        "brn": "0000000",
        "broker_name_ar": "XXXXXXX",
        "broker_name_en": "XXXXXXX",
        "email": "[email protected]",
        "mobile_number": "0000000000",
        "office_name_ar": "XXXXXXX",
        "office_name_en": "XXXXXXX",
        "orn": "0000000"
    },
    "sellers": [
        {
            "actual_share_sqm": 0.00,
            "name_ar": "XXXXXXX",
            "name_en": "XXXXXXX",
            "selling_share_sqm": 0.00
        },
        {
            "actual_share_sqm": 0.00,
            "name_ar": "XXXXXXX",
            "name_en": "XXXXXXX",
            "selling_share_sqm": 0.00
        },
        {
            "actual_share_sqm": 0.00,
            "name_ar": "XXXXXXX",
            "name_en": "XXXXXXX",
            "selling_share_sqm": 0.00
        }
    ]
}

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.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!