Search By Name API
Introduction
The API described in this document allows you to create a new organization associated with a specific patron on the Signzy platform. The API supports POST method and requires a valid Access Token for authorization. The organization's details should be provided in JSON format, which includes the company's identifier (CIN), the service required, and a callback URL for receiving responses.
Sample cURL Request
curl --request POST \
--url https://signzy.tech/api/v2/patrons/...patronid..../organizations \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"identifier":"...companycin...","service":"roc","callbackUrl":"...call URL..."}'Parameter | Type | Required | Description |
|---|---|---|---|
patronid | string | Yes | The ID of the patron associated with the organization. |
Access-Token | string | Yes | The authorization token for accessing the API. |
identifier | string | Yes | The company's identifier (CIN). |
service | string | Yes | The service required by the organization. |
callbackUrl | string | Yes | The URL where the responses will be received. |
Sample API Response
{
"callbackUrl": "...callback...",
"accessToken": "...accestoken....",
"id": "....id...",
"patronId": "....patronid...",
"identifier": "...identifier...",
"service": "roc"
}
Sample cURL (HUNT)
curl --request POST \
--url https://signzy.tech/api/v2/hunts \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'content-type: application/json' \
--data '{"target":"Organization","itemId":"....id-of-the-organization-object-created.....","accessToken":"....accessToken-of-the-organization-object-created.....","task":"searchCompaniesByName","essentials":{"name":"...name..."}}'Name | Description | Required | Example |
|---|---|---|---|
target | The type of target object to search for. | Yes | "Organization" |
itemId | The ID of the organization object created. | Yes | "123456" |
accessToken | The access token of the organization object created. | Yes | "abc123" |
task | The task to be performed. | Yes | "searchCompaniesByName" |
essentials | The essential parameters required for performing the task. | Yes | {"name": "ACME Corporation"} |
Accept | The media types that are acceptable for the response. | No | "*/*" |
Accept-Language | The preferred natural language for the response. | No | "en-US,en;q=0.8" |
Content-Type | The media type of the request body. | Yes | "application/json" |
Sample Response (HUNT)
{
"message": "Results found for the combination of inputs./ Results not found for the combination of inputs.",
"companiesList": [
{
"companyName": "....company name....",
"companyID": "....company id...."
}
]
}Parameter Name | Type | Description |
|---|---|---|
message | string | Indicates whether results were found for the given inputs. |
companiesList | array | List of objects containing information about the companies. |
companyName | string | Name of the company. |
companyID | string | Unique identifier of the company. |