Authorize, Reject or Flag

Guide on rejecting or authorizing transfers via API, including authorization, rejection, and flagging processes.

Rejecting or Authorizing a Transfer

Transfers can be automatically rejected or authorized based on Policies. You can also manage this via the API:

Use the following endpoints to authorize a transfer:

{{url}}/entity/:entityDID/tx/:tx/authorize

{{url}}/entity/:entityDID/tx/:tx/authorize?ignoreFlags=true

{{url}}/entity/:entityDID/tx/:tx/authorize?force=true

  • ignoreFlags=true: Authorize despite existing flags. This may register as a request for authorization if policies are pending.
  • force=true: Authorize despite flags and unfulfilled policies.

Example:

curl --location 'https://notabene-d-qa-api.notabene.studio/entities/did:web:entity.id:MegaVASP/tx/8431e1dd-7349-48f1-9812-d874dde22e06/authorize' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \

Optionally, add a SettlementAddress if needed:

{
    "settlement_address": "bip122:000000000019d6689c085ae165831e93:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}

To reject a transfer, use:

{{url}}/entity/:entityDID/tx/:tx/reject

Refer to the postman collection.

Example:

curl --location '{{nodeURL}}/entities/did:web:entity.id:NewBeneficiaryVASP/tx/8431e1dd-7349-48f1-9812-d874dde22e06/reject' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"reason": "BLOCKCHAIN_RISK_SCORE",
"comment": "my comment"

}'

Provide a reason and optional comment:

{
    "reason": "other", 
    "comment": "my comment"
}

Reason Codes: COUNTERPARTY_RISK, COUNTERPARTY_DUE_DILIGENCE, BLOCKCHAIN_RISK_SCORE, SANCTION_SCREENING, ASSET_TYPE, SUSPICIOUS_TRANSACTION, COUNTERPARTY_POLICIES, COUNTERPARTY_REJECTED, COUNTERPARTY_NO_RESPONSE, CANCELED_BY_INITIATOR, REMOVED_FROM_TRANSFER, TRANSFER_PARTICIPANT, SOURCE_ADDRESS, BENEFICIARY_ADDRESS, BENEFICIARY_NOT_FOUND, ORIGINATOR_REJECT_OUTGOING, BENEFICIARY_REJECT_INCOMING, COMPLIANCE_POLICIES, OTHER.


Flag

To flag a transfer for compliance review:

{{url}}/entity/:entityDID/tx/:tx/flag

Example:

curl --location '{{nodeURL}}/vasp/did:web:vasps.id:NewBeneficiaryVASP/tx/8431e1dd-7349-48f1-9812-d874dde22e06/flag' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
}'


What’s Next

Did this page help you?