> ## Documentation Index > Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt > Use this file to discover all available pages before exploring further. # List your organization's operator links > Lists the individual-operates-business links your organization's sessions recorded, oldest first by default, naming both ends by your own references. Filter by `status=UNDER_REVIEW` for the links waiting on your decision; `shortfalls` says what each one's newest evaluation fell short on. ## OpenAPI ````yaml /api-reference/openapi.json get /issuance/identities/operator_links openapi: 3.1.0 info: title: baselayer-api-service version: 0.1.0 servers: - url: https://api.baselayer.com/ security: [] paths: /issuance/identities/operator_links: get: tags: - Identities summary: List your organization's operator links description: >- Lists the individual-operates-business links your organization's sessions recorded, oldest first by default, naming both ends by your own references. Filter by `status=UNDER_REVIEW` for the links waiting on your decision; `shortfalls` says what each one's newest evaluation fell short on. operationId: issuance_identities_operator_links_list parameters: - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: >- Maximum number of records to return in a single page. Must be between 1 and 1000. default: 10 title: Limit description: >- Maximum number of records to return in a single page. Must be between 1 and 1000. - name: offset in: query required: false schema: anyOf: - type: integer minimum: 0 - type: 'null' description: >- Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor. title: Offset description: >- Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset. title: Cursor description: >- Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset. - name: sort in: query required: false schema: anyOf: - $ref: '#/components/schemas/OperatorLinkSortField' - type: 'null' description: >- `created_at` (when the link was recorded) or `name` (the person's name, then the business's, ignoring case; a person with no current name sorts last either way); ties break on `created_at`, then the link's id. Defaults to `created_at` `desc`. title: Sort description: >- `created_at` (when the link was recorded) or `name` (the person's name, then the business's, ignoring case; a person with no current name sorts last either way); ties break on `created_at`, then the link's id. Defaults to `created_at` `desc`. - name: sort_direction in: query required: false schema: anyOf: - $ref: '#/components/schemas/SortMethod' - type: 'null' description: >- `asc` or `desc`, for every key of the sort. Defaults to the field's own: `created_at` `desc`, `name` `asc`. title: Sort Direction description: >- `asc` or `desc`, for every key of the sort. Defaults to the field's own: `created_at` `desc`, `name` `asc`. - name: status in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/BusinessOperatorLinkStatus' - type: 'null' description: Only links in any of these statuses. Repeatable. title: Status description: Only links in any of these statuses. Repeatable. - name: shortfall in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/BusinessOperatorLinkShortfall' - type: 'null' description: >- Only links whose newest evaluation fell short on any of these. Repeatable. title: Shortfall description: >- Only links whose newest evaluation fell short on any of these. Repeatable. - name: search in: query required: false schema: anyOf: - type: string maxLength: 200 - type: 'null' description: >- A `prn_` or `bus_` reference, matched exactly, or free text matched against the person's and the business's names. title: Search description: >- A `prn_` or `bus_` reference, matched exactly, or free text matched against the person's and the business's names. responses: '200': description: >- Paginated operator links in the requested order, scoped to the calling organization. content: application/json: schema: type: array items: $ref: '#/components/schemas/v1.OperatorLinkResponse' application/vnd.baselayer.v1+json: schema: type: array items: $ref: '#/components/schemas/v1.OperatorLinkResponse' headers: X-Total-Count: description: Total number of records matching the query. schema: type: integer X-Total-Pages: description: Total number of pages available based on the current limit. schema: type: integer X-Next-Cursor: description: >- Cursor for the next page (only present when using the keyset pagination and if `has_more` is true. schema: type: string '422': description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/Error' title: ValidationFailed description: The request is invalid. examples: - type: validation_failed code: 7112 message: The request is invalid. metadata: {} security: - APIKeyHeader: [] components: schemas: OperatorLinkSortField: type: string enum: - created_at - name title: OperatorLinkSortField description: What the operator-links list sorts by. SortMethod: type: string enum: - asc - desc title: SortMethod BusinessOperatorLinkStatus: description: |- Your organization's status for the link between an individual and a business they operate. VERIFIED is earned by the full evidence recipe (TIN provided + IRS-matched + KYB-verified) on one of your own sessions, or decided by your organization; UNDER_REVIEW is every automatic shortfall; REJECTED is your organization's refusal, which stands until you decide again. Another organization's evidence or decision never changes it. enum: - VERIFIED - UNDER_REVIEW - REJECTED title: BusinessOperatorLinkStatus type: string BusinessOperatorLinkShortfall: description: >- Which leg of the operator-link evidence recipe a covering evaluation failed. Reviewer-facing: a session whose evaluation reports any shortfall records an UNDER_REVIEW link, and these name what a reviewer would be overriding by verifying it anyway. An evaluation that reports none earns VERIFIED on its own. enum: - TIN_NOT_PROVIDED - TIN_NOT_MATCHED - KYB_NOT_VERIFIED title: BusinessOperatorLinkShortfall type: string v1.OperatorLinkResponse: description: |- One operator link your organization holds, naming both ends: a row of the link requests list. properties: status: $ref: '#/components/schemas/v1.BusinessOperatorLinkStatus' description: Your organization's current status for the link. review_flagged_at: anyOf: - format: date-time type: string - type: 'null' default: null description: >- When a later evaluation flagged this verified link for review; null when it never was. title: Review Flagged At decided_at: anyOf: - format: date-time type: string - type: 'null' default: null description: >- When your organization last verified or rejected the link by hand; null while only the evidence has decided it. title: Decided At decided_by: anyOf: - $ref: '#/components/schemas/v1.ActedBy' - type: 'null' default: null description: >- Who made that decision, as stamped when they made it; null when no one has. decision_reason: anyOf: - type: string - type: 'null' default: null description: The reason recorded with that decision, if any. title: Decision Reason created_at: description: When the link was first recorded. format: date-time title: Created At type: string source_verification_id: anyOf: - type: string format: uuid - type: 'null' default: null description: >- The verification that established the link; null when that verification no longer exists. A direct verification reads at `GET /issuance/identities/verifications/{verification_id}`; a hosted one is an onboarding session and reads at `GET /onboarding/sessions/{session_id}`. title: Source Verification Id individual_ref: description: Pairwise reference to the linked individual. title: Individual Ref type: string individual_display_name: anyOf: - type: string - type: 'null' default: null description: >- The individual's verified name from your organization's current verification; null when it has been superseded and not yet replaced. title: Individual Display Name business_ref: description: Pairwise reference to the linked business. title: Business Ref type: string business_legal_name: description: The linked business's current legal name. title: Business Legal Name type: string shortfalls: description: >- What your newest evaluation of the pair fell short on, in recipe order: the reason a link is under review or flagged. Empty when it met the recipe. items: $ref: '#/components/schemas/v1.BusinessOperatorLinkShortfall' title: Shortfalls type: array required: - status - created_at - individual_ref - business_ref - business_legal_name - shortfalls title: OperatorLinkResponse (v1) type: object Error: properties: type: type: string title: Type description: >- Stable snake_case name of the error. Branch on this, never on `message`. code: type: integer title: Code description: Integer catalog code of the error. message: type: string title: Message description: For a human reading a log; not stable and not localized. metadata: additionalProperties: true type: object title: Metadata description: Context documented per `type`. request_id: anyOf: - type: string - type: 'null' title: Request Id description: The `X-Request-ID` of the failed request. type: object required: - type - code - message title: Error description: The one body of every error a KYA route answers. v1.BusinessOperatorLinkStatus: description: |- Your organization's status for the link between an individual and a business they operate. VERIFIED is earned by the full evidence recipe (TIN provided + IRS-matched + KYB-verified) on one of your own sessions, or decided by your organization; UNDER_REVIEW is every automatic shortfall; REJECTED is your organization's refusal, which stands until you decide again. Another organization's evidence or decision never changes it. enum: - VERIFIED - UNDER_REVIEW - REJECTED title: BusinessOperatorLinkStatus type: string v1.ActedBy: description: |- Who acted on a record, as they were named when they acted: the one actor shape every route answers. properties: kind: $ref: '#/components/schemas/v1.ActedByKind' description: '`USER` for a console user, `API_KEY` for a key.' label: description: >- The user's first and last name or the API key's name, as they were when they acted; never rewritten by a later rename or deletion. title: Label type: string required: - kind - label title: ActedBy (v1) type: object v1.BusinessOperatorLinkShortfall: description: >- Which leg of the operator-link evidence recipe a covering evaluation failed. Reviewer-facing: a session whose evaluation reports any shortfall records an UNDER_REVIEW link, and these name what a reviewer would be overriding by verifying it anyway. An evaluation that reports none earns VERIFIED on its own. enum: - TIN_NOT_PROVIDED - TIN_NOT_MATCHED - KYB_NOT_VERIFIED title: BusinessOperatorLinkShortfall type: string v1.ActedByKind: description: 'Who acted on a record: a console user or an API key.' enum: - USER - API_KEY title: ActedByKind type: string securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.