Skip to main content
POST
/
transactions
/
recipients
/
check
Check recipient risk
curl --request POST \
  --url https://api.txcloud.io/v1/transactions/recipients/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "value": "<string>",
  "sender_user_id": "<string>"
}
'
{
  "id": "<string>",
  "risk_score": 123,
  "risk_level": "<string>",
  "relationship": {},
  "flags": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
type
string
required
value
string
required
sender_user_id
string

Response

200 - application/json

Recipient check result

id
string
risk_score
integer
risk_level
string
relationship
object
flags
string[]