Partner Ecosystem
This document aims to provide relevant information for calling Signzy's Partner APIs. This API set facilitates the sending of onboarding user data to Signzy's back-office (backops) dashboard. This document will help you with detailed information about every component involved in this process, followed by sample JSON requests and responses.
Step 1: Partner Creation
End Point: 'https://backops-go-preproduction.signzy.app/api/distributors'
This API is used to create the credentials for the partner and generate the access token to make further API calls.
Step 2: Log in
End Point: 'https://go-preproduction.signzy.app/api/distributors/login'
The user logs in to the partner ecosystem with valid credentials (username and password) given to him/her. This API call generates an authorization token in response, which is used as an access token for subsequent API calls.
Step 3: Linking the Partner
End Point: 'https://go-preproduction.signzy.app/api/distributorlink'
This allows partners to gain access to specific realms and flows within that realm so that applications for those flows can be pushed to Signzy's back office.
Step 4: Assigning Flows to Partners
End Point: 'https://go-preproduction.signzy.app/api/applications/updateDistributorLink'
The partner Assign Flow API is an API within Signzy's partner ecosystem, which is used to allocate specific flow(s) to the partner.
Step 5: Creating a Merchant
End Point: 'https://go-preproduction.signzy.app/api/distributors/createMerchant'
The API is used to create an application instance within our platform and this is created within a realm for a particular flow. The API response will provide an identification of the application within the realm. (The response contains the "merchant id" and "signzyAppId" which can be used as a unique identifier of the application within the platform.)
Step 6: Sending User Data
End Point: 'https://go-preproduction.signzy.app/api/distributors/pushMerchant'
After the user data is collected, it is pushed into the Signzy back office dashboard. This endpoint stores the results according to the merchant's data. This API call should be made after the merchant has finished onboarding.
Step 7: Pull Data
End Point(Pull Details): 'https://go-preproduction.signzy.app/api/distributors/pullMerchant/64ca5a8cc4d83d01453778c7?realmId=62df8e46fa3308fa636ccf94&version=1.1.0'
End Point(Callback): 'https://go-preproduction.signzy.app/api/distributors/callback'
If a client wants to get the data for a specific customer, then call this API with the application ID that was generated in the create API. This can be done in two ways:
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].