Weavr
Powered by Redocly

Beneficiaries

Add beneficiaries

Create one or more beneficiaries for the logged-in corporate or consumer identity.

Securityauth_token and api_key
Request
header Parameters
idempotency-ref
string

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Request Body schema: application/json
required
tag
string (Tag) <= 50 characters ^[a-zA-Z0-9_-]+$

The tag field is a custom field that can be used to search and filter.

required
Array of objects (BasicBeneficiary)

The object representing the beneficiaries' details.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/beneficiaries
Request samples
application/json
{
  • "tag": "string",
  • "beneficiaries": [
    ]
}
Response samples
application/json
{
  • "operationBatchId": {
    },
  • "tag": "string",
  • "state": "INITIALISED"
}

Get all beneficiaries

Retrieves the beneficiaries that match the query parameters.

Securityauth_token and api_key
Request
query Parameters
offset
integer <int32> >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limit
integer <int32> [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

batchId
Array of strings unique

Search by the beneficiary batch id.

group
Array of strings unique

Search by the beneficiary group.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/beneficiaries
Request samples 
Response samples 
application/json
{
  • "beneficiaries": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Remove beneficiaries
Removes one or more beneficiaries from the beneficiaries list identified by the id path parameter used in the array.


Securityauth_token and api_key 
Request 
header Parameters
idempotency-ref
string
A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.


 
Request Body schema: application/json
required
beneficiaryIds
required
Array of strings
A list of Beneficiary Ids.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/beneficiaries/remove
Request samples 
application/json
{
  • "beneficiaryIds": [
    ]
}
Response samples 
application/json
{
  • "operationBatchId": {
    },
  • "tag": "string",
  • "state": "INITIALISED"
}
Get a beneficiary
Retrieves a beneficiary identified by the id path parameter


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of a beneficiary.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/beneficiaries/{id}
Request samples 
Response samples 
application/json
{
  • "trustLevel": "TRUSTED",
  • "externalRefs": [
    ],
  • "group": "string",
  • "beneficiaryInformation": {
    },
  • "beneficiaryDetails": {
    },
  • "id": "string",
  • "relatedOperationBatches": [
    ],
  • "state": "INITIALISED",
  • "validationFailure": "INSTRUMENT_DETAILS_NOT_FOUND"
}
Get all beneficiary batches
Retrieves all beneficiary batches matching the query parameters and that belong to the logged-in identity.


Securityauth_token and api_key 
Request 
query Parameters
offset
integer <int32>   >= 0 
The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.


 
limit
integer <int32>   [ 1 .. 100 ] 
The limit of the results for paging, starting at the offset. Limit is always capped at 100.


 
state
Array of strings (BeneficiaryBatchState)   unique 
Items Enum: "INITIALISED" "FAILED" "PENDING_CHALLENGE" "CHALLENGE_FAILED" "CHALLENGE_COMPLETED" "COMPLETED"  
operation
Array of strings (BeneficiaryBatchOperation)   unique 
Items Enum: "CREATE" "REMOVE"  
tag
Array of strings  unique 
Filter by the beneficiary batch tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/beneficiaries/batch
Request samples 
Response samples 
application/json
{
  • "batches": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Get a beneficiary batch
Retrieves the details of a beneficiary batch identified by the batchId path parameter


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of a beneficiary batch.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/beneficiaries/batch/{id}
Request samples 
Response samples 
application/json
{
  • "operationBatchId": {
    },
  • "tag": "string",
  • "state": "INITIALISED"
}
Issue a one-time password to verify a beneficiary batch
Starts the verification process for updating the beneficiaries batch in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint.


You should only start this process if the beneficiary update state is PENDING_CHALLENGE.


Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always "123456".


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Beneficiary Batch Operation.


 
channel
required
string (SCAOtpChannel) 
The unique identifier for the channel.


 Value: "SMS"  
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


405
Method Not Allowed - The request was received but has been rejected for the requested resource.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/beneficiaries/batch/{id}/challenges/otp/{channel}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Verify a beneficiary batch using a one-time password
Completes the verification process for updating the beneficiary batch.


If the outcome of the verification is successful, the beneficiary update batch is executed.


Note that on the Sandbox Environment, text messages are not sent and the verificationCode is always "123456".


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Beneficiary Batch Operation.


 
channel
required
string (SCAOtpChannel) 
The unique identifier for the channel.


 Value: "SMS"  
Request Body schema: application/json
required
verificationCode
required
string (Nonce) ^[0-9]{6}$
The code received by the user on the device.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/beneficiaries/batch/{id}/challenges/otp/{channel}/verify
Request samples 
application/json
{
  • "verificationCode": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Issue a push notification that can be used to verify a beneficiary batch
Starts the verification process for updating a beneficiary batch in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint.


You should only start this process if the beneficiary update operation state is PENDING_CHALLENGE.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Beneficiary Batch Operation.


 
channel
required
string (SCAPushChannel) 
    

  • "AUTHY": The push notification is sent on the user's device using Twilio Authy
    • 

  • "BIOMETRIC": The push notification is sent to the user's device
    • 



 Enum: "AUTHY" "BIOMETRIC"  
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


405
Method Not Allowed - The request was received but has been rejected for the requested resource.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/beneficiaries/batch/{id}/challenges/push/{channel}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
➔ Next to Managed Accounts