Introduction

Welcome to the ClientLoop documentation. ClientLoop is NR1E's payment processing platform.

Quick start

@clientloop/client is a typed client for the ClientLoop GraphQL API. Install it, create a client with your API key, then call the operation you need — each one takes the client as its first argument.

pnpm add @clientloop/client

import { createClient } from '@clientloop/client';
import { contactCreateIdvSession } from '@clientloop/client/core';

const client = createClient({
  url: 'https://graph.clientloop.com',
  apiKey: process.env.CLIENTLOOP_API_KEY,
});

// Create a Plaid identity-verification session for a contact.
const session = await contactCreateIdvSession(client, {
  orgId: 'YOUR_ORG_ID',
});

console.log(session?.token, session?.expiresAt);

Authenticate by passing an apiKey (sent as a Bearer token); operations live under @clientloop/client/core. See the embedded component guides for the end-to-end flows that consume these sessions.

What's in these docs

• Getting Started — this introduction.
• Components — integration guides for the embeddable Apply, Checkout, and Contact IDV components.
• API Reference — the GraphQL schema, rendered directly from the generated schema file.