Retrieve owner

Browse API reference

GET/owners/{ownerId}getOwner

Use this method to retrieve details about an owner of a processing account or an owner associated with a funding recipient.

To retrieve an owner, you need their ownerId. Our gateway returned the ownerId in the response of the Create Processing Account method or the Create Funding Recipient Owner method.

Note: If you don't have the ownerId, use the Retrieve Processing Account method if you are searching for a processing account owner, or use the List Funding Recipient Owners method if you are searching for a funding recipient owner.

Our gateway returns the following information about an owner:

Name, date of birth, and address.
Contact details, including their email address.
Relationship to the business, including whether they are a control prong or authorized signatory, and their equity stake in the business.

Parameters

Name	In	Type	Description
`ownerId`Required	path	`integer`	Unique identifier that we assigned to the owner.

Responses

Successful request. Returns the requested owner.

200 OK · application/json

{
  "address": {
    "address1": "1 Example Ave.",
    "address2": "Example Address Line 2",
    "address3": "Example Address Line 3",
    "city": "Chicago",
    "country": "US",
    "postalCode": "60056",
    "state": "Illinois"
  },
  "contactMethods": [
    {
      "type": "email",
      "value": "jane.doe@example.com"
    }
  ],
  "dateOfBirth": "1964-03-22",
  "firstName": "Jane",
  "identifiers": [
    {
      "type": "nationalId",
      "value": "xxxxx4320"
    }
  ],
  "lastName": "Doe",
  "middleName": "Helen",
  "ownerId": 4564,
  "relationship": {
    "equityPercentage": 48.5,
    "isAuthorizedSignatory": false,
    "isControlProng": true,
    "title": "CFO"
  }
}

Response schema · 34 fields

addressobjectrequired
Object that contains information about the address.
- address1stringrequired
  Address line 1.≤ 150 chars
- address2string
  Address line 2.≤ 150 chars
- address3string
  Address line 3.≤ 150 chars
- citystringrequired
  City.≤ 50 chars
- countrystringrequired
  Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
- postalCodestringrequired
  Zip code or postal code.≤ 10 chars
- statestringrequired
  Name of the state or state abbreviation.≤ 50 chars
contactMethodsobject[]required
Array of polymorphic objects, which contain contact information. Note: If you are adding information about an owner, you must provide at least an email address. If you are adding information about a contact, you must provide at least a contact number. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number1–4 items
- emailobject
  - typestringrequired
    Type of contact method.email
  - valuestringrequired
    Email address.≤ 50 chars
- phoneobject
  - typestringrequired
    Type of contact method.phone
  - valuestringrequired
    Phone number.≤ 15 chars
- mobileobject
  - typestringrequired
    Type of contact method.mobile
  - valuestringrequired
    Mobile number.≤ 15 chars
- faxobject
  - typestringrequired
    Type of contact method.fax
  - valuestringrequired
    Fax number.≤ 15 chars
dateOfBirthstringdaterequired
Owner's date of birth. The format of this value is YYYY-MM-DD.
firstNamestringrequired
Owner's first name.≤ 50 chars
identifiersobject[]required
Array of IDs.≥ 1 items
- typestringrequired
  Type of ID provided to verify identity.nationalId
- valuestringrequired
  Social Security Number (SSN) or Social Insurance Number (SIN).
lastNamestringrequired
Owner's last name.≤ 50 chars
middleNamestring
Owner's middle name.≤ 50 chars
ownerIdinteger
Unique identifier that we assigned to the owner.
relationshipobjectrequired
Object that contains information about the owner's relationship to the business.
- equityPercentagenumberpercentage
  Percentage equity stake that the owner holds in the business.
- isAuthorizedSignatoryboolean
  Indicates if the owner is an authorized signatory.
- isControlProngbooleanrequired
  Indicates if the owner is a control prong. You can identify only one control prong for a business.
- titlestring
  Owner's job title.

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

delete-an-owner update-an-owner