---
title: Partner Link API
slug: generic-onboarding/partner-link-api
description: Learn how to access specific realms and flows within a realm using our API. This document outlines the necessary request fields, including authorization token, distributor ID, and application ID. Find a sample request and response inside and reach out for
createdAt: 2023-08-03T07:41:58.521Z
---

## Introduction

The API's objective is to allow partners to gain access to specific realms and flows within a realm. This allows the partner to gain access and use API to create and push applications to the back office for further processing.

## Sample Request

::::Tabs
:::Tab{title="Preproduction"}
```curl
curl --location 'Distributor link URL' \
--header 'Authorization: Token' \
--header 'Content-Type: application/json' \
--data '{
    "distributorId": "64************ca",
    "applicationId": "62**********94"
}'
```
:::
::::

## Request Field Description

| **Key**       | **Required/Optional** | **Data Type** | **Description**                                             |
| ------------- | --------------------- | ------------- | ----------------------------------------------------------- |
| **Header**    |                       |               |                                                             |
| Authorization | Required              | string        | authorization token                                         |
| Content-Type  | Required              | string        | application/json                                            |
| **Body**      |                       |               |                                                             |
| distributorId | Required              | string        | This is a unique identifier of the partner                  |
| applicationId | Required              | string        | This is a realm identifier, to be given by the Signzy team. |

## Sample Response

```json
{
"id": "64********42",
"distributorId": "64********ca",
"applicationId": "62********94"
}
```

## Response Field Description

| **Key**       | **Data Type** | **Description**                                                                        |
| ------------- | ------------- | -------------------------------------------------------------------------------------- |
| id            | string        | This is your access token to be passed into other endpoints as an Authorization header |
| distributorId | string        | This is a unique identifier of the partner                                             |
| applicationId | string        | This is a realm identifier, to be given by the Signzy team.                            |

:::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](#).
:::