Approvers

Initiate an end-user custodial challenge for an approver

Changed on

Initiates an email challenge to validate the action of an approver. This endpoint should only be used in end-user custodial payout flows.

post/api/approvers/end-user-custodial/initiate-challenge

Request

Headers

on-behalf-ofstring required

Organization ID to act on behalf of

Request body

approverIdstring required

Identifier of the Approver who should receive the email challenge

publicKeystring required

The public key to associate with the email authentication. You can get this from the EndUserCustodialSDK.getPublicKey() method.

Example request

{
  "approverId": "user123",
  "publicKey": "04a82bfb0edb13d..."
}

Response

Challenge initiated successfully

authenticatorIdstring required

The id needed to create an EndUserCustodialSDK session

Example response

{
  "authenticatorId": "auth_1234567890abcdef"
}

Changes

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the non-success response with the status