Preview

List participant payment assessments

GET
/providers/{providerID}/participants/{participantID}/payment-assessments

List the risk assessments of one participant’s payouts and requests, ordered by assessment time and then assessment ID. Signup and sign-in assessments are not in this list. This response contains no device observations.

participantID accepts the participant ID or your external ID for them.

Returns an empty list when none match. Returns 404 when the participant is not yours.

Moov Money applies every filter before pagination. Pagination is cursor-based. Omit cursor to fetch the first page. Use nextCursor from each response to fetch the next page. The cursor is bound to this provider and this participant. A cursor from another provider or participant returns 400. When you change a filter and send a cursor from the earlier filters, Moov Money returns the first page of the current filters and sets cursorRestarted to true.

Auth: API key or bearer token. Scoped to the calling provider. An affiliated integrator needs the moov-money-payments.read scope granted by the FI.

Request
cURL
curl -X GET https://api.moov.money/providers/{providerID}/participants/{participantID}/payment-assessments \
  -u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
  -H "X-Moov-Version: v2026.10.00"
Responses
200 400 401 403 404
The request completed successfully.
{
  "assessments": [
    {
      "assessedOn": "2026-10-06T15:00:00Z",
      "assessmentID": "ras_01HF5J9ZKQT4RXP8M2VYBN3D",
      "customerEvidence": {
        "signals": [
          {
            "key": "addressRiskLevel",
            "value": "low"
          }
        ]
      },
      "decision": "allow",
      "level": "low",
      "participantID": "3v2whagmwvbujhwbt7v3nl6ffq_user",
      "payment": {
        "amount": {
          "currency": {
            "code": "USD",
            "decimalPlaces": 2,
            "name": "US Dollar",
            "numericCode": "840"
          },
          "value": "100.00"
        },
        "counterparty": {
          "displayName": "Jane Doe",
          "externalID": "C-2077",
          "funding": {
            "createdOn": "2026-09-08T12:00:00Z",
            "disabledOn": "2026-10-08T12:00:00Z",
            "displayName": "Checking",
            "fundingType": "bank_account",
            "last4": "5612",
            "providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
          },
          "participantID": "counterparty-id_user",
          "phoneNumber": "+15555551234"
        },
        "initiator": {
          "displayName": "Jane Smith",
          "externalID": "C-1042",
          "funding": {
            "createdOn": "2026-09-08T12:00:00Z",
            "disabledOn": "2026-10-08T12:00:00Z",
            "displayName": "Checking",
            "fundingType": "bank_account",
            "last4": "5612",
            "providerSourceID": "src_01HF5J9ZKQT4RXP8M2VYBN3D"
          },
          "participantID": "participant-id_user",
          "status": "active",
          "suspended": false
        },
        "paymentID": "pay_01HF5J9ZKQT4RXP8M2VYBN3D",
        "type": "payout"
      },
      "reviewIDs": [
        "prv_01HF5J9ZKQT4RXP8M2VYBN3D"
      ],
      "score": 0,
      "transactionEvidence": {
        "amlLevel": "low",
        "level": "low"
      },
      "trigger": "payout_send"
    }
  ]
}
Malformed request: the body or headers failed validation.
Response body application/problem+json
RFC 9457 Problem Details error body, served as application/problem+json. From v2026.10.00, every error response that has a body uses this schema.

type

string required
URI that tells you which problem occurred. Branch on this value; it never changes. Moov problem types look like https://api.moov.money/errors#<code> (for example invalid-request, idempotency-key-reused, or idempotency-request-in-progress). Treat the value as an opaque constant and do not fetch it. about:blank means the HTTP status code says everything there is to know.

title

string required
Short human-readable name of the problem type. Fixed per type; defaults to the HTTP status text.

status

integer<int32> required
The HTTP status code of this response.

detail

string
Human-readable explanation of this specific occurrence.

instance

string
URI reference that identifies this specific occurrence.

errors

array<object>
The request-body fields that failed validation. Present on validation errors only.
Show child attributes

errors[]

pointer

string required
RFC 6901 JSON Pointer to the field, using the public JSON field names. If the field is missing, the pointer shows where it belongs.

detail

string required
What is wrong with the field.
Authentication missing, invalid, or insufficient.
Authentication present but the action is forbidden for this principal/claim.
The requested resource was not found.

Headers

X-Moov-Version

string
Set this header to the API version being targeted (e.g. v2026.10.00). When omitted, the server applies its default version.

Path parameters

providerID

string required
Your provider account ID.

participantID

string required
The participant’s participantID, or your externalID for them. Both resolve to the same participant.

Query parameters

assessmentID

string
An exact assessment ID. Returns an empty list when no payout or request assessment of this participant has this ID.

paymentID

string
An exact payout ID or request ID. Returns the assessments of that payment. Returns an empty list when the payment is not one of this participant’s.

type

string
Return only assessments of payouts or only assessments of requests. Omit to return both. This selects the payment family. Use trigger to select the activity inside that family.
Possible values: payout, request

decision

array
Return assessments with any of these decisions. Repeat the parameter to select more than one, for example decision=review&decision=deny. Unrecognized values return 400. Omit to return every decision.

trigger

array
Return assessments with any of these triggers. Repeat the parameter to select more than one, for example trigger=payout_send&trigger=request_pay. Unrecognized values return 400. Omit to return every trigger, including assessments with no recorded trigger.

scoreMin

number <double>
Inclusive lower bound on a recorded assessment score, from 0 to 100. Setting this filter excludes results that have no recorded score. A scoreMin that is greater than scoreMax returns 400.

scoreMax

number <double>
Inclusive upper bound on a recorded assessment score, from 0 to 100. Setting this filter excludes results that have no recorded score. A scoreMax that is less than scoreMin returns 400.

scoreBelow

number <double>
Exclusive upper bound on a recorded assessment score, greater than 0 and up to 100. Use it for score bands that share an edge, for example scoreMin=40 and scoreBelow=75. Setting this filter excludes results that have no recorded score. Sending it together with scoreMax, or with a value that is less than or equal to scoreMin, returns 400.

unscored

boolean
true returns only results that have no recorded score. false returns only results that have one. Sending true together with scoreMin, scoreMax, or scoreBelow returns 400.

assessedFrom

string <date-time>
Inclusive lower bound on the assessment time.

assessedTo

string <date-time>
Exclusive upper bound on the assessment time. Returns 400 when it is not later than assessedFrom.

cursor

string
Opaque pagination cursor from a previous response’s nextCursor. Omit to fetch the first page.

limit

integer <int32>
Maximum number of assessments to return. Defaults to 25. Values outside 1-100 return 400.

Response

Response envelope for the risk assessments of a participant’s payouts and requests.

assessments

array<object> required
This page of assessments, ordered by assessment time and then assessment ID.
Show child attributes

assessments[]

assessmentID

string required
Unique system-assigned assessment identifier.

participantID

string
Participant this assessment is about. Omitted when the subject is unknown.

assessedOn

string<date-time> required
When the assessment was recorded.

decision

string<enum> required
Recorded decision.
Possible values: allow, review, deny

level

string<enum>
Recorded level. Omitted when no level was recorded.
Possible values: low, medium, high, very_high

score

number<double>
Recorded score from 0 to 100. A recorded zero is a real score. Omitted when no score was recorded.

reasons

array<string>
Recorded reasons for the decision. Omitted when none were recorded.

customerEvidence

object
Customer signals recorded for this assessment.
Show child attributes

assessments[].customerEvidence

signals

array<object> required
Recorded customer signals.
Show child attributes

assessments[].customerEvidence.signals[]

key

string<enum> required
Signal name from the published set.
Possible values: addressRiskLevel, emailDomainLevel, emailLevel, pepLevel, phoneLevel, sanctionLevel

value

string<enum> required
Recorded level for this signal.
Possible values: low, medium, high, very_high, unknown

transactionEvidence

object
Transaction level and AML level recorded for this assessment.
Show child attributes

assessments[].transactionEvidence

level

string<enum>
Recorded transaction level. Omitted when it was not recorded.
Possible values: low, medium, high, very_high, unknown

amlLevel

string<enum>
Recorded AML level. Omitted when it was not recorded.
Possible values: low, medium, high, very_high, unknown

rules

array<object>
Rules returned with this assessment. Omitted when no rules were returned.
Show child attributes

assessments[].rules[]

ruleID

integer<int32> required
Rule identifier.

name

string required
Rule name.

isLive

boolean required
Whether the rule was live when it was returned.

isAllowlisted

boolean required
Whether the rule was on the allowlist when it was returned.

reviewIDs

array<string>
Reviews linked to this assessment that belong to your provider. Omitted when none are linked.

payment

object required
Payment this assessment is about.
Show child attributes

assessments[].payment

paymentID

string required
The payout ID or the request ID.

type

string<enum> required
Kind of payment.
Possible values: payout, request

amount

object required
Amount and currency of the payment.
Show child attributes

assessments[].payment.amount

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

assessments[].payment.amount.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

decimalPlaces

integer<uint8> required
Number of minor-unit decimal places for code. Required.

numericCode

string
ISO 4217 numeric currency code, if known. Informational only.

name

string
Human-readable currency name, if known. Informational only.

initiator

object required
The participant who started the payment: the sender of a payout or the requester of a request.
Show child attributes

assessments[].payment.initiator

participantID

string required
The initiator’s participant ID.

externalID

string
Your external ID for the initiator.

displayName

string
The initiator’s current name (given + family). Omitted when unknown.

status

string<enum>
The initiator’s current global participant status, read when you fetch the payment. It does not show your suspension. suspended shows it.
Possible values: active, disabled, pending, denied

suspended

boolean
Whether you currently suspend the initiator, read when you fetch the payment. Omitted when not known.

funding

object
The initiator’s instrument for this payment: the funding source a payout sends from, or the funding destination a request pays into. Omitted until the instrument is known.
Show child attributes

assessments[].payment.initiator.funding

fundingType

string<enum> required
Instrument discriminator.
Possible values: card, bank_account

displayName

string
Human-readable display label, such as the account nickname or card brand. Omitted when unknown.

last4

string
Last four digits of the card number for card, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.

providerSourceID

string
The providerSourceID you registered for this funding source. Present only when the instrument is a registered funding source of your participant. Omitted for a payout that sent a provider source token with no registered funding source.

createdOn

string<date-time>
When your participant’s registered funding source was added. Omitted when providerSourceID is omitted.

disabledOn

string<date-time>
When your participant’s registered funding source was removed. Omitted while the source is active, or when providerSourceID is omitted.

counterparty

object required
The other party of the payment: the recipient of a payout or the payer of a request. Fields that are unbound or not known are omitted.
Show child attributes

assessments[].payment.counterparty

displayName

string
Counterparty display name (given + family) when known.

phoneNumber

string
Counterparty phone number in E.164 form when known.

participantID

string
The party’s participant ID, once the party is bound to the payment. Omitted for an unbound party, such as the recipient of an unclaimed payout or the payer of an open request. The ID does not give access to the record of a participant that is not yours.

externalID

string
Your external ID for the party. Present only when the party is your participant.

funding

object
The instrument the party used for this payment. Omitted until the instrument is known.
Show child attributes

assessments[].payment.counterparty.funding

fundingType

string<enum> required
Instrument discriminator.
Possible values: card, bank_account

displayName

string
Human-readable display label, such as the account nickname or card brand. Omitted when unknown.

last4

string
Last four digits of the card number for card, or of the bank account number for bank_account. Omitted when unknown. At most 4 characters.

providerSourceID

string
The providerSourceID you registered for this funding source. Present only when the instrument is a registered funding source of your participant. Omitted for a payout that sent a provider source token with no registered funding source.

createdOn

string<date-time>
When your participant’s registered funding source was added. Omitted when providerSourceID is omitted.

disabledOn

string<date-time>
When your participant’s registered funding source was removed. Omitted while the source is active, or when providerSourceID is omitted.

trigger

string<enum>
The activity that triggered this payout or request assessment. Omitted when it was not recorded.
Possible values: payout_send, payout_accept, request_create, request_pay

nextCursor

string
Opaque cursor for the next page. Absent on the last page.

hasMore

boolean required
Whether another page of results follows this one.

cursorRestarted

boolean
true when Moov Money ignored your cursor because the filters changed, and returned the first page of the current filters. Omitted otherwise.