Peach Finance

API Keys

API Keys can be managed with these endpoints.

Get all API keys

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
status
string
Default: "active"
Enum: "active" "inactive"
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

offset
integer >= 0

Offset from the start of results.

Responses
200

Success

get/keys
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create an API key

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
userId
required
string
whitelistedIPs
Array of strings or null (WhitelistedIPs)

IP addresses or CIDR blocks for which to restrict access to this API key.

description
string or null (APIKeyDescription) [ 1 .. 200 ] characters

A description of the API key. This field is optional and can be used to provide additional context about the API key.

Responses
201

Created

post/keys
Request samples
application/json
{
  • "userId": "string",
  • "whitelistedIPs": [
    ],
  • "description": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "userId": "string",
  • "key": "string",
  • "whitelistedIPs": [
    ],
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Get an API key

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
keyId
required
string

The API key id.

Responses
200

Success

get/keys/{keyId}
Response samples
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "userId": "string",
  • "key": "string",
  • "whitelistedIPs": [
    ],
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Delete an API key

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
keyId
required
string

The API key id.

Responses
204

Success

delete/keys/{keyId}

Update an API key

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
keyId
required
string

The API key id.

Request Body schema: application/json
required
apiVersion
string (APIKeyAPIVersion) ^\d{4}-\d{2}-\d{2}$

The version of the API this API key is tied to. Must be in the format YYYY-MM-DD. For example, 2024-05-22.

description
string or null (APIKeyDescription) [ 1 .. 200 ] characters

A description of the API key. This field is optional and can be used to provide additional context about the API key.

whitelistedIPs
Array of strings or null (WhitelistedIPs)

IP addresses or CIDR blocks for which to restrict access to this API key.

Responses
200

Success

put/keys/{keyId}
Request samples
application/json
{
  • "apiVersion": "2024-05-22",
  • "description": "string",
  • "whitelistedIPs": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "companyId": "string",
  • "userId": "string",
  • "key": "string",
  • "whitelistedIPs": [
    ],
  • "apiVersion": "2024-05-22",
  • "apiVersionUpdatedAt": "2019-08-24T14:15:22Z",
  • "apiVersionDowngradeNotAllowedAfter": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z"
}
➔ Next to Borrowers