Get Providers API

8 min

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.

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

Make sure you replace ..your-patron-id.. in the URL with the patronId that you receive from the login call and also make sure you pass in all the necessary input parameters in the correct format.

Sample CURL

Preproduction

Production

curl --request POST \
  --url https://preproduction.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..."
            }
    }'

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
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.

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.statusCode	Request Status code from Signzy
error.name	the name of the error
error.message	the error message
type	type of the error

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter or not a valid one.
401	Authorization Failed	Authorization token is invalid.
500	Internal Server Error	Internal error at Signzy, please contact support.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].