Skip to main content
POST
/
integrations
/
vertofx
/
beneficiaries
/
link
Link Verto Beneficiary to User
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/integrations/vertofx/beneficiaries/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "beneficiaryId": "<string>",
  "userId": "<string>"
}'
{
  "status": "success",
  "message": "Beneficiary linked successfully"
}
Link Verto Beneficiary to User 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

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Request Body

Request Schema

FieldTypeRequiredDescription
beneficiaryIdstringāœ…ID of the VertoFX beneficiary
userIdstringāœ…ID of the Royalti user

Responses

āœ… 200 - Success

āš ļø 400 - Bad Request

āš ļø 401 - Unauthorized

āš ļø 404 - Not Found

āŒ 500 - Internal Server Error

Tags

VertoFx

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
⌘I