Types

Integer

Any integer value.

String

Any string value.

Object

An object.

UUID

A string value which is a valid UUID. UUID fields are typically referring to the IDs of other objects in the system. See more about UUID’s here: https://en.wikipedia.org/wiki/Universally_unique_identifier

AddressRelationship

AddressRelationship represents a link to an Address

Key	Value	Required	Notes
type	addresses	√
id	UUID	√

ApplicationRelationship

ApplicationRelationship represents a link to an Application

Key	Value	Required	Notes
type	applications	√
id	UUID	√

AchBatchEntryRelationship

AchBatchEntryRelationship represents a link to an ACH Batch Entry

Key	Value	Required	Notes
type	ach-batch-entries	√
id	UUID	√

EmailAddressRelationship

EmailAddressRelationship represents a link to an EmailAddress

Key	Value	Required	Notes
type	email-addresses	√
id	UUID	√

PhoneNumberRelationship

PhoneNumberRelationship represents a link to a PhoneNumber

Key	Value	Required	Notes
type	phone-numbers	√
id	UUID	√

RoleRelationship

RoleRelationship represents a link to a Role

Key	Value	Required	Notes
type	roles	√
id	UUID	√

SubjectRelationship

SubjectRelationship represents a link to another object in the system which is the subject of an Activity

Key	Value	Required	Notes
type	String	√	must be another valid object type, lowercase, plural
id	UUID	√

AuthorRelationship

AuthorRelationship represents a link to another object in the system which is the author of an Activity

Key	Value	Required	Notes
type	String	√	must be another valid object type, lowercase, plural
id	UUID	√

ProfileRelationship

ProfileRelationship represents a link to a Profile

Key	Value	Required	Notes
type	profiles	√
id	UUID	√

AccountRelationship

AccountRelationship represents a link to an Account

Key	Value	Required	Notes
type	accounts	√
id	UUID	√

AchBatchEntryRelationship

AchBatchEntryRelationship represents a link to an AchBatchEntry

Key	Value	Required	Notes
type	accounts	√
id	UUID	√

SourceRelationship

SourceRelationship represents a link to a Source

Key	Value	Required	Notes
type	String	√	must be another valid object type, lowercase, plural
id	UUID	√

AchReturnResponse

Key	Value	Notes
type	transaction-returns
Attributes
code	String
reason	String
metadata	Metadata
Relationships
ach_batch_entry	AchBatchEntryRelationship

AchNotificationOfChangeResponse

Key	Value	Notes
type	transaction-returns
Attributes
code	String
reason	String
metadata	Metadata
Relationships
ach_batch_entry	AchBatchEntryRelationship

TransactionRelationship

TransactionRelationship represents a link to a Transaction

Key	Value	Required	Notes
type	transactions	√
id	UUID	√

TransactionReturnResponse

Key	Value	Notes
type	transaction-returns
Attributes
code	String
reason	String
metadata	Metadata
Relationships
source	SourceRelationship
transaction	TransactionRelationship