Skip to navigation

Get a Consumer Relationship

Returns one authorized-user relationship of an account holder, including removed ones. Requires the api:read or api:profile:read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_external_idstringRequired

The id of the account holder.

relationship_idstringRequired

The id of the relationship, as returned when it was created.

Response

idstringformat: "uuid"

The id of the relationship.

principal_idstringformat: "uuid"

The id of the business, or of the consumer who holds the account, that the relationship belongs to.

principal_typeenum

Whether the principal is a business or a consumer.

Allowed values:
related_consumer_idstringformat: "uuid"

The id of the consumer attached to the principal.

ownership_percentagedouble or null0-100

Share of the business the attached consumer owns, from 0 to 100 with two decimal places. Set for business relationships, null otherwise.

relationship_typeenum or null

What the account holder is to the authorized user. Set for consumer relationships, null otherwise.

Allowed values:
roleenumOptionalRead-only

What the attached consumer is to the principal. A business grants beneficial_owner or control_person; a consumer grants authorized_user.

Allowed values:
statusenumOptionalRead-only

active while the relationship is in effect. Removed relationships stay readable with the status removed.

Allowed values:
created_atstringOptionalRead-onlyformat: "date-time"

Errors

404
Not Found Error
422
Unprocessable Entity Error