curl --request POST \
--url https://api.next.orenda.finance/v1/access-management/invite/guardian \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-program-id: <api-key>' \
--data '
{
"email": "guardian@acme.example.com",
"firstName": "Grace",
"lastName": "Hopper"
}
'{
"success": true,
"data": {
"message": "Guardian invitation processed successfully"
}
}{
"success": false,
"code": "<string>",
"message": "<string>"
}{
"success": false,
"code": "<string>",
"message": "<string>"
}{
"success": false,
"code": "<string>",
"message": "<string>"
}Invite a guardian
Invites a guardian corporate from the back-office.
A back-office admin sends the guardian contact’s email, firstName, and lastName; the remaining identity fields (dob, nationality, phone, address) are optional and, when supplied, seed the guardian’s onboarding record. On success the guardian is created and an invitation is dispatched.
Authenticated with the operator’s bearer token plus the x-program-id header, exactly like the other access-management admin/invite endpoints.
Errors: an invalid body (missing required field, malformed email/phone, or country not ISO 3166-1 alpha-3) returns 400; inviting a contact that already exists returns 409.
curl --request POST \
--url https://api.next.orenda.finance/v1/access-management/invite/guardian \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-program-id: <api-key>' \
--data '
{
"email": "guardian@acme.example.com",
"firstName": "Grace",
"lastName": "Hopper"
}
'{
"success": true,
"data": {
"message": "Guardian invitation processed successfully"
}
}{
"success": false,
"code": "<string>",
"message": "<string>"
}{
"success": false,
"code": "<string>",
"message": "<string>"
}{
"success": false,
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The program the request acts on.
Body
Sent by a back-office admin to invite a guardian corporate. email, firstName, and lastName are required; the remaining identity fields are optional and seed the guardian's onboarding record when supplied.
The guardian contact's email address. The invitation is sent here.
The guardian contact's first (given) name.
The guardian contact's last (family) name.
Date of birth (YYYY-MM-DD). Optional.
Nationality. Optional.
Contact phone number in international format (optional leading +, 7–15 digits). Optional.
^\+?[0-9]{7,15}$Postal address of the guardian contact. Optional.
Show child attributes
Show child attributes