List Agreements

Request

Partner agreements and disclosures are available through the API in a versioned bundle. The version of the fetched bundle must be attached to all incoming applications.

Partners who onboard more than one kind of customer have a separate bundle per customer type. Use the optional customer_type query parameter to select one. A bundle that is not restricted to a customer type is returned for any requested type.

Outcome	Response
Exactly one bundle matches	`200` with the bundle
No bundle is published for the requested customer type	`404` `jiko.errors.agreements.NoMatchingAgreementBundle`
More than one bundle matches, typically because `customer_type` was omitted	`400` `jiko.errors.agreements.AmbiguousAgreementBundle`
`customer_type` is not one of `INDIVIDUAL` or `BUSINESS`	`422` validation error

Security

HTTPBearer

Query

customer_typestring or null(Customer Type)

Any of:

Selects the bundle published for this customer type. Omit it only when a single bundle applies to every customer type.

string

Enum:"INDIVIDUAL""BUSINESS"

x-jiko-idempotencystring, (uuid)(X-Jiko-Idempotency)required

A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

x-jiko-signaturestring(X-Jiko-Signature)required

Base64-encoded HMAC-SHA256 hash of x-jiko-idempotency + request pathname + body, keyed with your shared secret. See Authentication for the full algorithm and a code sample.

curl -i -X GET \
  'https://your-partner-name.sandbox-api.jikoservices.com/api/v1/agreements/?customer_type=INDIVIDUAL' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json

versionstring(Version)required

release_datestring, (date)(Release Date)required

documentsArray of objects(Documents)required

Response

{
  "version": "1.0.0",
  "release_date": "2023-01-01",
  "documents": [
    { … }
  ]
}

List Agreements

Request

Query

Headers

Responses

Was this helpful?