Skip to main content
POST
/
beneficial-owners
/
{id}
cURL
POST https://api-sandbox.dwolla.com/beneficial-owners/07d59716-ef22-4fe6-98e8-f3190233dfb8
Content-Type: application/vnd.dwolla.v1.hal+json
Accept: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY

{
  "firstName": "beneficial",
  "lastName": "owner",
  "ssn": "123-54-6789",
  "dateOfBirth": "1963-11-11",
  "address": {
    "address1": "123 Main St.",
    "address2": "Apt 123",
    "city": "Des Moines",
    "stateProvinceRegion": "IA",
    "country": "US",
    "postalCode": "50309"
  }
}
{
  "_links": {},
  "id": "d3d6b41e-5567-4bc6-9c6e-0efd0a3e647e",
  "firstName": "John",
  "lastName": "Doe",
  "address": {
    "address1": "462 Main Street",
    "city": "Des Moines",
    "country": "USA",
    "stateProvinceRegion": "IA",
    "address2": "Suite 123",
    "address3": "Unit 123",
    "postalCode": "50309"
  },
  "verificationStatus": "verified",
  "created": "2022-07-23T00:18:21.419Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Accept
enum<string>
default:application/vnd.dwolla.v1.hal+json
required

The media type of the response. Must be application/vnd.dwolla.v1.hal+json

Available options:
application/vnd.dwolla.v1.hal+json

Path Parameters

​
id
string
required

Beneficial owner unique identifier

Body

application/json

Parameters for updating a beneficial owner

Create a US Beneficial Owner (identified by SSN). For US-based beneficial owners only. Use SSN for identity verification instead of passport.

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Doe"

​
dateOfBirth
string
required
Example:

"1980-01-31"

​
address
InternationalAddress · object
required
​
ssn
string
required
Example:

"123456789"

Response

successful operation

Request body model for a Beneficial Owner

​
_links
object
required
​
id
string
required
Example:

"d3d6b41e-5567-4bc6-9c6e-0efd0a3e647e"

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Doe"

​
address
InternationalAddress · object
required
​
verificationStatus
enum<string>
required
Available options:
verified,
document,
incomplete
Example:

"verified"

​
created
string<date-time>
required
Example:

"2022-07-23T00:18:21.419Z"