Auth Bene

Partner API

POST/v1/partner/beneficiaries/:beneficiaryId/authorize

↓Download Swagger

Lets an approved checker approve or reject a beneficiary created through UI or partner API.

Auth

Header: x-api-key

Use the bank-provisioned partner API key for authentication.

Usage Notes

Header: x-api-key
Checker only
Applies the same approval lifecycle used in the product UI

Request Fields

actorUserIdstringrequired

Approved checker's user ID authorizing the beneficiary.

actionstringrequired

approve or reject.

commentstringoptional

Optional review comment captured with the decision.

POST /v1/partner/beneficiaries/1234567890/authorize
x-api-key: fp_test_51H8xKlMnOpQrStUv
Content-Type: application/json

{
  "actorUserId": "user-1780460729021-815",
  "action": "approve",
  "comment": "Verified beneficiary details"
}

Sample Success Response

{
  "message": "Beneficiary authorization applied"
}

Sample Error Response

{
  "message": "This beneficiary is not waiting for approval"
}