Global Utility Get Providers API
Introduction
API allows developers to integrate Signzy's services into their own applications, enabling secure and efficient identity verification processes.This particular API endpoint allows users to retrieve a list of service providers for a specific country and provider name. The request must include the patron ID, access token, provider name, and country information in order to successfully retrieve the requested data.
Sample CURL
curl --request POST \
--url https://signzy.tech/api/v2/patrons/..your-patron-id../globalutilities \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"task":"getProviders","essentials":{"providerName":"...providerName...","country":"...country..."}}'Parameter | Type | Required | Description |
|---|---|---|---|
URL | string | Yes | The URL of the API endpoint, which includes the patron ID. |
Accept | string | Yes | The accepted MIME type of the response. In this case, */* is used to accept any type. |
Accept-Language | string | Yes | The preferred language for the response. In this example, en-US,en;q=0.8 indicates that English (United States) is preferred, but other English language variants can also be used. |
Authorization | string | Yes | The access token for authentication. |
Content-type | string | Yes | The format of the request payload. In this case, it is JSON. |
task | string | Yes | Specifies the task to be performed by the API. In this case, the task is to retrieve information about providers. |
providerName | string | Yes | The name of the provider whose information is to be retrieved. |
country | string | Yes | The country for which provider information is to be retrieved. |
The Supported Country Codes are listed below
COUNTRY NAME | COUNTRY CODE |
|---|---|
United States of America | USA |
Italy | ITA |
Canada | CAN |
Spain | ESP |
India | IND |
United Kingdom | GBR |
Argentina | ARG |
France | FRA |
Switzerland | CHE |
Bahamas | BHS |
Denmark | DNK |
Gibraltar | BRA |
Japan | JPN |
South Africa | ZAF |
Mexico | MEX |
Greece | GRC |
Slovenia | SVN |
New Zealand | NZL |
Ireland | IRL |
Germany | DEU |
Belgium | BEL |
Netherlands | NLD |
Australia | AUS |
Colombia | COL |
Romania | ROU |
Ecuador | ECU |
Portugal | PRT |
Sweden | SWE |
Finland | FIN |
Norway | NOR |
Czech Republic | CZE |
Austria | AUT |
Malaysia | MYS |
Poland | POL |
Ireland | IRL |
Singapore | SGP |
Sample API Response
{
"result": {
"providers": [
{
"providerId": "..proverId..",
"providerName": "..providerName..",
"country": "..3 character country code",
"serviceType": [
"Electric", "Telecom" ...
],
"requiredFields": [
"username",
"password"
]
}
]
}
}Parameter | Description |
|---|---|
providerId | The unique identifier for the provider. |
providerName | The name of the provider. |
country | The three-character country code for the country where the provider is located. |
serviceType | The type of services provided by the provider. This can include Electric, Telecom, or other services. |
requiredFields | An array of strings representing the required fields to access the provider's services. This can include fields such as username, password, and others. |