TRtransfi
Role Change

Change Individual User Role

Changed on

Step 2 of the role change flow, for users created as individuals. Grants the user the additional role targetRole - for example promoting an individual recipient to a sender. Call POST /v3/role-change/mandatory-fields first and send the fields it names. Use POST /v3/role-change/business for users created as organizations.

post/v3/role-change/individual

Request

Headers

MIDstring required

Merchant or sub-merchant MID

Request body

targetRole'recipient' | 'sender' required

Role the user should additionally hold. Must match the targetRole used in step 1.

userIdstring required

TransFi user id of the existing individual user. Must start with UX-.

currencyType'crypto' | 'fiat'

Currency rail the user will transact on in the new role. Defaults to fiat. Must match the currencyType used in step 1.

emailstring

Illustrative dynamic field. Send a valid email address when additionalMandatoryFieldNames contains email; a new address triggers an email verification link.

phonestring

Illustrative dynamic field. Send it when additionalMandatoryFieldNames contains phone, always together with phoneCode.

phoneCodestring

International dialling code for phone. 1-4 characters including an optional leading +, for example +91. Must be sent together with phone.

dobstring

Illustrative dynamic field. Send it when additionalMandatoryFieldNames contains dob, in the format stated by that field's validationMessage.

Example request

{
  "targetRole": "sender",
  "userId": "UX-260326115551596837",
  "currencyType": "fiat",
  "email": "john.doe@example.com",
  "phone": "9876543210",
  "phoneCode": "+91",
  "dob": "21-08-1994"
}

Response

OK

statusstring required
traceIdstring

Changes