Simple Search by DIN

4 min

Introduction

This document provides detailed information on how to use the API endpoint to add organizations for a patron.

Sample cURL

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	Data Type	Required	Description
patronid	string	Yes	Patron ID
identifier	string	Yes	Company's CIN number
service	string	Yes	ROC service type (Registrar of Companies)
callbackUrl	string	Yes	URL to receive a callback after verification
Accept	string	No	MIME types the client can understand
Accept-Language	string	No	Language preference for the response
Authorization	string	Yes	Access token for authentication
content-type	string	Yes	The format of the request data should be JSON

Sample Response

   {
        "callbackUrl": "...callback...",
        "accessToken": "...accestoken....",
        "id": "....id...",
        "patronId": "....patronid...",
        "identifier": "...identifier...",
        "service": "roc"
    }

Column Name	Data Type	Required	Description
id	string	Yes	The ID was generated for the request.
patronId	string	Yes	The ID of the patron.
identifier	string	Yes	The identifier (company CIN) of the organization.
service	string	Yes	The name of the service (ROC) used.
accessToken	string	Yes	The access token for the request.
callbackUrl	string	Yes	The callback URL to receive the response.