Client API

Create your API key with only the organizations and API permissions your integration needs. See Authentication for the scope catalog, token exchange flow, and key-rotation steps. Use the Monterey Client API to read normalized account, borrower, and transaction data across Monterey’s servicing systems. You can also manage payment methods and autopay schedules. Your API key determines which organizations you can access. All client endpoints use the /v1 prefix. Reports are available in client_dashboard, not through this API.

Available endpoints

Organizations and people

Endpoint	Description
`GET /v1/organizations`	List organizations in the token’s allowlist
`GET /v1/organizations/{id}`	Get one organization
`GET /v1/persons`	List borrowers reachable through in-scope accounts
`GET /v1/persons/{id}`	Get enriched person details, contact methods, and addresses
`GET /v1/persons/{id}/accounts`	List accounts where the person has a borrower role

Accounts and transactions

Endpoint	Description
`GET /v1/accounts`	List in-scope accounts
`GET /v1/accounts/{id}`	Get account, contract, and borrower details
`GET /v1/accounts/by-external-id/{external_id}`	Get an account by its source account identifier
`GET /v1/accounts/by-external-contract-id/{external_contract_id}`	Get an account by its client-supplied contract ID
`GET /v1/accounts/{id}/transactions`	List transactions for one account
`GET /v1/transactions`	List transactions across in-scope accounts

Payment operations

Endpoint	Description
`GET /v1/payment-methods`	List stored payment methods
`POST /v1/payment-methods/cards`	Create a card payment method through the secure proxy
`PATCH /v1/payment-methods/{id}`	Update display fields
`DELETE /v1/payment-methods/{id}`	Deactivate a payment method
`GET /v1/accounts/{id}/payment-methods`	List active methods eligible for an account
`POST /v1/autopay`	Create an autopay schedule
`GET /v1/autopay`	List autopay schedules
`PATCH /v1/autopay/{id}`	Update amount, method, end date, or pause state
`DELETE /v1/autopay/{id}`	Cancel a schedule

Before you call

Get an API key

Create a least-privilege API key in the client portal. Select the exact organizations and API permissions you need. Store the plaintext value securely because it is shown once.

Mint an access token

Exchange the API key prefix and plaintext value at POST /v1/oauth/token. The returned bearer token lasts 3600 seconds.

Call a v1 endpoint

Send Authorization: Bearer <access_token> on each request.

See Authentication for the exchange loop, rotation, and error behavior. See Conventions for pagination, rate limits, money, dates, and shared errors. Use the secure card-capture proxy at https://secure-api.montereyfinancial.app when you need to create a card payment method from raw PAN and CVC. Read Card capture before you wire that flow.

Secure capture is environment-specific. The card-capture endpoint may return 503 until Monterey enables it for your environment.

Download OpenAPI spec

Import the complete OpenAPI 3.1 contract into Postman, Insomnia, Bruno, or a code generator.

Overview

Endpoints

Available endpoints

Organizations and people

Accounts and transactions

Payment operations

Before you call

Download OpenAPI spec

​Available endpoints

​Organizations and people

​Accounts and transactions

​Payment operations

​Before you call

Download OpenAPI spec

Available endpoints

Organizations and people

Accounts and transactions

Payment operations

Before you call