add identification to agreement

Add the identification models introduced in version 20260901 to an agreement created without them: the initiating client and the debtor's registered payment account. Identification can only be added, never changed, and must match the details already on the agreement. Each identification can be added in a separate request. The debtor payment account must belong to the agreement's initiating client; adding one to an agreement with no initiating client identifies you as the initiator. Supply initiator.client_id for any agreement initiated on behalf of a sub-client; without it the agreement is identified as initiated by you.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 64
^[A-Za-z0-9\-._~]+$

A supplied unique ID

Body Params

The identification to add to the agreement. At least one of initiator or debtor must be given; each can be added in a separate request. The debtor payment account must belong to the agreement's initiating client, so for an agreement initiated on behalf of a sub-client add the initiator first or in the same request. Adding a payment account to an agreement with no initiating client identifies you as the initiator.

initiator
object
debtor
object
Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

404

Not Found

500

Internal Server Error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json