Skip to main content
POST
/
usermanagement
/
new-beneficiary
Create Beneficiary
curl --request POST \
  --url https://{tenant}.fincode.software/api/v6/services/usermanagement/new-beneficiary \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <x-auth-token>' \
  --header 'platform: <platform>' \
  --header 'uuid: <uuid>' \
  --data '
{
  "senderCode": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "beneficiaryName": "<string>",
  "type": "INDIVIDUAL",
  "phone": "<string>",
  "address": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.fincode.technology/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint creates a new beneficiary profile. For Bank Transfers, this is typically called after validating the bank account details.

Headers

​
platform
string
default:fincode
required
​
uuid
string
default:200
required
​
X-Auth-Token
string
required

Body

application/json
​
senderCode
string
required
​
firstName
string
required
​
lastName
string
required
​
beneficiaryName
string
required
​
type
string
default:INDIVIDUAL
​
phone
string
​
address
object

Response

200

Beneficiary created