Retrieve source of funds
Read submitted source-of-funds records for a user.
GET
Returns the source-of-funds records a customer has submitted, newest first. Records attached to
archived accounts are excluded.
Requires API-key scope
source-of-funds.read. The query is tenant-scoped, so a userid outside
your tenant simply matches nothing.Path parameters
string
required
The customer’s MongoDB ObjectId, as returned by List customers.
Query parameters
string
Return only the most recent record for this account. Without it the endpoint returns every
record for the customer as an array; with it, a single object.
Returns
WithoutaccountId, an array of record objects. With accountId, a single object, or
null when that account has no record.
string
Record identifier.
string
Customer the record belongs to.
string
Account the record was submitted against. Older records may carry
transactionId instead.string
Owning tenant identifier.
string | null
Environment the record lives in.
string[]
Identifiers of the sources on this record that have been approved by a reviewer.
string
ISO 8601 UTC creation timestamp.
string
ISO 8601 UTC last-updated timestamp.
Empty results
A customer with no submitted records returns200 with an empty array — not an error. A customer
whose only records belong to archived accounts returns 404, because after archived records are
filtered out there is nothing left to return.