Skip to main content

Get User's Links

This endpoint returns all linked accounts of a user, the user’s account details, as well as the business the account is on.

A Link is a connection between a user’s account on your business and another account on another business. The linked account can belong to the same user or not. Links are necessary for direct charges to be performed via our SDKs or libraries.

Endpoint Get

Path Parameter

NameDescriptionRequiredData type
USER_REFERENCEThe user’s reference — the one returned when the user was indexed.trueString
Sample response
"links": [
"user": {
"name": "Michael Okoh",
"identifier": "trojin",
"identifier_type": "username",
"email": "",
"reference": "the-nothing-the-ghost",
"created_at": "2021-04-17T16:28:18.000000Z",
"updated_at": "2021-05-04T08:37:22.000000Z"
"peer": {
"user": {
"name": "Chike Ononye",
"identifier": "",
"identifier_type": "email",
"email": "",
"reference": "design-wise-design-god",
"created_at": "2021-04-16T05:19:33.000000Z",
"updated_at": "2021-04-16T05:36:07.000000Z"
"business": {
"name": "Thepeer",
"logo": "",
"logo_colour": "#0067FF",
"identifier_type": "email"
"created_at": "2021-06-21T11:55:54.000000Z",
"updated_at": "2021-06-21T11:55:54.000000Z"
  1. user object is the object of the user that initiated the link.
  2. peer object contains the receiving user's object and the respective business' object.
    Don't attempt fetching links for users not on your business, it won't work.