---
title: Partner Ecosystem
slug: generic-onboarding/partner-ecosystem
description: Learn how to effectively use Signzy's Partner APIs to seamlessly send onboarding user data to your back-office dashboard. This comprehensive document covers the entire workflow and step-by-step process, from distributor creation to merchant data managemen
icon: 📁
docTags: 
createdAt: 2023-07-28T08:56:03.461Z
---

## Overview

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.

## API Workflow

### Step 1: [Partner Creation](docId:2GYOkUKnQyTkVU_GOFmXY)

**End Point:&#x20;**<font color="#2166ae">**'https\://&#x7B;base\_URL\}/api/distributors'**</font>****

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](docId\:Fw1Yrpi1VlWEI6J8aIJYZ)

**End Point:&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributors/login'**</font>

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](docId\:mbbEfMKA6RStOFWX5YHkl)

**End Point:&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributorlink'**</font>

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](docId\:XWe9hPHEfy1dSzaklTxCe)

**End Point:&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/applications/updateDistributorLink'**</font>

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](docId\:A9FwtSEXgO6BokkAYZxjH)

**End Point:&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributors/createMerchant'**</font>

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](docId\:yHfzubAKW99nY8MMes3cY)

**End Point:&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributors/pushMerchant'**</font>****

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](docId\:lHsNzOA1z2Mut_Roku-A3)

**End Point(Pull Details):&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributors/pullMerchant/64ca5a8cc4d83d01453778c7?realmId=62df8e46fa3308fa636ccf94&amp;version=1.1.0'**</font>

**End Point(Callback):&#x20;**<font color="#2166ae">**'https\://**</font><font color="#2166ae">**&#x7B;base\_URL\}**</font><font color="#2166ae">**/api/distributors/callback'**</font>

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:

1. [Partner Pull Details API - Manual data pull](docId\:lHsNzOA1z2Mut_Roku-A3)
2. [Partner Callback API - Automated data push](docId\:MDEdqhqVJmOq_yYVwhQto)

:::hint{type="info"}
### 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 [help@signzy.com](#).
:::