Clients — Overview

A client is the record of an individual or legal entity within the company — the borrower (or prospective borrower) of credit. Unlike a card, which represents a specific credit process and belongs to exactly one flow, a client is an independent record in the company's general registry: the same client can be associated with multiple cards, across multiple flows, over time, and can exist in the registry even without any ongoing credit process.

For the list of clients associated with a specific card, see GET /v1/cards/{cardId}/clients, documented in the Cards domain. This domain (Clients) covers the company's general registry, not an association with a specific card.

Endpoints in this domain

Method	Path	Description
`POST`	`/v1/clients`	Creates a client
`GET`	`/v1/clients`	Lists the company's clients (paginated, searchable)
`GET`	`/v1/clients/{clientId}`	Returns a client's full profile
`PUT`	`/v1/clients/{clientId}`	Updates a client's dynamic fields
`GET`	`/v1/clients/{clientId}/agrisk`	Queries consolidated data from external sources about the client
`GET`	`/v1/clients/{clientId}/cards`	Lists the cards the client is involved in

Where to obtain the identifiers

clientId: returned by this domain's listing (GET /v1/clients), by a specific card's client listing (GET /v1/cards/{cardId}/clients, Cards domain), or in the clients array of an existing card.

Reference flow (used in the ag-flow-id header, when sent): obtained from GET /v1/flows (Flow domain) or from the flow's URL inside the AgFlow application.

Base URL and authentication: see the Getting Started document at the top of this documentation.

Important behaviors

The ag-flow-id header is optional.

The listing (GET /v1/clients) returns only basic identification data (identifier, document, name, type, creation date) — for the full profile, use the single-client lookup (GET /v1/clients/{clientId}).

The full profile's shape varies by client type. Fields such as mother's/father's name, gender, birth date, and marital status are meaningful for individuals; trade name, legal nature, ownership structure, and share capital are meaningful for legal entities. Not every field will be filled in for every client.

Updating (PUT) only writes dynamic fields — the same fields configurable by the company in the Client Configuration domain. It does not change the name, document, or any data obtained from external sources.

A document's registration status (taxIdStatus) can include the literal string value "null", distinct from the field simply being absent — it indicates the status could not be determined, and should not be mistaken for missing data.

SCR query authorization (scrAuthorized) is a flag of its own on the client, independent of the company's general authorization — it controls whether the client's credit operation history in the Central Bank's Credit Information System can be queried.

The consolidated-data endpoint (/agrisk) is a leaner slice of the automatic external query result (see the Bureau Query domain), complementary to — not a replacement for — the client's full profile.

As with any authenticated API call, access to these endpoints is subject to the permissions granted to the user/token in use.

Clients — Overview

Endpoints in this domain#

Where to obtain the identifiers#

Important behaviors#

Endpoints in this domain

Where to obtain the identifiers

Important behaviors