List beneficial owners

GET

entities

{entityId}

beneficial-owners

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://api.melio.com/v2/entities/{entityId}/beneficial-owners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/entities/{entityId}/beneficial-owners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

package main

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

func main() {

	url := "https://api.melio.com/v2/entities/{entityId}/beneficial-owners"

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

	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "2023-12-25",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "line2": "<string>",
        "state": "<string>"
      },
      "usResident": true,
      "hasIdentityDocument": true,
      "types": [
        "ubo"
      ],
      "ownershipPercentage": 123,
      "jobTitle": "chief-executive-officer",
      "taxInfo": {
        "type": "ssn",
        "identifierLast4": "<string>"
      },
      "internationalIdType": "passport",
      "internationalId": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

api-key

string

header

required

Path Parameters

entityId

string

required

Response

The business's beneficial owners. Empty until any are recorded.

data

object[]

required

Hide child attributes

data.id

integer

required

data.firstName

string

required

data.lastName

string

required

data.dateOfBirth

string<date>

required

data.address

object

required

A counterparty address outside the US. Unlike Address, state is free-form (most countries have no state; send an empty string or omit it) and postalCode is not a US ZIP. countryCode is required and must not be US — a US-domiciled counterparty belongs on a domestic account type.

Hide child attributes

data.address.line1

string

required

Street address. Must be a real street address, not a PO box.

data.address.city

string

required

data.address.postalCode

string

required

data.address.countryCode

string

required

Two-letter ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Za-z]{2}$

data.address.line2

string

data.address.state

string

State, province or region. Optional — send an empty string where the country has none.

data.usResident

boolean

required

data.hasIdentityDocument

boolean

required

Whether a government ID is on file for this person. The document itself cannot be read back through this API.

data.types

enum<string>[]

required

The role a person holds in the business. ubo is an ultimate beneficial owner (someone with a material ownership stake), director is a control person, and fx-account-holder is the individual who acts for the business on its international (FX) payments. One person may hold several roles; exactly one person must be the fx-account-holder.

Available options:

ubo,

director,

fx-account-holder

data.ownershipPercentage

number

Decimal share (0.25 = 25%)

data.jobTitle

enum<string>

Available options:

chief-executive-officer,

chief-financial-officer,

managing-member,

general-partner,

president,

vice-president,

treasurer

data.taxInfo

object

Hide child attributes

data.taxInfo.type

enum<string>

Available options:

ssn,

itin

data.taxInfo.identifierLast4

string

data.internationalIdType

enum<string>

Available options:

passport,

driver-license,

national-id

data.internationalId

string

Last four characters of the identifier on file

data.email

string

data.phoneNumber

string

data.createdAt

string<date-time>

data.updatedAt

string<date-time>

List beneficial owners

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://api.melio.com/v2/entities/{entityId}/beneficial-owners', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.melio.com/v2/entities/{entityId}/beneficial-owners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

package main

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

func main() {

	url := "https://api.melio.com/v2/entities/{entityId}/beneficial-owners"

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

	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "2023-12-25",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "line2": "<string>",
        "state": "<string>"
      },
      "usResident": true,
      "hasIdentityDocument": true,
      "types": [
        "ubo"
      ],
      "ownershipPercentage": 123,
      "jobTitle": "chief-executive-officer",
      "taxInfo": {
        "type": "ssn",
        "identifierLast4": "<string>"
      },
      "internationalIdType": "passport",
      "internationalId": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "<string>",
    "details": {}
  }
}

Entities

Accounts

Attachments

Payments

Tools

Authorizations

Path Parameters

Response