Exchange public token

This endpoint will change the temporary publicToken that you receive from the Link flow for a valid connectionToken that is permanent and can be used to retrieve connection information. A connection is not considered "active" until its publicToken is exchanged.

Exchange public token for connection token

Exchanges public token for connection token from an app

POSThttps://api.finlink.vumi.io/api/v1/commands/connections/exchange/{publicToken}

Authorization

bearerAuth

Path parameters

publicToken*string (uuid)

Public token pending to convert

Response

200401404500

Successfully exchanged public token for connection token

Body

application/json

connectionTokenstring

Alphanumeric unique identifier of length 10 for the connection.

Example: "AAAAA11111"

Request

JavaScriptCurlPython

const response = await fetch('https://api.finlink.vumi.io/api/v1/commands/connections/exchange/{publicToken}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "connectionToken": "AAAAA11111"
}