Whitelist Requests

Vault whitelist request management

Submit vault whitelist request

post

Submit a request to be whitelisted for a private vault (requires verified status)

Authorizations

AuthorizationstringRequired

Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop

Body

anyOptional

Responses

201

Default Response

application/json

idstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequiredExample: eip155:1

requestorUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

requestorEmailstringRequired

requestorAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

statusstringRequired

requestedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

approverUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

approverEmailstring · nullableOptional

approverAddressstring · nullableOptionalExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

processedAtstring · date-time · nullableOptionalExample: 2025-01-15T10:30:00Z

createdAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

updatedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

409

Default Response

application/json

post/v3/whitelist-requests

POST /v3/whitelist-requests HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "vaultId": "123e4567-e89b-12d3-a456-426614174000",
  "vaultAddress": "text",
  "networkId": "text",
  "requestorAddress": "text"
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "requestorUserId": "550e8400-e29b-41d4-a716-446655440000",
  "requestorEmail": "text",
  "requestorAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "status": "text",
  "requestedAt": "2025-01-15T10:30:00Z",
  "approverUserId": "550e8400-e29b-41d4-a716-446655440000",
  "approverEmail": "text",
  "approverAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "processedAt": "2025-01-15T10:30:00Z",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Get my whitelist requests

get

Get all whitelist requests submitted by the authenticated user

Authorizations

AuthorizationstringRequired

Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop

Query parameters

statusstring · enumOptional

Filter by request status

Possible values:

vaultIdstring · uuidOptional

Filter by vault ID. Takes precedence over vaultAddress. Example: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstring · max: 42Optional

Filter by vault address. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Pattern: ^0x[0-9a-fA-F]{40}$

limitinteger · min: 1 · max: 100OptionalDefault: 20

offsetintegerOptionalDefault: 0

Responses

200

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

get/v3/whitelist-requests/me

GET /v3/whitelist-requests/me HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "vaultAddress": "text",
      "networkId": "text",
      "requestorUserId": "123e4567-e89b-12d3-a456-426614174000",
      "requestorEmail": "text",
      "requestorAddress": "text",
      "status": "text",
      "requestedAt": "2026-07-12T11:05:40.252Z",
      "approverUserId": "123e4567-e89b-12d3-a456-426614174000",
      "approverEmail": "text",
      "approverAddress": "text",
      "processedAt": "2026-07-12T11:05:40.252Z",
      "createdAt": "2026-07-12T11:05:40.252Z",
      "updatedAt": "2026-07-12T11:05:40.252Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Get whitelist request by ID

get

Get a specific whitelist request by ID (must be owned by you)

Authorizations

AuthorizationstringRequired

Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop

Path parameters

requestIdstring · uuidRequired

Responses

200

Default Response

application/json

idstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequiredExample: eip155:1

requestorUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

requestorEmailstringRequired

requestorAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

statusstringRequired

requestedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

approverUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

approverEmailstring · nullableOptional

approverAddressstring · nullableOptionalExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

processedAtstring · date-time · nullableOptionalExample: 2025-01-15T10:30:00Z

createdAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

updatedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

401

Default Response

application/json

404

Default Response

application/json

get/v3/whitelist-requests/{requestId}

GET /v3/whitelist-requests/{requestId} HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "requestorUserId": "550e8400-e29b-41d4-a716-446655440000",
  "requestorEmail": "text",
  "requestorAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "status": "text",
  "requestedAt": "2025-01-15T10:30:00Z",
  "approverUserId": "550e8400-e29b-41d4-a716-446655440000",
  "approverEmail": "text",
  "approverAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "processedAt": "2025-01-15T10:30:00Z",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Get whitelist requests for a vault

get

Get all whitelist requests for a specific vault by vault ID. Requires the caller to be a member of the vault's organization.

Authorizations

AuthorizationstringRequired

Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop

Path parameters

vaultIdstring · uuidRequired

Vault ID. Example: 550e8400-e29b-41d4-a716-446655440000

Query parameters

statusstring · enumOptionalPossible values:

Responses

200

Default Response

application/json

totalintegerRequired

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

get/v3/whitelist-requests/vault/{vaultId}

GET /v3/whitelist-requests/vault/{vaultId} HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requests": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "vaultAddress": "text",
      "networkId": "text",
      "requestorUserId": "123e4567-e89b-12d3-a456-426614174000",
      "requestorEmail": "text",
      "requestorAddress": "text",
      "status": "text",
      "requestedAt": "2026-07-12T11:05:40.252Z",
      "approverUserId": "123e4567-e89b-12d3-a456-426614174000",
      "approverEmail": "text",
      "approverAddress": "text",
      "processedAt": "2026-07-12T11:05:40.252Z",
      "createdAt": "2026-07-12T11:05:40.252Z",
      "updatedAt": "2026-07-12T11:05:40.252Z"
    }
  ],
  "total": 1
}

Reject a whitelist request

post

Reject a whitelist request. Requires the caller to be a curator in the vault's organization.

Authorizations

AuthorizationstringRequired

Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop

Path parameters

requestIdstring · uuidRequired

Body

approverAddressstring · max: 42Optional

Optional Ethereum address of the approver. Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

Pattern: ^0x[0-9a-fA-F]{40}$

Responses

200

Default Response

application/json

idstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

vaultAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

networkIdstringRequiredExample: eip155:1

requestorUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

requestorEmailstringRequired

requestorAddressstringRequiredExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

statusstringRequired

requestedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

approverUserIdstring · uuid · nullableOptionalExample: 550e8400-e29b-41d4-a716-446655440000

approverEmailstring · nullableOptional

approverAddressstring · nullableOptionalExample: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

processedAtstring · date-time · nullableOptionalExample: 2025-01-15T10:30:00Z

createdAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

updatedAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

404

Default Response

application/json

post/v3/whitelist-requests/{requestId}/reject

POST /v3/whitelist-requests/{requestId}/reject HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "approverAddress": "text"
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "vaultAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "networkId": "eip155:1",
  "requestorUserId": "550e8400-e29b-41d4-a716-446655440000",
  "requestorEmail": "text",
  "requestorAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "status": "text",
  "requestedAt": "2025-01-15T10:30:00Z",
  "approverUserId": "550e8400-e29b-41d4-a716-446655440000",
  "approverEmail": "text",
  "approverAddress": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "processedAt": "2025-01-15T10:30:00Z",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

PreviousDepositors NextLedger

Last updated 9 days ago

Was this helpful?