Singapore UEN Extraction and Fetch

Introduction

The UEN Extraction and Fetch API endpoint extracts the UEN (Unique Entity Number) from the provided image file and fetches the associated information of the entity from the government database. This API is used to extract the entity information from Singapore.

Sample cURL Request

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../foreignidentitiesextractions \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"uenExtractionAndFetch","essentials":{"files":"...files.."}}}'

Parameter	Description	Type	Value
task	Specifies the type of task to be performed	String	Compulsory. Example: "uenExtractionAndFetch"
essentials	The input file or files that needs to be processed	Object	Compulsory
files	The URLs of the image files containing the UEN to be extracted and fetched	Array	Compulsory. Example: ["...url of image file..."]

Sample API Response

    "result": {
        "uen": "...uen...",
        "issuanceAgencyId": "...issuanceAgencyId...",
        "uenStatus": "...uenStatus...",
        "entityName": "...entityName...",
        "entityType": "...entityType...",
        "uenIssueDate": "...uenIssueDate...",
        "regStreetName": "...regStreetName...",
        "regPostalCode": "...regPostalCode..."
    }

Parameter	Description	Type	Value
uen	Unique Entity Number of the organization	String	Response Parameter. Example: "...uen..."
issuanceAgencyId	Issuance agency ID of the organization	String	Response Parameter. Example: "...issuanceAgencyId..."
uenStatus	Status of the UEN	String	Response Parameter. Example: "...uenStatus..."
entityName	Name of the organization	String	Response Parameter. Example: "...entityName..."
entityType	Type of organization	String	Response Parameter. Example: "...entityType..."
uenIssueDate	Date when the UEN was issued in YYYY-MM-DD format	String	Response Parameter. Example: "...uenIssueDate..."
regStreetName	Street name of the organization's registered address	String	Response Parameter. Example: "...regStreetName..."
regPostalCode	Postal code of the organization's registered address	String	Response Parameter. Example: "...regPostalCode..."