Users

User profile and settings management

Check user verification status

get

Check if the authenticated user is verified (via KYC, legacy onboarding, KYB organization membership, or legacy KYB)

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

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

Responses

200

Default Response

application/json

verifiedbooleanRequired

Whether the user is verified through KYC, legacy onboarding, or membership in a KYB-verified or legacy KYB organization

401

Default Response

application/json

404

Default Response

application/json

get/v3/users/me/verified

HTTPcURLJavaScriptPython

GET /v3/users/me/verified HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "verified": true
}

Record biometric consent

post

Record biometric consent for the authenticated user

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

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

Body

application/json

biometricConsentGivenbooleanRequired

Whether the user has given biometric consent

biometricConsentVersionstringRequired

Version of the biometric consent accepted

Responses

200

Default Response

application/json

successbooleanRequired

messagestringRequired

401

Default Response

application/json

404

Default Response

application/json

post/v3/users/me/consent

HTTPcURLJavaScriptPython

POST /v3/users/me/consent HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "biometricConsentGiven": true,
  "biometricConsentVersion": "text"
}

{
  "success": true,
  "message": "text",
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "text",
    "firstName": "text",
    "lastName": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z"
  }
}

List user's organizations

get

List all organizations the authenticated user is a member of. Returns organizations, per-org functional access roles ("borrower", "vault-curator"), and a top-level union of all functional roles. Not all members receive functional roles; members without any will have an empty roles array for that org.

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

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

Responses

200

Default Response

application/json

401

Default Response

application/json

get/v3/users/me/organizations

HTTPcURLJavaScriptPython

GET /v3/users/me/organizations HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corp",
      "slug": "acme-corp",
      "header": null,
      "description": null,
      "overview": null,
      "links": [
        {
          "id": "a10e8400-e29b-41d4-a716-446655440000",
          "label": "#logo",
          "linkText": null,
          "iconUrl": null,
          "url": "https://example.com/acme-logo.png"
        }
      ]
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Beta Inc",
      "slug": "beta-inc",
      "header": null,
      "description": null,
      "overview": null,
      "links": []
    }
  ],
  "organizationAccessById": {
    "550e8400-e29b-41d4-a716-446655440000": {
      "roles": [
        "borrower"
      ]
    },
    "660e8400-e29b-41d4-a716-446655440001": {
      "roles": [
        "vault-curator",
        "vault-depositor-manager"
      ]
    }
  },
  "roles": [
    "borrower",
    "vault-curator",
    "vault-depositor-manager"
  ]
}

List KYB-eligible organizations

get

List organizations where the authenticated user is an admin with KYB eligibility status. Returns simplified organization data: name, slug, and kybEligible flag.

Authorizations

BearerAuthOAuth2

AuthorizationstringRequired

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

Responses

200

Default Response

application/json

401

Default Response

application/json

get/v3/users/me/organizations/kyb-eligible

HTTPcURLJavaScriptPython

GET /v3/users/me/organizations/kyb-eligible HTTP/1.1
Host: api.creditcoop.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizations": [
    {
      "name": "text",
      "slug": "text",
      "kybEligible": true
    }
  ]
}