Change Individual User Role

post

https://sandbox-api.transfi.com/v3/role-change/individual

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

targetRole, userId and currencyType plus the fields named in additionalMandatoryFieldNames by POST /v3/role-change/mandatory-fields. The properties below currencyType are illustrative dynamic fields.

targetRole

enum

required

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

Allowed:

userId

string

required

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

currencyType

enum

Defaults to fiat

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

Allowed:

string

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

phone

string

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

phoneCode

string

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

dob

string

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

Headers

MID

string

required

Merchant or sub-merchant MID

Responses

200OK

400Bad Request

404Not Found

409Conflict