Skip to main content
POST
/
integrations
/
vertofx
/
beneficiaries
/
link
Link Verto Beneficiary to User
curl --request POST \
  --url https://api.royalti.io/integrations/vertofx/beneficiaries/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "beneficiaryId": "<string>",
  "userId": "<string>"
}
'
{
  "status": "success",
  "message": "Beneficiary linked successfully"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Description:
The /integrations/vertofx/beneficiaries/link endpoint links a VertoFX beneficiary to a Royalti user. Method: POST Request Payload:
ParameterTypeDescription
beneficiaryIdstringID of the VertoFX beneficiary
userIdstringID of the Royalti user

​
Code Examples

const response = await fetch('https://api.royalti.io/integrations/vertofx/beneficiaries/link', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "beneficiaryId": "sample-beneficiaryId",
    "userId": "sample-userId"
  })
});

const data = await response.json();
console.log(data);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
​
beneficiaryId
string
required

ID of the VertoFX beneficiary

​
userId
string
required

ID of the Royalti user

Response

Success

​
status
string
​
message
string