Financial Aggregation
As the name suggests, customers are a core part of Protocol — the very reason Protocol exists is so you can have secure conversations with your customers. On this page, we'll dive into the different customer endpoints you can use to manage customers programmatically. We'll look at how to query, create, update, and delete customers.
The connection model
The customer model contains all the information about your customers, such as their username, avatar, and phone number. It also contains a reference to the conversation between you and the customer and information about when they were last active on Protocol.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the connection.
- Name
project_id- Type
- string
- Description
Identifier for the project associated with the connection.
- Name
external_id- Type
- string
- Nullable
- NULLABLE
- Description
External identifier for the connection.
- Name
customer_id- Type
- string
- Description
Timestamp of the last transaction made by the customer, if any.
- Name
aggregation_institution_id- Type
- string
- Description
Timestamp of the last transaction made by the customer, if any.
- Name
state- Type
- string
- Description
Timestamp of the last transaction made by the customer, if any.
- Name
task_data- Type
- object
- Description
- Identity of the customer
- Name
identity- Type
- object
- Description
- Identity of the customer
- Name
updated_at- Type
- timestamp
- Description
Timestamp of when the customer's information was last updated.
- Name
meta- Type
- object
- Description
A metadata object associated with the customer.
- Name
created_at- Type
- timestamp
- Description
Timestamp of when the customer account was created.
API endpoints can be accessed here.