​
Overview

The /company/{companyReferenceId}/externalauthlink endpoint allows you to generate a one-time URL that you can use to link bank accounts.

​
How It Works

1

Obtain an Access Token

First, request an access token by calling the /auth/token endpoint with your ClientId and ClientSecret.

2

Prepare the Company Reference

Identify the target company by its companyReferenceId—this can be either a GUID (CompanyId) or a custom reference string.

3

Submit the Mobile Number

Provide the customer’s MobileNumber (in E.164 format) in the request body.

4

Receive the Auth Link

On success, the API returns a complete ExternalAuthLinkUrl that you can use to link accounts.

​
Endpoint

  • URL:
    https://api.synchpay.com/company/{companyReferenceId}/externalauthlink
  • Method: POST
  • Authorization: Bearer <AccessToken>
    Note: Acquire your access token from /auth/token using your ClientId and ClientSecret.

​
Path Parameter

ParameterTypeDescriptionRequired
companyReferenceIdstringThe company’s unique identifier—either its GUID (CompanyId) or a custom reference string.Yes

​
Request Body

The JSON payload must include:

ParameterTypeDescriptionRequired
MobileNumberstringCustomer’s mobile number in E.164 format (e.g. “+15551234567”).Yes

​
Example Request

{
  "MobileNumber": "+15551234567"
}

​
Response

On success, you’ll receive the following response model:

​
Response Properties

PropertyTypeDescription
externalAuthLinkUrlstringA fully-formed URL that allow for linking bank accounts.

​
Example Response

{
      "externalAuthLinkUrl": "https://app.trysynch.com/ExternalAuth?token=ea123456-7890-abcdef-1234-567890abcdef"
}