Skip to main content
GET
/
api
/
v1
/
customers
/
{customerId}
/
beneficiaries
/
{id}
Get beneficiary detail
curl --request GET \
  --url http://localhost:45000/api/v1/customers/{customerId}/beneficiaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "customerId": "<string>",
  "country": "<string>",
  "companyName": "<string>",
  "address": "<string>",
  "zipCode": "<string>",
  "currencyCode": "<string>",
  "bankName": "<string>",
  "bankBic": "<string>",
  "bankCountryCode": "<string>",
  "bankAddress": "<string>",
  "accountNumber": "<string>",
  "iban": "<string>",
  "wireRoutingNumber": "<string>",
  "achRoutingNumber": "<string>",
  "intermediaryBank": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "screening": {
    "screeningSubjectId": "<string>",
    "paymentHold": true,
    "openMatchCount": 0,
    "lastScreenedAt": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Nuvera API application secret key

Authorization
string
header
required

RS256 per-request signed JWT

Path Parameters

customerId
string
required
id
string
required

Response

default - application/json
id
string
required
customerId
string
required
country
string
required
companyName
string
required
address
string
required
zipCode
string
required
currencyCode
string
required
bankName
string
required
bankBic
string
required
bankCountryCode
string
required
bankAddress
string
required
accountNumber
string | null
required
iban
string | null
required
wireRoutingNumber
string | null
required
achRoutingNumber
string | null
required
intermediaryBank
string | null
required
status
string
required
createdAt
string
required
updatedAt
string
required
screening
object