Rescore a Beneficiary

Ask the Anton Engine for a fresh Payee-pillar risk evaluation of this beneficiary now, instead of waiting for the next scheduled cadence. Synchronous: on success the response carries the new and previous risk scores (0–1000 integers, higher is ALWAYS worse) and tiers.

Not the same as POST /v1/beneficiaries/{id}/rescreen, which runs compliance screening (sanctions/PEP) rather than risk scoring.

Requires an Idempotency-Key header.

POST

beneficiaries

{id}

rescore

Rescore a beneficiary

curl --request POST \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/rescore \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>'
  }
};

fetch('https://api.antonpayments.com/v1/beneficiaries/{id}/rescore', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.antonpayments.com/v1/beneficiaries/{id}/rescore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/beneficiaries/{id}/rescore"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "pillar": "payee",
    "resource_id": "<string>",
    "new_evaluation_id": "<string>",
    "new_risk_score": 500,
    "new_tier": "CRITICAL",
    "previous_evaluation_id": "<string>",
    "previous_risk_score": 500,
    "previous_tier": "CRITICAL"
  }
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Headers

Idempotency-Key

string

required

Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.

Maximum string length: 255

Path Parameters

string

required

Pattern: ^ben_[a-zA-Z0-9]+$

Response

Rescore complete.

data

object

required

Result of a manual Payee-pillar rescore. Scores are 0–1000 integers where higher is ALWAYS worse — the same orientation as risk_score on the beneficiary resource. The previous_* fields are absent when the engine had no prior evaluation on record.

Show child attributes

⌘I

Rescore a beneficiary

curl --request POST \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/rescore \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>'
  }
};

fetch('https://api.antonpayments.com/v1/beneficiaries/{id}/rescore', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.antonpayments.com/v1/beneficiaries/{id}/rescore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/beneficiaries/{id}/rescore"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "pillar": "payee",
    "resource_id": "<string>",
    "new_evaluation_id": "<string>",
    "new_risk_score": 500,
    "new_tier": "CRITICAL",
    "previous_evaluation_id": "<string>",
    "previous_risk_score": 500,
    "previous_tier": "CRITICAL"
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Rescore a Beneficiary

Authorizations

Headers

Path Parameters

Response