> ## Documentation Index > Fetch the complete documentation index at: https://developers.meet-oj.com/llms.txt > Use this file to discover all available pages before exploring further. # Register a channel connector > Registers a channel you own so O.J. can reach your borrowers through it. Four types are supported. - `webhook`: O.J. POSTs each borrower-facing message to a URL on your server, signed like any webhook, and your product shows it in its own inbox or chat. This is the simplest type. - `sms`: your Twilio (or compatible) account. O.J. sends texts from your number. - `apple_business_messages`: your Apple Business Messages account. O.J. replies in iMessage as you. - `email`: your sending domain. O.J. emails from an address you choose. Credentials are stored encrypted and never returned. The `policy` says what O.J. may send through the connector and when. A connector with an empty policy sends nothing. ## OpenAPI ````yaml /api-reference/openapi.yaml post /channels openapi: 3.1.0 info: title: O.J. Agent Development Kit (ADK) version: 0.5.1 summary: >- Send O.J. a business. Get back named lender matches, what's needed, offers and funding status. description: > The O.J. ADK lets platforms with small-business customers offer financing without becoming a lender or a broker. You send a business as a **referral**. O.J. matches it to lender programs, collects documents, submits to lenders and tracks the deal to funding. You earn a share of the commission on every funded loan. Integrate with **O.J. Embed** (drop-in screens), the **REST API** with webhooks, or **MCP** for agents. All three read and write the same referral. Conventions: OAuth 2.0 client credentials, amounts in cents, prefixed ids, cursor pagination, an `Idempotency-Key` on every POST, RFC 9457 errors, and Standard Webhooks signatures. license: name: Proprietary — O.J. partner terms identifier: LicenseRef-OJ-Partner contact: name: O.J. Developer Support email: developers@meet-oj.com servers: - url: https://sandbox.api.meet-oj.com/partner/v0 description: Sandbox - url: https://api.meet-oj.com/partner/v0 description: Production security: - oauth2: [] tags: - name: Referrals description: >- A referral is one business you sent to O.J. Every other resource belongs to a referral. - name: Matches description: >- The lenders a business matches, named, with estimated limits. `POST /match_checks` screens raw numbers without creating a referral. A match is not a credit decision; the lender decides. - name: Documents description: >- Documents O.J. still needs, and uploads by API. Most integrations show the `next_action` button instead. - name: Offers description: >- Offers returned by lenders. Indicative terms computed before a lender replies are marked `binding: false`. - name: Sessions description: >- Create a session to open an O.J. screen: a `client_token` for Embed, or a hosted `url` to redirect to. - name: Events description: >- Every change to a referral is an event, delivered by webhook, streamed over SSE, and kept for 30 days at `GET /events`. - name: Payouts description: >- Your share of the commission on each funded referral. Match rows to your bank statement with `statement_descriptor`. Payout destinations are set during onboarding and cannot be changed by API. - name: Conversation description: >- The message thread between O.J., the borrower and your team on a referral, across every channel. - name: Channels description: >- Channel connectors let O.J. reach your borrowers through channels you own (in-app inbox, SMS, Apple Business Messages, email), in your brand. - name: Policy description: >- Account-level rules: send approval, allowed Embed origins, contact channels, default intent and reminder cadence. - name: Programs description: >- For lenders running a program on O.J.: receive submissions, record decisions and report funding. - name: Webhooks description: >- Register endpoints that receive signed events. Deliveries follow Standard Webhooks. paths: /channels: post: tags: - Channels summary: Register a channel connector description: > Registers a channel you own so O.J. can reach your borrowers through it. Four types are supported. - `webhook`: O.J. POSTs each borrower-facing message to a URL on your server, signed like any webhook, and your product shows it in its own inbox or chat. This is the simplest type. - `sms`: your Twilio (or compatible) account. O.J. sends texts from your number. - `apple_business_messages`: your Apple Business Messages account. O.J. replies in iMessage as you. - `email`: your sending domain. O.J. emails from an address you choose. Credentials are stored encrypted and never returned. The `policy` says what O.J. may send through the connector and when. A connector with an empty policy sends nothing. operationId: createChannelConnector parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChannelConnectorCreate' responses: '201': description: Connector registered content: application/json: schema: $ref: '#/components/schemas/ChannelConnector' '400': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: true description: > IETF `Idempotency-Key` semantics (draft-ietf-httpapi-idempotency-key-header). Send a fresh unique value (a UUID) with every new request. A retry with the same key and the same payload returns the original response with the header `Idempotent-Replayed: true`. The same key with a different payload is rejected with 422 and code `idempotency_key_reused`. Keys are kept for 24 hours. schema: type: string maxLength: 255 schemas: ChannelConnectorCreate: type: object description: >- The body for registering a channel you own. Which fields of `delivery` are read depends on `type`. required: - type - name - policy properties: type: type: string enum: - webhook - sms - apple_business_messages - email name: type: string examples: - Acme Listings in-app inbox delivery: type: object description: >- How O.J. delivers. For `webhook`: `url`. For `sms`: `provider`, `account_sid`, `auth_token`, `from_number`. For `apple_business_messages`: `business_id`, `csp_token`. For `email`: `from_address`, plus DNS records O.J. gives you to verify the domain. properties: url: type: string format: uri provider: type: string enum: - twilio account_sid: type: string writeOnly: true auth_token: type: string writeOnly: true from_number: type: string business_id: type: string csp_token: type: string writeOnly: true from_address: type: string format: email policy: $ref: '#/components/schemas/ChannelPolicy' ChannelConnector: type: object description: >- A channel you registered. Credentials are never returned. `delivery` shows only the non-secret fields. required: - id - type - name - status - policy - created_at properties: id: type: string examples: - chn_01K5X7A1B2 object: type: string const: channel_connector type: type: string enum: - webhook - sms - apple_business_messages - email name: type: string status: type: string enum: - active - verifying - disabled description: '`verifying` while a domain or number is being confirmed.' delivery: type: object properties: url: type: string format: uri from_number: type: string from_address: type: string provider: type: string policy: $ref: '#/components/schemas/ChannelPolicy' created_at: type: string format: date-time ChannelPolicy: type: object description: >- What O.J. may send through a connector, and when. A connector with an empty `allow` list sends nothing. properties: allow: type: array items: type: string enum: - status_updates - requests - reminders - offers - replies description: >- `status_updates` are one-line progress notes. `requests` ask for something, such as documents or a bank connection. `reminders` nudge about an open action. `offers` announce an offer. `replies` are O.J. answering a borrower's question. quiet_hours: type: object properties: start: type: string examples: - '21:00' end: type: string examples: - '08:00' timezone: type: string examples: - America/Chicago max_per_day: type: integer description: Cap on messages to one borrower per day. Error: type: object description: > RFC 9457 Problem Details, returned as `application/problem+json` with any 4xx or 5xx status. `type` is a URI that identifies the kind of problem and doubles as a link to its documentation; `title` is the short human name for that kind; `status` repeats the HTTP status; `detail` explains this occurrence for a developer; `instance` is the request path. Three extension members: `code`, a stable snake_case reason to branch on; `param`, the offending field when the request was invalid; `request_id`, to quote to support. One code deserves a note: `awaiting_approval` (HTTP 409) is not a failure. It means the action you asked for needs a person at your company to confirm it first, and the referral shows `needs_partner` until they do. required: - type - title - status - code - request_id properties: type: type: string format: uri examples: - https://api.meet-oj.com/problems/duplicate-external-id title: type: string examples: - Referral already exists status: type: integer examples: - 409 detail: type: string examples: - >- A referral with external_id cust_8842 was created on 2026-09-20 as ref_01K5X3K7Q2. instance: type: string examples: - /partner/v0/referrals code: type: string description: >- Stable machine-readable reason. Categories are the prefixes; specific codes follow. examples: - invalid_request - authentication_failed - permission_denied - not_found - duplicate_external_id - business_already_referred - missing_consent - required_documents_missing - idempotency_key_reused - rate_limited - awaiting_approval - internal_error param: type: string description: The field that caused an invalid_request, in dot notation. request_id: type: string examples: - req_01K5X4A9M2 responses: Error: description: Problem Details (RFC 9457) headers: OJ-Request-Id: $ref: '#/components/headers/RequestId' content: application/problem+json: schema: $ref: '#/components/schemas/Error' headers: RequestId: description: >- Unique id for this request. Quote it to support; it is also in Problem Details as `request_id` and in O.J.'s traces. schema: type: string examples: - req_01K5X4A9M2 securitySchemes: oauth2: type: oauth2 description: >- One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token. flows: clientCredentials: tokenUrl: https://api.meet-oj.com/oauth/token scopes: referrals:write: Create referrals and upload documents referrals:read: Read referrals, matches, document requests, offers, events match_checks:write: Run identity-free match checks sessions:write: Mint hosted-session links webhooks:manage: Register and list webhook endpoints payouts:read: >- Read payouts (your statement). There is no payouts:write; destinations are managed in hosted onboarding by a person. messages:read: Read a referral's conversation messages:write: >- Send messages into a referral's conversation on behalf of the partner or the borrower channels:manage: Register and remove channel connectors policy:manage: Read and change the partner policy submissions:read: >- For banks running a program. List and read submissions awaiting review submissions:write: For banks running a program. Record decisions and report funding ````