Fetch details with UEN

Introduction

The uenFetch API allows users to fetch entity information using UEN number. This API can be used to fetch information about the company such as the company name.

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":"uenFetch","essentials":{"uen":"...uen.."}}}'

Parameter	Description	Type	Value
task	The type of extraction to be performed.	String	Compulsory. Example: uenFetch
essentials	The input data required for UEN extraction.	Object	Compulsory.
uen	The UEN number to be extracted.	String	Compulsory. Example: "...uen..."

Sample API Response



    // Expected 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	String	Response parameter. Example: "...uen..."
issuanceAgencyId	Issuing agency ID of the UEN	String	Response parameter. Example: "...issuanceAgencyId..."
uenStatus	Status of the UEN	String	Response parameter. Example: "...uenStatus..."
entityName	Name of the Entity	String	Response parameter. Example: "...entityName..."
entityType	Type of the Entity	String	Response parameter. Example: "...entityType..."
uenIssueDate	Date of UEN issuance	String	Response parameter. Example: "...uenIssueDate..."
regStreetName	Street name of the registered address	String	Response parameter. Example: "...regStreetName..."
regPostalCode	Postal code of the registered address	String	Response parameter. Example: "...regPostalCode..."