{ "openapi": "3.1.0", "info": { "title": "baselayer-api-service", "version": "0.1.0" }, "servers": [ { "url": "https://api.baselayer.com/" } ], "paths": { "/international/registrations": { "get": { "tags": [ "International" ], "summary": "Search International Registrations", "description": "List registry registrations matching a business name or filing number.\nYou must provide one of `name` or `filing_number`.\n\nWith an `iso2_country_code`, a search will be performed directly at the registry for that jurisdiction.\nWithout an `iso2_country_code`, a global search will be performed across all jurisdictions.\n\nPass a result's `filing_number` (with the country) to\n`POST /international/searches` to run a lite or enhanced search for\nthat registration. Name and address are independently optional when\na filing number is supplied; provided inputs are compared with the\nreturned profile, and omitted inputs have null match fields.\nSuccessful filing-only searches also return KYB and Risk scores.", "operationId": "search_international_registrations_international_registrations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "iso2_country_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Jurisdiction code in ISO 3166 alpha-2", "examples": [ "GB" ], "title": "Iso2 Country Code" }, "description": "Jurisdiction code in ISO 3166 alpha-2" }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company Name", "examples": [ "Kyckr" ], "title": "Name" }, "description": "Company Name" }, { "name": "filing_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company registration (filing) number", "examples": [ "11655290" ], "title": "Filing Number" }, "description": "Company registration (filing) number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.InternationalRegistrationResponse" }, "title": "Response Search International Registrations International Registrations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/international/countries": { "get": { "tags": [ "International" ], "summary": "List International Countries", "description": "List the jurisdictions an international search can target.\n\nOne entry per country `POST /international/searches` accepts as\n`iso2_country_code`, with whether a lite profile and the `ENHANCED`\nadd-on are offered there. The list is fixed for an API release and\nmay be cached for an hour.", "operationId": "list_international_countries_international_countries_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/v1.InternationalCountryResponse" }, "type": "array", "title": "Response List International Countries International Countries Get" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/international/searches": { "get": { "tags": [ "International" ], "summary": "Get International Searches", "description": "Retrieve a list of international business searches.", "operationId": "get_international_searches_international_searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of international business searches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchResponse" }, "title": "Response Get International Searches International Searches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "International" ], "summary": "Post International Search", "description": "Create a new international business search.", "operationId": "post_international_search_international_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/international/searches/{id}": { "get": { "tags": [ "International" ], "summary": "Get International Search", "description": "Retrieve an international business search by ID.", "operationId": "get_international_search_international_searches__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Search ID", "description": "The unique identifier of the international search to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the international search to retrieve." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/people/{id}": { "get": { "tags": [ "People" ], "summary": "Get Person", "operationId": "get_person_people__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the person to fetch." } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/people": { "post": { "tags": [ "People" ], "summary": "Create Person", "description": "Creates a new person record in the database.", "operationId": "create_person_people_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreatePersonRequest" } } }, "required": true }, "responses": { "201": { "description": "Person created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSummaryResponse" } } } }, "400": { "description": "Failed to create person due to validation errors.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "FailedToCreatePerson", "description": "Failed to create person due to validation errors.", "examples": [ { "code": 1000, "message": "Failed to create person due to validation errors.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/vct/kya/individual/v1": { "get": { "tags": [ "Registry" ], "summary": "Fetch the individual credential's type metadata", "description": "SD-JWT VC Type Metadata for the individual credential: its display name and, per claim, a label, whether the claim is selectively disclosable, and whether it is mandatory. The URL is the credential's `vct`, served only on the production registry host. Unauthenticated; cacheable for one hour.", "operationId": "vct_kya_individual_get", "responses": { "200": { "description": "The Type Metadata document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeMetadata" } } } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The request's Host is not the production registry host.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/vct/kya/business/v1": { "get": { "tags": [ "Registry" ], "summary": "Fetch the business credential's type metadata", "description": "SD-JWT VC Type Metadata for the business credential: its display name and, per claim, a label, whether the claim is selectively disclosable, and whether it is mandatory. The URL is the credential's `vct`, served only on the production registry host. Unauthenticated; cacheable for one hour.", "operationId": "vct_kya_business_get", "responses": { "200": { "description": "The Type Metadata document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeMetadata" } } } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The request's Host is not the production registry host.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/statuslists/{list_id}": { "get": { "tags": [ "Registry" ], "summary": "Fetch the credential status list token", "description": "The OAuth Token Status List `list_id` of the issuer whose registry host the request names; production and sandbox each serve their own. An issuer fills list 1, then list 2, and so on; a list it has not allocated is 404. Each credential's `status` claim names its own list URI on its issuer's host and a bit index; bit set means revoked. Returned as a signed `statuslist+jwt` verifiable against the issuer's published JWKS. Unauthenticated; cacheable for at most the token's `ttl` claim, which this response's max-age mirrors.", "operationId": "statuslists_get", "parameters": [ { "name": "list_id", "in": "path", "required": true, "schema": { "type": "string", "title": "List Id" } } ], "responses": { "200": { "description": "The signed status list token.", "content": { "application/statuslist+jwt": {} } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The Host is not a registry host, or the issuer has not allocated this list; every miss answers alike.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/.well-known/did.json": { "get": { "tags": [ "Registry" ], "summary": "Resolve the credential issuer's DID document", "description": "The W3C DID document for the Baselayer credential issuer whose registry host the request names: production and sandbox each publish their own on their own host. It carries the same keys as the host's JWT VC Issuer Metadata, for did-aware tooling; credentials name an https issuer, so verifiers resolve keys through `/.well-known/jwt-vc-issuer`. Keys publish ahead of activation and remain published through rotation overlap, so verifier caches stay warm. Unauthenticated; cacheable for one hour.", "operationId": "well_known_did_get", "responses": { "200": { "description": "The issuer's DID document (W3C DID core).", "content": { "application/did+json": { "schema": { "properties": { "@context": { "items": { "type": "string" }, "type": "array", "title": "@Context" }, "id": { "type": "string", "title": "Id" }, "verificationMethod": { "items": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "type": "string", "const": "JsonWebKey2020", "title": "Type", "default": "JsonWebKey2020" }, "controller": { "type": "string", "title": "Controller" }, "publicKeyJwk": { "properties": { "kty": { "type": "string", "const": "OKP", "title": "Kty", "default": "OKP" }, "crv": { "type": "string", "const": "Ed25519", "title": "Crv", "default": "Ed25519" }, "x": { "type": "string", "title": "X" }, "kid": { "type": "string", "title": "Kid" }, "alg": { "type": "string", "const": "EdDSA", "title": "Alg", "default": "EdDSA" }, "use": { "type": "string", "const": "sig", "title": "Use", "default": "sig" } }, "additionalProperties": false, "type": "object", "required": [ "x", "kid" ], "title": "Ed25519PublicJWK", "description": "Public half of a KYA issuer signing key, as an RFC 8037 OKP JWK.\n\nThe wire form the did:web document and JWKS render verbatim, and the\nshape stored on ``IssuerKey.public_jwk`` — public material only, never\nthe seed. ``kid`` is the RFC 7638 JWK thumbprint of the key, so it is\nderivable from the key material alone and can never drift from ``x``." } }, "additionalProperties": false, "type": "object", "required": [ "id", "controller", "publicKeyJwk" ], "title": "Ed25519VerificationMethod", "description": "One issuer key as a W3C DID core verification method.\n\n``id`` is the controller DID plus the key's ``kid`` as the fragment\n(``did:web:…#``), so the bare ``kid`` a JWT header names resolves\nto exactly one method in the document. ``JsonWebKey2020`` carries the\npublic key verbatim as ``publicKeyJwk``." }, "type": "array", "title": "Verificationmethod" }, "assertionMethod": { "items": { "type": "string" }, "type": "array", "title": "Assertionmethod" } }, "additionalProperties": false, "type": "object", "required": [ "id", "verificationMethod", "assertionMethod" ], "title": "DIDDocument", "description": "The issuer's did:web document, resolved at ``/.well-known/did.json``.\n\nRenders the published rotation set: one verification method per\npending, active, or retiring key, every one referenced from\n``assertionMethod`` since counterparties verify credential signatures\n(assertions) against these keys. Wire names are the W3C forms, hence\nthe aliases." }, "example": { "@context": [ "https://www.w3.org/ns/did/v1", "https://w3id.org/security/suites/jws-2020/v1" ], "id": "did:web:registry.baselayer.com", "verificationMethod": [ { "id": "did:web:registry.baselayer.com#kPrK_qmxVWaYVA9wwBF6Iuo3vVzz7TxHCTwXBygrS4k", "type": "JsonWebKey2020", "controller": "did:web:registry.baselayer.com", "publicKeyJwk": { "kty": "OKP", "crv": "Ed25519", "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo", "kid": "kPrK_qmxVWaYVA9wwBF6Iuo3vVzz7TxHCTwXBygrS4k", "alg": "EdDSA", "use": "sig" } } ], "assertionMethod": [ "did:web:registry.baselayer.com#kPrK_qmxVWaYVA9wwBF6Iuo3vVzz7TxHCTwXBygrS4k" ] } } } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The request's Host is not one of the issuers' registry hosts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/.well-known/jwks.json": { "get": { "tags": [ "Registry" ], "summary": "Fetch the credential issuer's public keys (JWKS)", "description": "The published public keys of the credential issuer whose registry host the request names, as an RFC 7517 JSON Web Key Set — the same rotation set that host's DID document carries, for verifiers that consume a JWKS directly. Unauthenticated; cacheable for one hour.", "operationId": "well_known_jwks_get", "responses": { "200": { "description": "The issuer's published public keys (RFC 7517).", "content": { "application/jwk-set+json": { "schema": { "properties": { "keys": { "items": { "properties": { "kty": { "type": "string", "const": "OKP", "title": "Kty", "default": "OKP" }, "crv": { "type": "string", "const": "Ed25519", "title": "Crv", "default": "Ed25519" }, "x": { "type": "string", "title": "X" }, "kid": { "type": "string", "title": "Kid" }, "alg": { "type": "string", "const": "EdDSA", "title": "Alg", "default": "EdDSA" }, "use": { "type": "string", "const": "sig", "title": "Use", "default": "sig" } }, "additionalProperties": false, "type": "object", "required": [ "x", "kid" ], "title": "Ed25519PublicJWK", "description": "Public half of a KYA issuer signing key, as an RFC 8037 OKP JWK.\n\nThe wire form the did:web document and JWKS render verbatim, and the\nshape stored on ``IssuerKey.public_jwk`` — public material only, never\nthe seed. ``kid`` is the RFC 7638 JWK thumbprint of the key, so it is\nderivable from the key material alone and can never drift from ``x``." }, "type": "array", "title": "Keys" } }, "additionalProperties": false, "type": "object", "required": [ "keys" ], "title": "JSONWebKeySet", "description": "RFC 7517 JWKS of the issuer's published public keys." }, "example": { "keys": [ { "kty": "OKP", "crv": "Ed25519", "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo", "kid": "kPrK_qmxVWaYVA9wwBF6Iuo3vVzz7TxHCTwXBygrS4k", "alg": "EdDSA", "use": "sig" } ] } } } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The request's Host is not one of the issuers' registry hosts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/.well-known/jwt-vc-issuer": { "get": { "tags": [ "Registry" ], "summary": "Fetch the credential issuer's JWT VC Issuer Metadata", "description": "JWT VC Issuer Metadata (draft-ietf-oauth-sd-jwt-vc-19 §4) for the credential issuer whose registry host the request names: `issuer` equals the `iss` of every credential that issuer signs, and `jwks` carries the same rotation set as that host's JWKS. Verifiers resolve a credential's signing key here. Unauthenticated; cacheable for one hour.", "operationId": "well_known_jwt_vc_issuer_get", "responses": { "200": { "description": "The issuer's metadata and public keys.", "content": { "application/json": { "schema": { "properties": { "issuer": { "type": "string", "title": "Issuer" }, "jwks": { "properties": { "keys": { "items": { "properties": { "kty": { "type": "string", "const": "OKP", "title": "Kty", "default": "OKP" }, "crv": { "type": "string", "const": "Ed25519", "title": "Crv", "default": "Ed25519" }, "x": { "type": "string", "title": "X" }, "kid": { "type": "string", "title": "Kid" }, "alg": { "type": "string", "const": "EdDSA", "title": "Alg", "default": "EdDSA" }, "use": { "type": "string", "const": "sig", "title": "Use", "default": "sig" } }, "additionalProperties": false, "type": "object", "required": [ "x", "kid" ], "title": "Ed25519PublicJWK", "description": "Public half of a KYA issuer signing key, as an RFC 8037 OKP JWK.\n\nThe wire form the did:web document and JWKS render verbatim, and the\nshape stored on ``IssuerKey.public_jwk`` — public material only, never\nthe seed. ``kid`` is the RFC 7638 JWK thumbprint of the key, so it is\nderivable from the key material alone and can never drift from ``x``." }, "type": "array", "title": "Keys" } }, "additionalProperties": false, "type": "object", "required": [ "keys" ], "title": "JSONWebKeySet", "description": "RFC 7517 JWKS of the issuer's published public keys." } }, "additionalProperties": false, "type": "object", "required": [ "issuer", "jwks" ], "title": "JWTVCIssuerMetadata", "description": "JWT VC Issuer Metadata (draft-ietf-oauth-sd-jwt-vc-19 §4.2): the\ncredential ``iss`` and its keys inline, never a ``jwks_uri`` beside them." }, "example": { "issuer": "https://registry.baselayer.com", "jwks": { "keys": [ { "kty": "OKP", "crv": "Ed25519", "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo", "kid": "kPrK_qmxVWaYVA9wwBF6Iuo3vVzz7TxHCTwXBygrS4k", "alg": "EdDSA", "use": "sig" } ] } } } } }, "400": { "description": "The request's Host is missing, repeated or malformed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidHostHeader", "description": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "examples": [ { "type": "invalid_host_header", "code": 6317, "message": "The request's Host header is missing, repeated or malformed; send exactly one Host of the form host[:port].", "metadata": {} } ] } } } }, "404": { "description": "The request's Host is not one of the issuers' registry hosts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/issuance/audit_log": { "get": { "tags": [ "Audit Log" ], "summary": "Read the calling organization's slice of the audit log", "description": "Returns identity registration, credential issuance, and revocation events, scoped to an `individual_ref`, `business_ref`, or `credential_id` your organization already holds — at least one is required. Reads the sequenced log, which the batch sequencer populates asynchronously, so very recent events may lag slightly behind the fast-store freshness path.", "operationId": "issuance_audit_log_list", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "individual_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref" } }, { "name": "business_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref" } }, { "name": "credential_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credential Id" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuditEventType" }, { "type": "null" } ], "title": "Event Type" } }, { "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/AuditLogSortField" }, { "type": "null" } ], "description": "`occurred_at`: the entry's `created_at`, when it was recorded in the log, with `seq` breaking ties. Defaults to `occurred_at` `desc`.", "title": "Sort" }, "description": "`occurred_at`: the entry's `created_at`, when it was recorded in the log, with `seq` breaking ties. Defaults to `occurred_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: `occurred_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `occurred_at` `desc`." } ], "responses": { "200": { "description": "Audit-log entries in the requested order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.AuditLogEntryResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.AuditLogEntryResponse" } } } }, "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" } } } }, "404": { "description": "The individual_ref, business_ref, or credential_id is unknown or belongs to another organization — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "No scoping filter was provided, or event_type named an event type this route doesn't expose.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidAuditLogQuery", "description": "The audit-log query requires at least one of individual_ref, business_ref, or credential_id to scope the read to your organization's own refs, and event_type (when given) must be one this route exposes.", "examples": [ { "type": "invalid_audit_log_query", "code": 6310, "message": "The audit-log query requires at least one of individual_ref, business_ref, or credential_id to scope the read to your organization's own refs, and event_type (when given) must be one this route exposes.", "metadata": {} } ] } } } } } } }, "/issuance/credentials/events": { "get": { "tags": [ "Credentials" ], "summary": "List your organization's credential events", "description": "Every issuance and revocation of your organization's credentials, newest first by default, a page at a time: `limit`, then `cursor` from `X-Next-Cursor`, or `offset`. `X-Total-Count` and `X-Total-Pages` count every match and are sent on the first cursor page and on every offset page.", "operationId": "issuance_credentials_events_list", "security": [ { "APIKeyHeader": [] } ], "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/CredentialEventSortField" }, { "type": "null" } ], "description": "`occurred_at`: when the credential was issued or revoked; ties break on the credential's `created_at`, then its id, then the event (`ISSUED` before `REVOKED` ascending). Defaults to `occurred_at` `desc`.", "title": "Sort" }, "description": "`occurred_at`: when the credential was issued or revoked; ties break on the credential's `created_at`, then its id, then the event (`ISSUED` before `REVOKED` ascending). Defaults to `occurred_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: `occurred_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `occurred_at` `desc`." }, { "name": "level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CredentialMintLevel" } }, { "type": "null" } ], "description": "Only credentials of these levels; repeat for more than one. Default all.", "title": "Level" }, "description": "Only credentials of these levels; repeat for more than one. Default all." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IssuedCredentialLifecycleState" }, { "type": "null" } ], "description": "Only events of credentials in this state now.", "title": "State" }, "description": "Only events of credentials in this state now." }, { "name": "individual_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this individual or by them for a business.", "title": "Individual Ref" }, "description": "Only credentials minted for this individual or by them for a business." }, { "name": "business_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this business.", "title": "Business Ref" }, "description": "Only credentials minted for this business." }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "description": "Every word must match the person's or business's name as the credential minted it, the audience or the credential id; a `individual_ref` or `business_ref` your organization holds matches exactly.", "title": "Search" }, "description": "Every word must match the person's or business's name as the credential minted it, the audience or the credential id; a `individual_ref` or `business_ref` your organization holds matches exactly." }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CredentialEventKind" } }, { "type": "null" } ], "description": "Only these events; repeat for several.", "title": "Event Type" }, "description": "Only these events; repeat for several." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Credential events in the requested order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.CredentialEventResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.CredentialEventResponse" } } } }, "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": {} } ] } } } } } } }, "/issuance/credentials/events/export": { "get": { "tags": [ "Credentials" ], "summary": "Export your organization's credential events", "description": "Every event the same filters list, as CSV in the list's order, streamed with no row cap.", "operationId": "issuance_credentials_events_export", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CredentialEventSortField" }, { "type": "null" } ], "description": "`occurred_at`: when the credential was issued or revoked; ties break on the credential's `created_at`, then its id, then the event (`ISSUED` before `REVOKED` ascending). Defaults to `occurred_at` `desc`.", "title": "Sort" }, "description": "`occurred_at`: when the credential was issued or revoked; ties break on the credential's `created_at`, then its id, then the event (`ISSUED` before `REVOKED` ascending). Defaults to `occurred_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: `occurred_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `occurred_at` `desc`." }, { "name": "level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CredentialMintLevel" } }, { "type": "null" } ], "description": "Only credentials of these levels; repeat for more than one. Default all.", "title": "Level" }, "description": "Only credentials of these levels; repeat for more than one. Default all." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IssuedCredentialLifecycleState" }, { "type": "null" } ], "description": "Only events of credentials in this state now.", "title": "State" }, "description": "Only events of credentials in this state now." }, { "name": "individual_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this individual or by them for a business.", "title": "Individual Ref" }, "description": "Only credentials minted for this individual or by them for a business." }, { "name": "business_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this business.", "title": "Business Ref" }, "description": "Only credentials minted for this business." }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "description": "Every word must match the person's or business's name as the credential minted it, the audience or the credential id; a `individual_ref` or `business_ref` your organization holds matches exactly.", "title": "Search" }, "description": "Every word must match the person's or business's name as the credential minted it, the audience or the credential id; a `individual_ref` or `business_ref` your organization holds matches exactly." }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CredentialEventKind" } }, { "type": "null" } ], "description": "Only these events; repeat for several.", "title": "Event Type" }, "description": "Only these events; repeat for several." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Every event matching the filters, as CSV.", "content": { "text/csv": {} } }, "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": {} } ] } } } } } } }, "/issuance/credentials": { "post": { "tags": [ "Credentials" ], "summary": "Mint a credential for a person or a business operator", "description": "Mints an L2 or L3 SD-JWT-VC credential for a verified individual, referenced by the `individual_ref` issued to your organization, scoped to a counterparty `audience`, and bound to the presenting agent's public key. `type` chooses whose credential: `INDIVIDUAL` for the person as themselves, `BUSINESS` for the person acting as the operator of the business `business_ref` names, which is never inferred and requires a verified operator link. Every credential is issuer-signed with `sub` (the audience-scoped pairwise DID of the person or business, stable across mints and levels) and `aud` (the canonical audience). A business L3 mint answers with two credentials, the business's and the actor's. Credentials are short-lived projections of current verification: mint on demand rather than storing them long-term. Send an `Idempotency-Key`: a retry with the same key and body within 24 hours answers with the same credentials, marked `Idempotent-Replayed: true`, instead of minting again.", "operationId": "issuance_credentials_create", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key and body within 24 hours answers with the first one's response, marked `Idempotent-Replayed: true`, without minting again. The same key with a different body is refused with 422, and a retry that arrives while the first is still running with 409. Keys are scoped to your application.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key and body within 24 hours answers with the first one's response, marked `Idempotent-Replayed: true`, without minting again. The same key with a different body is refused with 422, and a retry that arrives while the first is still running with 409. Keys are scoped to your application." } ], "responses": { "201": { "description": "The minted credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintResponse" } } }, "headers": { "Location": { "description": "The minted credential's record, `/issuance/credentials/{credential_id}`; for a pair, the subject's.", "schema": { "type": "string" } } } }, "404": { "description": "The individual_ref or business_ref is unknown or was issued to another organization — the cases are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "The person's verified-identity snapshot is superseded or expired, or (business) no verified operator link exists between the person and the business, or a request with the same `Idempotency-Key` is still running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The mint payload failed validation, the audience cannot be canonicalized, a requested disclosure field is outside the vault schema, a business credential is requested at L2 (a business credential is L3 only), the `Idempotency-Key` is missing, or it was already used with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintRequest" } } } } }, "get": { "tags": [ "Credentials" ], "summary": "List your organization's credential records", "description": "Lists the records of every credential your organization minted, newest first by default — the durable evidence log behind the short-lived credentials themselves. Filter by subject (`individual_ref` / `business_ref`), counterparty `audience`, `level`, `state`, `credential_id` and issuance date range. Each record carries the credential's current revocation status. The credential string is never listed; `GET /issuance/credentials/{credential_id}` returns it.", "operationId": "issuance_credentials_list", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "individual_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this individual or by this acting individual for a business.", "title": "Individual Ref" }, "description": "Only credentials minted for this individual or by this acting individual for a business." }, { "name": "business_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "Only credentials minted for this pairwise business reference.", "title": "Business Ref" }, "description": "Only credentials minted for this pairwise business reference." }, { "name": "audience", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ], "description": "Only credentials scoped to this audience, canonicalized as a mint's `audience` is.", "title": "Audience" }, "description": "Only credentials scoped to this audience, canonicalized as a mint's `audience` is." }, { "name": "level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CredentialMintLevel" } }, { "type": "null" } ], "description": "Only credentials of these levels; repeat for more than one.", "title": "Level" }, "description": "Only credentials of these levels; repeat for more than one." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IssuedCredentialLifecycleState" }, { "type": "null" } ], "description": "Only credentials in this derived lifecycle, with expiry read against the time of the request: `ACTIVE` (valid and unexpired), `EXPIRED` (valid but past expiry), or `REVOKED`. It selects on each record's `state`; `status` keeps the persisted revocation standing, so an expired credential is `status: VALID`, `state: EXPIRED`.", "title": "State" }, "description": "Only credentials in this derived lifecycle, with expiry read against the time of the request: `ACTIVE` (valid and unexpired), `EXPIRED` (valid but past expiry), or `REVOKED`. It selects on each record's `state`; `status` keeps the persisted revocation standing, so an expired credential is `status: VALID`, `state: EXPIRED`." }, { "name": "credential_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "description": "Only the credential with this id.", "title": "Credential Id" }, "description": "Only the credential with this id." }, { "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/CredentialSortField" }, { "type": "null" } ], "description": "`issued_at` (when the credential was issued) or `expires_at`; ties break on `created_at`, then the record's id. Defaults to `issued_at` `desc`.", "title": "Sort" }, "description": "`issued_at` (when the credential was issued) or `expires_at`; ties break on `created_at`, then the record's id. Defaults to `issued_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: `issued_at` `desc`, `expires_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `issued_at` `desc`, `expires_at` `desc`." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Paginated credential records in the requested order, scoped to the calling organization's own mints.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.IssuedCredentialResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.IssuedCredentialResponse" } } } }, "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" } } } }, "404": { "description": "A subject-reference filter is unknown or was issued to another organization — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "The audience filter cannot be canonicalized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "CredentialAudienceInvalid", "description": "The audience cannot be canonicalized: send a bare domain or, for an agent credential, an https authorization-server identifier with no path, query, fragment or non-default port.", "examples": [ { "type": "credential_audience_invalid", "code": 6304, "message": "The audience cannot be canonicalized: send a bare domain or, for an agent credential, an https authorization-server identifier with no path, query, fragment or non-default port.", "metadata": {} } ] } } } } } } }, "/issuance/credentials/preview": { "post": { "tags": [ "Credentials" ], "summary": "Preview what an L3 mint would disclose", "description": "Takes the mint body and returns the exact leaves an L3 mint with the same body would disclose, and the requested paths with nothing on file, one entry per credential the mint would produce. A business preview also returns the operator authorization the credential always carries. Runs the mint's validation and refusals; signs, stores and allocates nothing.", "operationId": "issuance_credentials_preview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewResponse" } } } }, "404": { "description": "A reference is unknown or was issued to another organization — the cases are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "The mint would be refused: the snapshot is not current, or (business) the operator link is not verified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "CredentialSnapshotNotCurrent", "description": "The subject's verified-identity snapshot is superseded or expired; re-verify before minting.", "examples": [ { "type": "credential_snapshot_not_current", "code": 6301, "message": "The subject's verified-identity snapshot is superseded or expired; re-verify before minting.", "metadata": {} } ] } } } }, "422": { "description": "The body failed validation (including an L2 level), the audience cannot be canonicalized, or a path is outside the vault schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidCredentialMintPayload", "description": "The credential mint payload failed validation.", "examples": [ { "type": "invalid_credential_mint_payload", "code": 6303, "message": "The credential mint payload failed validation.", "metadata": {} } ] } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-computation": true } }, "/issuance/credentials/test": { "post": { "tags": [ "Credentials" ], "summary": "Mint a test credential for a person or a business operator", "description": "Takes the `POST /issuance/credentials` body and mints the same credential, with the same claims, for a person or business your current environment's refs name, signed by the sandbox issuer and recorded in your Sandbox environment, from Production or Sandbox alike. Verifiers accept it only when they allow sandbox credentials. Its `sub` is a pairwise DID of its own, never the one a `POST /issuance/credentials` mint signs for the same audience. Send an `Idempotency-Key`, as for `POST /issuance/credentials`.", "operationId": "issuance_credentials_test_create", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key and body within 24 hours answers with the first one's response, marked `Idempotent-Replayed: true`, without minting again. The same key with a different body is refused with 422, and a retry that arrives while the first is still running with 409. Keys are scoped to your application.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key and body within 24 hours answers with the first one's response, marked `Idempotent-Replayed: true`, without minting again. The same key with a different body is refused with 422, and a retry that arrives while the first is still running with 409. Keys are scoped to your application." } ], "responses": { "201": { "description": "The minted test credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintResponse" } } }, "headers": { "Location": { "description": "The minted credential's record, `/issuance/credentials/{credential_id}`, read in your Sandbox environment; for a pair, the subject's.", "schema": { "type": "string" } } } }, "404": { "description": "The individual_ref or business_ref is unknown, was issued to another organization or to your other environment — the cases are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "Your organization has no Sandbox environment, the person's verified-identity snapshot is superseded or expired, or (business) no verified operator link exists, or a request with the same `Idempotency-Key` is still running.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The mint payload failed validation, the audience cannot be canonicalized, a requested disclosure field is outside the vault schema, the `Idempotency-Key` is missing, or it was already used with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidCredentialMintPayload", "description": "The credential mint payload failed validation.", "examples": [ { "type": "invalid_credential_mint_payload", "code": 6303, "message": "The credential mint payload failed validation.", "metadata": {} } ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialMintRequest" } } } } } }, "/issuance/credentials/test/preview": { "post": { "tags": [ "Credentials" ], "summary": "Preview what an L3 test mint would disclose", "description": "`POST /issuance/credentials/preview` for `POST /issuance/credentials/test`: the same body and answer, with `environment` the Sandbox environment that would sign. Signs, stores and allocates nothing.", "operationId": "issuance_credentials_test_preview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CredentialPreviewResponse" } } } }, "404": { "description": "A reference is unknown, was issued to another organization or to your other environment — the cases are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "Your organization has no Sandbox environment, or the mint would be refused: the snapshot is not current, or (business) the operator link is not verified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The body failed validation (including an L2 level), the audience cannot be canonicalized, or a path is outside the vault schema.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "InvalidCredentialMintPayload", "description": "The credential mint payload failed validation.", "examples": [ { "type": "invalid_credential_mint_payload", "code": 6303, "message": "The credential mint payload failed validation.", "metadata": {} } ] } } } } }, "security": [ { "APIKeyHeader": [] } ], "x-computation": true } }, "/issuance/credentials/{credential_id}/revoke": { "post": { "tags": [ "Credentials" ], "summary": "Revoke one credential", "description": "Flips this credential's bit in the unified Token Status List, so verifiers refuse it from their next list fetch — for a leaked presentation or any single artifact that has to stop working before it expires. The revocation is scoped to this one credential: the subject keeps its authorization, so a replacement is a fresh mint away. Nothing is deleted — the record is evidence and stays readable at `GET /issuance/credentials/{credential_id}` with `status: REVOKED`; this action answers with that record. The reason and the revoking user or API key are recorded on the record and its audit event. Idempotent: revoking an already-revoked credential changes nothing, keeps the first reason and revoker, and returns the same record.", "operationId": "issuance_credentials_revoke", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The credential's unique id: the `jti` its token carries, as returned by the mint.", "title": "Credential Id" }, "description": "The credential's unique id: the `jti` its token carries, as returned by the mint." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.IssuedCredentialResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.IssuedCredentialResponse" } } } }, "404": { "description": "The id is unknown or names another organization's credential — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.RevokeCredentialRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.RevokeCredentialRequest" } } } } } }, "/issuance/credentials/presets": { "get": { "tags": [ "Credentials" ], "summary": "List the presets an L3 mint can disclose by", "description": "Lists the credential presets, by name by default, a page at a time (`limit`, default 10, maximum 1000; follow `X-Next-Cursor`): a use case an L3 mint can name as `preset` instead of listing `disclosed_fields`, with the exact paths it requests on an individual mint and on a business mint. Paths with nothing on file are skipped at mint time. `is_individual_default` and `is_business_default` name the most conservative preset per hat, the one a mint uses when it names none. The list is the same for every caller and fixed for an API release, so it may be cached for an hour.", "operationId": "issuance_credentials_presets_list", "security": [ { "APIKeyHeader": [] } ], "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/CredentialPresetSortField" }, { "type": "null" } ], "description": "`name`: the preset's label, ignoring case; ties break on `key`. Defaults to `name` `asc`.", "title": "Sort" }, "description": "`name`: the preset's label, ignoring case; ties break on `key`. Defaults to `name` `asc`." }, { "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: `name` `asc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `name` `asc`." } ], "responses": { "200": { "description": "The presets, in the requested order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.CredentialPresetResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.CredentialPresetResponse" } } } }, "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": {} } ] } } } } } } }, "/issuance/credentials/{credential_id}": { "get": { "tags": [ "Credentials" ], "summary": "Resolve one credential record by its credential_id", "description": "Resolves a `credential_id` — the token's `jti`, which a relying party's exchange log records — back to your organization's record: the dispute-evidence answer to \"was this agent authorized, for whom, and had it been revoked?\". Only your organization's own mints resolve. Callers who may mint credentials also get the credential string the mint returned, stored encrypted; it is holder-bound, so it cannot be presented without the agent's private key.", "operationId": "issuance_credentials_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The credential's unique id: the `jti` its token carries, as returned by the mint.", "title": "Credential Id" }, "description": "The credential's unique id: the `jti` its token carries, as returned by the mint." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.IssuedCredentialDetailResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.IssuedCredentialDetailResponse" } } } }, "404": { "description": "The id is unknown or names another organization's credential — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/directory/businesses": { "get": { "tags": [ "Directory" ], "summary": "Browse the directory of agent-ready businesses", "description": "Lists the businesses Baselayer has verified as set up to accept agentic payments, alphabetically by default. The directory is global — every organization reads the same registry — and carries public-record and self-declared commerce metadata only. Search by name or domain via `query`.", "operationId": "list_directory_businesses", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "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/DirectoryBusinessSortField" }, { "type": "null" } ], "description": "`name`: the display name, ignoring case; ties break on the profile's id. Defaults to `name` `asc`.", "title": "Sort" }, "description": "`name`: the display name, ignoring case; ties break on the profile's id. Defaults to `name` `asc`." }, { "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: `name` `asc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `name` `asc`." } ], "responses": { "200": { "description": "Paginated directory entries in the requested order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.DirectoryBusinessListItemResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.DirectoryBusinessListItemResponse" } } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/directory/businesses/{profile_id}": { "get": { "tags": [ "Directory" ], "summary": "Look up one directory entry", "description": "Returns the full directory entry: the business's profile, the public-record identity of the business it links to, the agentic payment rails it advertises, its published kya-profile.json disclosure scopes, points of contact, and the serving state of its counterparty credential. Unlisted and unknown ids are indistinguishable `404`s.", "operationId": "get_directory_business", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Profile Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DirectoryBusinessResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DirectoryBusinessResponse" } } } }, "404": { "description": "The id is unknown or the entry is not listed — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/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", "security": [ { "APIKeyHeader": [] } ], "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": {} } ] } } } } } } }, "/issuance/identities/businesses/{business_ref}/operator_links/{individual_ref}": { "get": { "tags": [ "Identities" ], "summary": "Get one operator link with its evidence", "description": "One link between the individual behind `individual_ref` and the business behind `business_ref`, with the evidence a credential minted for the pair now would assert.", "operationId": "issuance_identities_businesses_operator_links_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "business_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Business Ref" } }, { "name": "individual_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Individual Ref" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OperatorLinkDetailResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.OperatorLinkDetailResponse" } } } }, "404": { "description": "A ref is unknown or was issued to another organization, or your organization holds no link for the pair — all indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/businesses/{business_ref}/operator_links/{individual_ref}/decide": { "post": { "tags": [ "Identities" ], "summary": "Verify or reject that an individual operates a business", "description": "Records your organization's own decision on whether the individual behind `individual_ref` operates the business behind `business_ref` — for example after your own due diligence. The decision applies to your organization only: it never changes what another organization sees. `VERIFIED` affirms the relationship only: business credentials assert and are dated by what your own sessions found, so if that is more than a year old, re-verify the individual before minting. `REJECTED` stops new business credentials for the pair until you decide again, whatever later sessions score; credentials already minted stay valid until they expire or you revoke them. A later decision replaces an earlier one, with its decider, time and reason; repeating the link's current status records them again without changing it. You can decide a pair only once one of your own sessions has covered it. Returns the link as the list shows it.", "operationId": "issuance_identities_businesses_operator_links_decide", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "business_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Business Ref" } }, { "name": "individual_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Individual Ref" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OperatorLinkResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.OperatorLinkResponse" } } } }, "404": { "description": "A ref is unknown or was issued to another organization, or your organization holds no link for the pair — all indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessOperatorLinkDecisionRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.BusinessOperatorLinkDecisionRequest" } } } } } }, "/issuance/identities/verifications": { "post": { "tags": [ "Identities" ], "summary": "Start a direct verification", "description": "Verifies an identity you collected: an individual, or an individual and the business they operate. Verification runs asynchronously: the request is accepted with a `202` and the verification — poll `GET /issuance/identities/verifications/{verification_id}` or subscribe to the `Verification.completed` and `Verification.failed` webhooks for the outcome.\n\nThe body is chosen by `type`: `INDIVIDUAL` verifies `individual` alone, `BUSINESS` verifies `individual` with `business` and the link between them. It requires an `Idempotency-Key`. To re-verify an individual you already verified, use `POST /issuance/identities/individuals/{individual_ref}/reverify`.\n\nThis is direct verification: you send an identity you collected. For a hosted enrollment session, where the applicant completes your published journey on Baselayer's page, use `POST /onboarding/sessions`.", "operationId": "issuance_identities_verifications_create", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "description": "Required. An opaque key, ideally a UUID: a second request with the same key, path and body answers with the verification the first one created, marked `Idempotent-Replayed: true`; the same key with a different request is refused with 422. Keys are scoped to your application.", "title": "Idempotency-Key" }, "description": "Required. An opaque key, ideally a UUID: a second request with the same key, path and body answers with the verification the first one created, marked `Idempotent-Replayed: true`; the same key with a different request is refused with 422. Keys are scoped to your application." } ], "responses": { "202": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } } }, "headers": { "Location": { "description": "The verification to poll.", "schema": { "type": "string" } }, "Idempotent-Replayed": { "description": "`true` when the verification was answered from an earlier request with the same `Idempotency-Key`.", "schema": { "type": "string" } } } }, "409": { "description": "A request with this `Idempotency-Key` is still being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "IdempotencyKeyConflict", "description": "A request with this idempotency key is being processed and its resource could not be returned yet. Retry with the same key.", "examples": [ { "type": "idempotency_key_conflict", "code": 6701, "message": "A request with this idempotency key is being processed and its resource could not be returned yet. Retry with the same key.", "metadata": {} } ] } } } }, "422": { "description": "The body or the `Idempotency-Key` header is invalid, or the key was already used with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "IdempotencyKeyPayloadMismatch", "description": "This idempotency key was already used with a different request. Send a new key for a new request; see metadata.resource_id for the resource the key already names.", "examples": [ { "type": "idempotency_key_payload_mismatch", "code": 6700, "message": "This idempotency key was already used with a different request. Send a new key for a new request; see metadata.resource_id for the resource the key already names.", "metadata": {} } ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateVerificationRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateVerificationRequest" } } } } }, "get": { "tags": [ "Identities" ], "summary": "List direct verifications", "description": "Lists the verifications your application started through `POST /issuance/identities/verifications`, newest first by default. Filter by `reference_id` to find the verifications you started for one of your records.\n\nThis is direct verification: you send an identity you collected. For a hosted enrollment session, where the applicant completes your published journey on Baselayer's page, use `POST /onboarding/sessions`.", "operationId": "issuance_identities_verifications_list", "security": [ { "APIKeyHeader": [] } ], "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/v1.VerificationSortField" }, { "type": "null" } ], "description": "`created_at` (when it started) or `updated_at` (when it last changed); ties break on `created_at`, then the verification's id. Defaults to `created_at` `desc`.", "title": "Sort" }, "description": "`created_at` (when it started) or `updated_at` (when it last changed); ties break on `created_at`, then the verification'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`, `updated_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `created_at` `desc`, `updated_at` `desc`." }, { "name": "reference_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "description": "Only verifications started with this `reference_id`.", "title": "Reference Id" }, "description": "Only verifications started with this `reference_id`." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.VerificationState" }, { "type": "null" } ], "description": "Only verifications in this state.", "title": "State" }, "description": "Only verifications in this state." }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.VerificationType" }, { "type": "null" } ], "description": "Only `INDIVIDUAL` or only `BUSINESS` verifications.", "title": "Type" }, "description": "Only `INDIVIDUAL` or only `BUSINESS` verifications." } ], "responses": { "200": { "description": "Paginated verifications in the requested order.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.Verification" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.Verification" } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/verifications/{verification_id}": { "get": { "tags": [ "Identities" ], "summary": "Get a direct verification", "description": "Returns a verification: its state, verdicts, `terminal_reason`, and the pairwise references it issued.\n\nThis is direct verification: you send an identity you collected. For a hosted enrollment session, where the applicant completes your published journey on Baselayer's page, use `POST /onboarding/sessions`.", "operationId": "issuance_identities_verifications_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "verification_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Verification Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } } } }, "404": { "description": "The verification id is unknown to your application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/individuals": { "get": { "tags": [ "Identities" ], "summary": "List the individuals your organization has verified", "description": "Lists every individual your organization holds a `prn_` reference for, most recent activity first by default: their current verification state, the businesses they operate under your coverage, and when they last saw activity. Filter by verification state, business link and verification date; search by reference, name, email or phone. Scoped to your own population — references issued by other organizations are not listed and are not searchable.", "operationId": "issuance_identities_individuals_list", "security": [ { "APIKeyHeader": [] } ], "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/IdentityIndividualSortField" }, { "type": "null" } ], "description": "`last_activity`, `name` (given then family name, ignoring case) or `verified_at`; ties break on when the snapshot was recorded, then its id. Defaults to `last_activity` `desc`.", "title": "Sort" }, "description": "`last_activity`, `name` (given then family name, ignoring case) or `verified_at`; ties break on when the snapshot was recorded, then its id. Defaults to `last_activity` `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: `last_activity` `desc`, `name` `asc`, `verified_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `last_activity` `desc`, `name` `asc`, `verified_at` `desc`." }, { "name": "verification_state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IdentityVerificationState" }, { "type": "null" } ], "description": "Only identities in this derived state: CURRENT or EXPIRED. SUPERSEDED never matches: the list carries one row per person — their current verification — and superseded snapshots are lineage, not population.", "title": "Verification State" }, "description": "Only identities in this derived state: CURRENT or EXPIRED. SUPERSEDED never matches: the list carries one row per person — their current verification — and superseded snapshots are lineage, not population." }, { "name": "link", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IdentityDirectoryLink" }, { "type": "null" } ], "description": "`linked` (a verified link to a business), `link_request` (a link awaiting your review) or `none` (no business, or only rejected links). Your organization's own links only.", "title": "Link" }, "description": "`linked` (a verified link to a business), `link_request` (a link awaiting your review) or `none` (no business, or only rejected links). Your organization's own links only." }, { "name": "verified_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Only people whose current verification was recorded at or after this instant. Must carry a UTC offset.", "title": "Verified After" }, "description": "Only people whose current verification was recorded at or after this instant. Must carry a UTC offset." }, { "name": "verified_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Only people whose current verification was recorded before this instant (exclusive). Must carry a UTC offset.", "title": "Verified Before" }, "description": "Only people whose current verification was recorded before this instant (exclusive). Must carry a UTC offset." }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "description": "A `prn_` reference, or free text matched against name, email and phone. Every whitespace-separated term must match.", "title": "Search" }, "description": "A `prn_` reference, or free text matched against name, email and phone. Every whitespace-separated term must match." } ], "responses": { "200": { "description": "Paginated identities in the requested order, scoped to the calling organization.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.IdentityListItemResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.IdentityListItemResponse" } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/businesses": { "get": { "tags": [ "Identities" ], "summary": "List the businesses your organization has verified", "description": "Lists every business your organization holds a `bus_` reference for, most recent activity first by default: its registered name and state, what your latest evaluation concluded, how its operators stand, and when it last saw activity. Operator counts are reported per link status rather than collapsed into one verdict — a business can have settled operators and one awaiting review at the same time. Search by reference, EIN, or name.", "operationId": "issuance_identities_businesses_list", "security": [ { "APIKeyHeader": [] } ], "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/IdentityBusinessSortField" }, { "type": "null" } ], "description": "`last_activity`, `name` (legal name, ignoring case) or `created_at` (when your organization first held its reference); ties break on `created_at`, then the reference's id. Defaults to `last_activity` `desc`.", "title": "Sort" }, "description": "`last_activity`, `name` (legal name, ignoring case) or `created_at` (when your organization first held its reference); ties break on `created_at`, then the reference's id. Defaults to `last_activity` `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: `last_activity` `desc`, `name` `asc`, `created_at` `desc`.", "title": "Sort Direction" }, "description": "`asc` or `desc`, for every key of the sort. Defaults to the field's own: `last_activity` `desc`, `name` `asc`, `created_at` `desc`." }, { "name": "kyb_outcome", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/BusinessKybOutcome" }, { "type": "null" } ], "description": "Only businesses whose latest evaluation by your organization reached this outcome.", "title": "Kyb Outcome" }, "description": "Only businesses whose latest evaluation by your organization reached this outcome." }, { "name": "operator_link_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Only businesses with at least one covered operator link in this status.", "title": "Operator Link Status" }, "description": "Only businesses with at least one covered operator link in this status." }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "description": "A `bus_` reference, or free text matched against the registered business name; nine digits also match as an exact EIN.", "title": "Search" }, "description": "A `bus_` reference, or free text matched against the registered business name; nine digits also match as an exact EIN." }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Paginated businesses in the requested order, scoped to the calling organization.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessListItemResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessListItemResponse" } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/individuals/{individual_ref}": { "get": { "tags": [ "Identities" ], "summary": "Look up a verified identity by pairwise reference", "description": "Returns the verification state, verified-attribute keys, verification level, and covered business links for a `individual_ref` issued to your organization. References issued to other organizations and unknown references are indistinguishable `404`s.", "operationId": "issuance_identities_individuals_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "individual_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Individual Ref" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.IdentityStatusResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.IdentityStatusResponse" } } } }, "404": { "description": "The individual_ref is unknown or was issued to another organization — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/issuance/identities/individuals/{individual_ref}/reverify": { "post": { "tags": [ "Identities" ], "summary": "Re-verify an identity from its stored verification", "description": "Starts a fresh verification of the individual from the fields their current verification recorded. Nothing is collected from you and no stored field is echoed back. It requires an `Idempotency-Key`, and one re-verification runs at a time per individual: another while one is in flight answers `409`. The request is accepted with a `202` and the verification — poll `GET /issuance/identities/verifications/{verification_id}` or subscribe to the `Verification.completed` and `Verification.failed` webhooks for the outcome. An approved re-check supersedes the current verification and keeps the phone possession the individual last proved, with its original date; a failed, rejected or under-review one leaves the current verification unchanged.", "operationId": "issuance_identities_individuals_reverify", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "individual_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Individual Ref" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "description": "Required. An opaque key, ideally a UUID: a second request with the same key, path and body answers with the verification the first one created, marked `Idempotent-Replayed: true`; the same key with a different request is refused with 422. Keys are scoped to your application.", "title": "Idempotency-Key" }, "description": "Required. An opaque key, ideally a UUID: a second request with the same key, path and body answers with the verification the first one created, marked `Idempotent-Replayed: true`; the same key with a different request is refused with 422. Keys are scoped to your application." } ], "responses": { "202": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.Verification" } } }, "headers": { "Location": { "description": "The verification to poll.", "schema": { "type": "string" } }, "Idempotent-Replayed": { "description": "`true` when the verification was answered from an earlier request with the same `Idempotency-Key`.", "schema": { "type": "string" } } } }, "404": { "description": "The `individual_ref` is unknown to your application.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "A re-verification is already in flight for this individual, there is no current verification to re-verify from, or a request with this `Idempotency-Key` is still being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The `Idempotency-Key` header is missing or invalid, or the key was already used with a different request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "IdempotencyKeyPayloadMismatch", "description": "This idempotency key was already used with a different request. Send a new key for a new request; see metadata.resource_id for the resource the key already names.", "examples": [ { "type": "idempotency_key_payload_mismatch", "code": 6700, "message": "This idempotency key was already used with a different request. Send a new key for a new request; see metadata.resource_id for the resource the key already names.", "metadata": {} } ] } } } } } } }, "/issuance/identities/businesses/{business_ref}": { "get": { "tags": [ "Identities" ], "summary": "Look up a verified business by pairwise reference", "description": "Returns what the latest onboarding session that covered the business attested to, the registry incorporation facts, the people you hold covered operator links for, outstanding counterparty credentials, and your submission history for a `business_ref` issued to your organization. References issued to other organizations and unknown references are indistinguishable `404`s.", "operationId": "issuance_identities_businesses_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "business_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Business Ref" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessIdentityStatusResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.BusinessIdentityStatusResponse" } } } }, "404": { "description": "The business_ref is unknown or was issued to another organization — the two are indistinguishable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "type": "resource_not_found", "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "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": {} } ] } } } } } } }, "/onboarding/sessions": { "post": { "tags": [ "Onboarding" ], "summary": "Start a hosted enrollment session", "description": "Starts a session for one applicant on a customer journey you built and published in Console, and returns the `embed_url` where the applicant completes it. Call it from your server: the response carries a secret session token. A journey that was never published answers 409. When the session completes, the `OnboardingSession.completed` webhook fires and `GET /onboarding/sessions/{session_id}/results` returns the outcome.\n\nThis is a hosted enrollment session: the applicant completes your published journey on Baselayer's page. To verify an identity you collected yourself, use a direct verification, `POST /issuance/identities/verifications`.\n\nOnboarding must be enabled for your organization. Until it is, this endpoint answers 403 with error code 37.", "operationId": "create_onboarding_session_onboarding_sessions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateOnboardingSessionRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateOnboardingSessionResponse" } } } }, "403": { "description": "Onboarding is not enabled for the organization (code 37), or the credential lacks the onboarding permission this endpoint needs (code 30).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "ForbiddenOrganizationNotEnrolled", "description": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "examples": [ { "code": 37, "message": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "ForbiddenAccessNoPermission", "description": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "examples": [ { "code": 30, "message": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "metadata": {} } ] } ], "title": "Response 403 Create Onboarding Session Onboarding Sessions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/onboarding/sessions/{session_id}": { "get": { "tags": [ "Onboarding" ], "summary": "Get a hosted enrollment session", "description": "Returns a session's state, its verdict and `terminal_reason` once it ends, your `reference_id`, and when it started and ended. Poll it, or subscribe to the session's webhooks, to learn when the applicant finishes. The embed link is not returned here: keep the `embed_url` from the `POST /onboarding/sessions` response.\n\nThis is a hosted enrollment session: the applicant completes your published journey on Baselayer's page. To verify an identity you collected yourself, use a direct verification, `POST /issuance/identities/verifications`.\n\nOnboarding must be enabled for your organization. Until it is, this endpoint answers 403 with error code 37.", "operationId": "get_onboarding_session_onboarding_sessions__session_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OnboardingSessionReadResponse" } } } }, "403": { "description": "Onboarding is not enabled for the organization (code 37), or the credential lacks the onboarding permission this endpoint needs (code 30).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "ForbiddenOrganizationNotEnrolled", "description": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "examples": [ { "code": 37, "message": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "ForbiddenAccessNoPermission", "description": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "examples": [ { "code": 30, "message": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "metadata": {} } ] } ], "title": "Response 403 Get Onboarding Session Onboarding Sessions Session Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/onboarding/sessions/{session_id}/results": { "get": { "tags": [ "Onboarding" ], "summary": "Get a hosted enrollment session's results", "description": "Returns the outcome of a completed session: the verdict, what the applicant submitted, their confirmed identity, the business, beneficial owners, and each check's result. A session that has not completed answers 409.\n\nThis is a hosted enrollment session: the applicant completes your published journey on Baselayer's page. To verify an identity you collected yourself, use a direct verification, `POST /issuance/identities/verifications`.\n\nOnboarding must be enabled for your organization. Until it is, this endpoint answers 403 with error code 37.", "operationId": "get_onboarding_results_onboarding_sessions__session_id__results_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OnboardingSessionResultsResponse" } } } }, "403": { "description": "Onboarding is not enabled for the organization (code 37), or the credential lacks the onboarding permission this endpoint needs (code 30).", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "ForbiddenOrganizationNotEnrolled", "description": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "examples": [ { "code": 37, "message": "Forbidden access. The organization is not enrolled in the product this route belongs to.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "ForbiddenAccessNoPermission", "description": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "examples": [ { "code": 30, "message": "Forbidden access. The authentication credentials don't have appropriate permissions to access or affect the resource.", "metadata": {} } ] } ], "title": "Response 403 Get Onboarding Results Onboarding Sessions Session Id Results Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/website_analysis_requests": { "post": { "tags": [ "Website Analysis" ], "summary": "Post Website Analysis", "description": "Submit a website analysis request against a URL.", "operationId": "post_website_analysis_website_analysis_requests_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebsiteAnalysisRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Website Analysis" ], "summary": "Get Website Analysis Requests", "description": "Retrieve a list of Website Analyses.", "operationId": "get_website_analysis_requests_website_analysis_requests_get", "security": [ { "APIKeyHeader": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.WebsiteAnalysisResponse" }, "title": "Response Get Website Analysis Requests Website Analysis Requests Get" } } } } } } }, "/website_analysis_requests/{id}": { "get": { "tags": [ "Website Analysis" ], "summary": "Get Website Analysis Request", "description": "Retrieve a Website Analysis.", "operationId": "get_website_analysis_request_website_analysis_requests__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Website Analysis ID", "description": "The unique identifier of the Website Analysis to retrieve the details of.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the Website Analysis to retrieve the details of." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/website_analysis/{id}/screenshot": { "get": { "tags": [ "Website Analysis" ], "summary": "Get Website Analysis Screenshot", "description": "Retrieve the Website Analysis for a given search.", "operationId": "get_website_analysis_screenshot_website_analysis__id__screenshot_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Website Analysis ID", "description": "The unique identifier of the Website Analysis to retrieve the website screenshot for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the Website Analysis to retrieve the website screenshot for." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Redirect to a signed URL of the screenshot." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/web_presence_requests": { "post": { "tags": [ "Web Presence" ], "summary": "Post Web Presence Request", "description": "Submit a web presence request.", "operationId": "post_web_presence_request_web_presence_requests_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebPresenceRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebPresenceResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.WebPresenceResponse" } }, "application/vnd.baselayer.v2+json": { "schema": { "$ref": "#/components/schemas/v2.WebPresenceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Web Presence" ], "summary": "List Web Presence Requests", "description": "Retrieve a paginated list of Web Presence Requests.", "operationId": "list_web_presence_requests_web_presence_requests_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255 }, { "type": "null" } ], "description": "The query param, can either be a company name, a reference id, or a web presence request id. If it is a request id, it will be used to search by id. Otherwise it matches partial company names and reference ids case-insensitively. If it is not provided, it will be ignored.", "title": "Q" }, "description": "The query param, can either be a company name, a reference id, or a web presence request id. If it is a request id, it will be used to search by id. Otherwise it matches partial company names and reference ids case-insensitively. If it is not provided, it will be ignored." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of web presence requests.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v2.WebPresenceResponse" }, "title": "Response List Web Presence Requests Web Presence Requests Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/web_presence_requests/{id}": { "get": { "tags": [ "Web Presence" ], "summary": "Get Web Presence Request", "description": "Retrieve a Web Presence Request.", "operationId": "get_web_presence_request_web_presence_requests__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Web Presence Request ID", "description": "The unique identifier of the Web Presence request." }, "description": "The unique identifier of the Web Presence request." } ], "responses": { "200": { "description": "Web Presence Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebPresenceResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.WebPresenceResponse" } }, "application/vnd.baselayer.v2+json": { "schema": { "$ref": "#/components/schemas/v2.WebPresenceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/employee_verification_requests": { "post": { "tags": [ "Employee Verification" ], "summary": "Start Employee Verification Request", "description": "Start a new employee verification request.", "operationId": "start_employee_verification_request_employee_verification_requests_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequest", "title": "Employee Verification Request", "description": "The request containing person and business details to verify employment.", "examples": [ { "person_name": "Jane Smith", "business_name": "Acme Corp", "business_address": "123 Main St, Springfield, IL 62701" } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/employee_verification_requests/{id}": { "get": { "tags": [ "Employee Verification" ], "summary": "Get Employee Verification Request By Id", "description": "Retrieve an employee verification request by ID.", "operationId": "get_employee_verification_request_by_id_employee_verification_requests__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Employee Verification Request ID", "description": "The unique identifier of the employee verification request.", "examples": [ "789d65ed-bc67-4c97-a245-a22b6496fd93" ] }, "description": "The unique identifier of the employee verification request." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/federations/{federation_id}/organizations": { "get": { "tags": [ "Organization Management" ], "summary": "Get All Organizations For Federation Within Scope", "description": "Gets and returns all Organizations' profiles within a specific Federation.\n\nThe authenticated user must have the 'federation:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile within the Federation.\nIf the authenticated user is a User or an Organization, they can only access the profiles of their own Organization within the Federation.", "operationId": "get_all_organizations_for_federation_within_scope_federations__federation_id__organizations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "A search query to limit the Organizations returned by matching on ID, name, or external ID.", "examples": [ "Acme, Inc.", "Baselayer", "The Avengers" ] }, "description": "A search query to limit the Organizations returned by matching on ID, name, or external ID." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Organization Management" ], "summary": "Create Organization For Federation", "operationId": "create_organization_for_federation_federations__federation_id__organizations_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OrganizationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/organizations": { "post": { "tags": [ "Organization Management" ], "summary": "Create Organization", "operationId": "create_organization_organizations_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OrganizationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Organization Management" ], "summary": "Get All Organizations Within Scope", "description": "Gets and returns the all Organizations' profiles.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organizations' profiles.", "operationId": "get_all_organizations_within_scope_organizations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "A search query to limit the Organizations returned by matching on ID, name, or external ID.", "examples": [ "Acme, Inc.", "Baselayer", "The Avengers" ] }, "description": "A search query to limit the Organizations returned by matching on ID, name, or external ID." }, { "name": "unfederated", "in": "query", "required": false, "schema": { "type": "boolean", "title": "unfederated", "description": "When true, return only standalone Organizations (those not in any federation).", "default": false }, "description": "When true, return only standalone Organizations (those not in any federation)." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/organizations/{organization_id}": { "delete": { "tags": [ "Organization Management" ], "summary": "Delete Organization", "operationId": "delete_organization_organizations__organization_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Organization Management" ], "summary": "Patch Organization In Federation", "operationId": "patch_organization_in_federation_organizations__organization_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PatchFederatedOrganizationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OrganizationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Organization Management" ], "summary": "Get Organization", "description": "Gets and returns the Organization profile of a specific Organization.\nThe authenticated user must have the 'organizations:read' permission.\nIf the authenticated user is an Operator, they can access any Organizations' profile.\nIf the authenticated user is a User or an Organization, they can only access the profile of their own Organization.\n\nArgs:\n organization_id (uuid.UUID): The unique identifier of the Organization.\n auth_context (BaseAuthContext): The authentication context of the request.\n\nReturns:\n The Organization's profile.", "operationId": "get_organization_organizations__organization_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.OrganizationDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/federations/{federation_id}/webhooks": { "get": { "tags": [ "Federation Webhook Management" ], "summary": "List Federation Webhook Endpoints", "operationId": "list_federation_webhook_endpoints_federations__federation_id__webhooks_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseEndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Federation Webhook Management" ], "summary": "Create Federation Webhook Endpoint", "operationId": "create_federation_webhook_endpoint_federations__federation_id__webhooks_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointIn" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/federations/{federation_id}/webhooks/{endpoint_id}": { "get": { "tags": [ "Federation Webhook Management" ], "summary": "Get Federation Webhook Endpoint", "operationId": "get_federation_webhook_endpoint_federations__federation_id__webhooks__endpoint_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } }, { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Federation Webhook Management" ], "summary": "Update Federation Webhook Endpoint", "operationId": "update_federation_webhook_endpoint_federations__federation_id__webhooks__endpoint_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } }, { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Federation Webhook Management" ], "summary": "Patch Federation Webhook Endpoint", "operationId": "patch_federation_webhook_endpoint_federations__federation_id__webhooks__endpoint_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } }, { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Federation Webhook Management" ], "summary": "Delete Federation Webhook Endpoint", "operationId": "delete_federation_webhook_endpoint_federations__federation_id__webhooks__endpoint_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } }, { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/federations/{federation_id}/svix_portal_access": { "post": { "tags": [ "Federation Webhook Management" ], "summary": "Get Federation Svix Portal Access", "operationId": "get_federation_svix_portal_access_federations__federation_id__svix_portal_access_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "federation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Federation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/naics_prediction_requests/{id}/status": { "get": { "tags": [ "Industry Prediction" ], "summary": "Get Industry Prediction Status", "description": "Retrieve the status of the Industry code prediction request.", "operationId": "get_industry_prediction_status_naics_prediction_requests__id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Industry Prediction Request ID", "description": "The unique identifier of the Industry prediction request", "examples": [ "300a3e83-c6d0-4adb-9515-04d6ae5642a4" ] }, "description": "The unique identifier of the Industry prediction request" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PredictedNaicsRequestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/naics_prediction_requests/{id}": { "get": { "tags": [ "Industry Prediction" ], "summary": "Get Industry Prediction", "description": "Retrieve the Industry code prediction results.", "operationId": "get_industry_prediction_naics_prediction_requests__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Industry Prediction Request ID", "description": "The unique identifier of the Industry prediction request", "examples": [ "bff890c9-56fe-4773-9b52-833347d25281" ] }, "description": "The unique identifier of the Industry prediction request" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PredictedNaicsRequestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/naics_prediction_requests": { "post": { "tags": [ "Industry Prediction" ], "summary": "Post Naics Prediction Request", "description": "Submit an ad-hoc NAICS code prediction request.", "operationId": "post_naics_prediction_request_naics_prediction_requests_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdHocNAICSPredictionRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PredictedNaicsRequestResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.PredictedNaicsRequestResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/webhooks": { "get": { "tags": [ "Webhook Management" ], "summary": "List Webhook Endpoints", "operationId": "list_webhook_endpoints_webhooks_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseEndpointOut" } } } } }, "security": [ { "APIKeyHeader": [] } ] }, "post": { "tags": [ "Webhook Management" ], "summary": "Create Webhook Endpoint", "operationId": "create_webhook_endpoint_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointIn" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/webhooks/{endpoint_id}": { "get": { "tags": [ "Webhook Management" ], "summary": "Get Webhook Endpoint", "operationId": "get_webhook_endpoint_webhooks__endpoint_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Webhook Management" ], "summary": "Update Webhook Endpoint", "operationId": "update_webhook_endpoint_webhooks__endpoint_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Webhook Management" ], "summary": "Patch Webhook Endpoint", "operationId": "patch_webhook_endpoint_webhooks__endpoint_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Webhook Management" ], "summary": "Delete Webhook Endpoint", "operationId": "delete_webhook_endpoint_webhooks__endpoint_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9._-]{0,255}$", "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID.", "title": "Endpoint Id" }, "description": "A webhook endpoint id (`ep_…`) or customer-supplied UID." } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/addresses/{address_id}": { "get": { "tags": [ "Address" ], "summary": "Get Address", "description": "Get the details of a specific address.", "operationId": "get_address_addresses__address_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "address_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the address", "description": "The unique identifier of the address to fetch the details for.", "examples": [ "33b5b0fc-dd71-4a76-86b0-89f13537f33f" ] }, "description": "The unique identifier of the address to fetch the details for." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AddressResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AddressResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches": { "post": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Start Docket Search", "description": "Starts a new docket search for the given business UUID or person UUID.\n\nBy default, this endpoint executes synchronously and returns the completed\nresult. Send ``Prefer: respond-async`` to opt into asynchronous execution,\nwhich returns ``202 Accepted`` immediately and delivers results via\nwebhooks or polling.", "operationId": "start_docket_search_docket_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessDocketSearchRequest" }, { "$ref": "#/components/schemas/v1.PersonDocketSearchRequest" }, { "$ref": "#/components/schemas/v1.BusinessSearchDocketSearchRequest" } ], "title": "Litigation/Bankruptcy Request Object", "description": "The request object containing the business ID or person ID of the entity the litigation/bankruptcy search is going to be performed for", "examples": [ { "type": "Business", "business_id": "085b3e42-9c79-484b-b4c3-2e109da8b8ba", "options": [ "Order.Litigations", "Order.Bankruptcy" ] }, { "type": "Person", "person_id": "2ce89a49-f35f-4e26-a4fe-4537271f46e8", "options": [ "Order.Litigations", "Order.Bankruptcy" ] }, { "type": "BusinessSearch", "business_search_id": "46ecc293-c757-47f5-af4b-1c1f2e9c4660", "options": [ "Order.Litigations", "Order.Bankruptcy" ], "additional_search_entities": [ { "name": "John Doe", "type": "Person" }, { "name": "Alt Name LLC", "type": "Business" } ] } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get All Docket Searches", "description": "This endpoint returns all docket searches.", "operationId": "get_all_docket_searches_docket_searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "title": "Limit", "description": "The maximum number of docket searches to return.", "default": 10 }, "description": "The maximum number of docket searches to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "title": "Offset", "description": "The number of docket searches to skip before starting to return the docket searches.", "default": 0 }, "description": "The number of docket searches to skip before starting to return the docket searches." }, { "name": "type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SearchRequestSubjectType", "title": "Type", "description": "The type of docket searches to return.", "examples": [ "Business", "Person", "BusinessSearch" ] }, "description": "The type of docket searches to return." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.DocketSearchState" }, "title": "Response Get All Docket Searches Docket Searches Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/adhoc": { "post": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Start Docket Adhoc Search", "description": "Starts an ad-hoc docket search using a name (and optional options).\n\nBy default, this endpoint executes synchronously and returns the completed\nresult. Send ``Prefer: respond-async`` to opt into asynchronous execution,\nwhich returns ``202 Accepted`` immediately and delivers results via\nwebhooks or polling.", "operationId": "start_docket_adhoc_search_docket_searches_adhoc_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocDocketSearchRequest", "title": "Ad-hoc litigation/bankruptcy request", "description": "Start a docket search by name (optional search options).", "examples": [ { "name": "John Doe", "options": [ "Order.Litigations", "Order.Bankruptcy" ] }, { "name": "Acme Corp", "options": [ "Order.Litigations", "Order.Bankruptcy" ] } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocDocketSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AdhocDocketSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Adhoc Docket Searches", "description": "This endpoint returns all adhoc docket searches.", "operationId": "get_adhoc_docket_searches_docket_searches_adhoc_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "title": "Limit", "description": "The maximum number of docket searches to return.", "default": 10 }, "description": "The maximum number of docket searches to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "title": "Offset", "description": "The number of docket searches to skip before starting to return the docket searches.", "default": 0 }, "description": "The number of docket searches to skip before starting to return the docket searches." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.AdhocDocketSearchState" }, "title": "Response Get Adhoc Docket Searches Docket Searches Adhoc Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/{search_request_id}/status": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Search Status", "description": "Fetches the state of the docket search request with the given UUID.", "operationId": "get_docket_search_status_docket_searches__search_request_id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the litigation/bankruptcy search request to fetch the state for.", "description": "The unique identifier of the litigation/bankruptcy search request to fetch the state for.", "examples": [ "2847f069-ece3-4475-95f1-2759b00e8077" ] }, "description": "The unique identifier of the litigation/bankruptcy search request to fetch the state for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/{search_request_id}": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get All Dockets By Search Request Id", "description": "Fetches the most recent dockets for a given docket search request ID and returns all the associated dockets.", "operationId": "get_all_dockets_by_search_request_id_docket_searches__search_request_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the docket search request to fetch all dockets for.", "description": "The unique identifier of the docket search request to fetch all dockets for.", "examples": [ "13a1343b-e258-45d2-a12e-eef51b10d7e8" ] }, "description": "The unique identifier of the docket search request to fetch all dockets for." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/adhoc/{search_request_id}": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Adhoc Docket Search By Search Request Id", "description": "Fetches the most recent dockets for a given docket search request ID and returns all the associated dockets.", "operationId": "get_adhoc_docket_search_by_search_request_id_docket_searches_adhoc__search_request_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the adhoc docket search request to fetch all dockets for.", "description": "The unique identifier of the adhoc docket search request to fetch all dockets for.", "examples": [ "75763de4-fd08-4262-acb4-74ba9672308b" ] }, "description": "The unique identifier of the adhoc docket search request to fetch all dockets for." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocDocketSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AdhocDocketSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/dockets/{docket_id}/details": { "put": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Order Docket Details", "description": "Orders updates for the given docket from the court or cached version.", "operationId": "order_docket_details_dockets__docket_id__details_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of docket to fetch updates for.", "description": "The unique identifier of the docket to fetch updates for.", "examples": [ "db98a363-f89a-46e7-b8d1-3c992fff59ff" ] }, "description": "The unique identifier of the docket to fetch updates for." }, { "name": "from_court", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Whether to fetch directly from court.", "description": "Whether to fetch the docket details directly from the court. Defaults to False.", "default": false }, "description": "Whether to fetch the docket details directly from the court. Defaults to False." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Details", "description": "Fetches the most recent docket details for the given docket ID.", "operationId": "get_docket_details_dockets__docket_id__details_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of docket to get detials for.", "description": "The unique identifier of the docket to get details for.", "examples": [ "c0105cc7-458b-45bd-a727-9bb8ff81d1a0" ] }, "description": "The unique identifier of the docket to get details for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/details/{docket_details_request_id}": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Details By Request Id", "description": "Fetches the most recent docket details for the given docket details request ID.", "operationId": "get_docket_details_by_request_id_docket_searches_details__docket_details_request_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_details_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the docket to fetch details for.", "description": "The unique identifier of the docket to fetch details for.", "examples": [ "05697ecb-5471-4941-8826-f652bb06820a" ] }, "description": "The unique identifier of the docket to fetch details for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/details/{docket_details_request_id}/status": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Details Request Status", "description": "Fetches the state of the docket details request with the given UUID.", "operationId": "get_docket_details_request_status_docket_searches_details__docket_details_request_id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_details_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the docket to fetch details for.", "description": "The unique identifier of the docket to fetch details for.", "examples": [ "e147b723-cf99-4d92-9735-c7365f32d5b1" ] }, "description": "The unique identifier of the docket to fetch details for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/dockets/exhibits/{docket_exhibit_id}": { "put": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Order Docket Exhibit", "description": "Orders the document for the given docket exhibit from the court or cached version.", "operationId": "order_docket_exhibit_dockets_exhibits__docket_exhibit_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_exhibit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of docket exhibit to fetch documents for.", "description": "The unique identifier of the docket exhibit to fetch documents for.", "examples": [ "0be74582-6f94-4558-9c87-e801bf08b740" ] }, "description": "The unique identifier of the docket exhibit to fetch documents for." }, { "name": "from_court", "in": "query", "required": false, "schema": { "type": "boolean", "title": "Whether to fetch directly from court.", "description": "Whether to fetch the document directly from the court. Defaults to True as all cached versions will already be available.", "default": true }, "description": "Whether to fetch the document directly from the court. Defaults to True as all cached versions will already be available." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketExhibitState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Exhibit Document", "description": "Fetches the document associated with the given docket exhibit ID.", "operationId": "get_docket_exhibit_document_dockets_exhibits__docket_exhibit_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_exhibit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of docket exhibit to download.", "description": "The unique identifier of the docket exhibit to download documents for.", "examples": [ "8058d902-c2cc-4d55-9c21-f0d1dcbb5f22" ] }, "description": "The unique identifier of the docket exhibit to download documents for." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Download the docket exhibit document as a PDF file." }, "404": { "description": "The docket exhibit document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/docket_searches/exhibits/{docket_exhibit_request_id}/status": { "get": { "tags": [ "Litigation & Bankruptcy" ], "summary": "Get Docket Exhibit Request Status", "description": "Fetches the state of the docket exhibit document request with the given UUID.", "operationId": "get_docket_exhibit_request_status_docket_searches_exhibits__docket_exhibit_request_id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "docket_exhibit_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The ID of the docket exhibit to fetch the document for.", "description": "The unique identifier of the docket exhibit to fetch the document for.", "examples": [ "cf4dafaa-3c5b-4219-b676-2e6c443d24bd" ] }, "description": "The unique identifier of the docket exhibit to fetch the document for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketExhibitState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/reason_codes": { "get": { "tags": [ "Reason Codes" ], "summary": "List every reason code", "description": "Return the full catalog of reason codes, deprecated ones included.", "operationId": "list_reason_codes_reason_codes_get", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/v1.ReasonCodeResponse" }, "type": "array" } }, "application/vnd.baselayer.v1+json": { "schema": { "items": { "$ref": "#/components/schemas/v1.ReasonCodeResponse" }, "type": "array" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/dmf/searches": { "post": { "tags": [ "Death Master File" ], "summary": "Post Dmf Search", "description": "Submit a DMF search request with a person's name and SSN.", "operationId": "post_dmf_search_dmf_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DMFSearchRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/dmf/searches/{id}/status": { "get": { "tags": [ "Death Master File" ], "summary": "Get Dmf Search Status", "description": "Retrieve the status of the DMF search request.", "operationId": "get_dmf_search_status_dmf_searches__id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchStatusResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/dmf/searches/{id}": { "get": { "tags": [ "Death Master File" ], "summary": "Get Dmf Search", "description": "Retrieve the DMF search results.", "operationId": "get_dmf_search_dmf_searches__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.DMFResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/scra/searches": { "post": { "tags": [ "SCRA & MLA" ], "summary": "Scra Search", "operationId": "scra_search_scra_searches_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SCRASearchRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.SCRASearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SCRAResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.SCRAResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/mla/searches": { "post": { "tags": [ "SCRA & MLA" ], "summary": "Mla Search", "operationId": "mla_search_mla_searches_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MLASearchRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MLASearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MLAResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MLAResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/portfolio/items": { "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Item", "operationId": "create_portfolio_item_portfolio_items_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPortfolioItemRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Items", "operationId": "get_portfolio_items_portfolio_items_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio items will be returned." }, "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio items will be returned." }, { "name": "business_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "business_id", "description": "Return only the item monitoring this business. Use this to answer 'is this business in my portfolio?' -- it is an exact match, unlike `q`, which also matches names." }, "description": "Return only the item monitoring this business. Use this to answer 'is this business in my portfolio?' -- it is an exact match, unlike `q`, which also matches names." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of records to return in a single page. Must be between 1 and 100.", "default": 10, "title": "Limit" }, "description": "Maximum number of records to return in a single page. Must be between 1 and 100." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of portfolio items.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSummaryResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSummaryResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/bulk": { "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Items Bulk", "description": "Create Business portfolio items for many completed searches.\n\nRequest-level authorization and group lookup failures still fail the\nfull request. Per-search failures are returned in ``errors`` so the\ncaller can add every eligible row from a checkbox selection without\nretrying successful rows.\n\nBulk success and error rows are intentionally lightweight. The\nfrontend only needs IDs and stable error codes for row correlation,\ncache refreshes, and summary toasts, so the endpoint avoids full\nPortfolioItem serialization and verbose per-row errors.", "operationId": "create_portfolio_items_bulk_portfolio_items_bulk_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPortfolioItemsBulkRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPortfolioItemsBulkResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/portfolio/items/{item_id}": { "delete": { "tags": [ "Portfolio Monitoring" ], "summary": "Delete Portfolio Item", "operationId": "delete_portfolio_item_portfolio_items__item_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item", "operationId": "get_portfolio_item_portfolio_items__item_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Portfolio Item", "operationId": "update_portfolio_item_portfolio_items__item_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.UpdatePortfolioItemRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.UpdatePortfolioItemRequest" } } } } } }, "/portfolio/groups/{group_id}/items": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Group Items", "description": "Get all portfolio items in a specific group with pagination and filtering.\nItems are sorted by created_at in descending order.\nSupports filtering by date range and business name/ID.", "operationId": "get_portfolio_group_items_portfolio_groups__group_id__items_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio items will be returned." }, "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio items will be returned." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of records to return in a single page. Must be between 1 and 100.", "default": 10, "title": "Limit" }, "description": "Maximum number of records to return in a single page. Must be between 1 and 100." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSummaryResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSummaryResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/groups/{group_id}": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Group", "operationId": "get_portfolio_group_portfolio_groups__group_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Portfolio Group", "operationId": "update_portfolio_group_portfolio_groups__group_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortfolioGroupRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Portfolio Monitoring" ], "summary": "Delete Portfolio Group", "operationId": "delete_portfolio_group_portfolio_groups__group_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/groups": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Groups", "description": "Get all portfolio groups in the organization with pagination.\nGroups are sorted by created_at in descending order.\nOptionally filter by group name using the 'q' parameter.", "operationId": "get_portfolio_groups_portfolio_groups_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param to search by portfolio group name. If provided, only groups with names containing this term (case-insensitive) will be returned." }, "description": "The query param to search by portfolio group name. If provided, only groups with names containing this term (case-insensitive) will be returned." }, { "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Group", "operationId": "create_portfolio_group_portfolio_groups_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortfolioGroupRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupSummaryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/snapshots": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Snapshots", "description": "Retrieves a paginated list of snapshots for a specific portfolio item.\n\nSnapshots are ordered by created_at in descending order (newest first).", "operationId": "get_portfolio_item_snapshots_portfolio_items__item_id__snapshots_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the portfolio item.", "description": "The unique identifier of the portfolio item to fetch snapshots for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the portfolio item to fetch snapshots for." }, { "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/snapshots/{snapshot_id}": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Snapshot", "description": "Retrieves a specific snapshot for a portfolio item.\n\nReturns the snapshot data for the specified snapshot ID, including\nbusiness information, liens, dockets, and website analysis.", "operationId": "get_portfolio_item_snapshot_portfolio_items__item_id__snapshots__snapshot_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the portfolio item.", "description": "The unique identifier of the portfolio item to get snapshot for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the portfolio item to get snapshot for." }, { "name": "snapshot_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the snapshot.", "description": "The unique identifier of the snapshot to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the snapshot to retrieve." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/changes": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Changes", "description": "Retrieves all changes for a portfolio item across all snapshots.\n\nReturns a list of DiffChange objects representing all changes\nbetween consecutive snapshots for the portfolio item.", "operationId": "get_portfolio_item_changes_portfolio_items__item_id__changes_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the portfolio item.", "description": "The unique identifier of the portfolio item to get changes for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the portfolio item to get changes for." }, { "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.DiffChangeResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.DiffChangeResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/notifications": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Notifications", "description": "Retrieves all changes for a portfolio item across all snapshots.\n\nReturns a list of DiffChange objects representing all changes\nbetween consecutive snapshots for the portfolio item.", "operationId": "get_portfolio_item_notifications_portfolio_items__item_id__notifications_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the portfolio item.", "description": "The unique identifier of the portfolio item to get notifications for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the portfolio item to get notifications for." }, { "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioMonitoringNotificationResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioMonitoringNotificationResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/diff": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Snapshot Diff", "description": "Retrieves a diff between two snapshots of a portfolio item.\n\nThe diff shows the changes between the from_snapshot and to_snapshot,\nincluding business information, liens, dockets, and website analysis changes.\n\nArgs:\n format: The response format. Options:\n - json (default): Returns the full diff response with snapshots and changes\n - notifications: Returns notifications generated from the diff changes\n - json_patch: Returns only the JSON patch operations array", "operationId": "get_portfolio_item_snapshot_diff_portfolio_items__item_id__diff_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The unique identifier of the portfolio item.", "description": "The unique identifier of the portfolio item to get snapshot diff for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the portfolio item to get snapshot diff for." }, { "name": "from_snapshot_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The source snapshot ID", "description": "The unique identifier of the source snapshot for the diff.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the source snapshot for the diff." }, { "name": "to_snapshot_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "The target snapshot ID", "description": "The unique identifier of the target snapshot for the diff.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the target snapshot for the diff." }, { "name": "format", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/DiffFormat", "title": "Response format", "description": "The format of the response data.", "examples": [ "json", "notifications", "json_patch" ], "default": "json" }, "description": "The format of the response data." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotDiffResponse" }, { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioMonitoringNotificationResponse" } }, { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/AddOperation" }, { "$ref": "#/components/schemas/RemoveOperation" }, { "$ref": "#/components/schemas/ReplaceOperation" }, { "$ref": "#/components/schemas/MoveOperation" }, { "$ref": "#/components/schemas/CopyOperation" }, { "$ref": "#/components/schemas/CheckOperation" } ], "discriminator": { "propertyName": "op", "mapping": { "add": "#/components/schemas/AddOperation", "remove": "#/components/schemas/RemoveOperation", "replace": "#/components/schemas/ReplaceOperation", "move": "#/components/schemas/MoveOperation", "copy": "#/components/schemas/CopyOperation", "test": "#/components/schemas/CheckOperation" } } } } ], "title": "Response Get Portfolio Item Snapshot Diff Portfolio Items Item Id Diff Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/monitoring_policy": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Monitoring Policy", "description": "Get the monitoring policy for the portfolio.", "operationId": "get_portfolio_monitoring_policy_portfolio_monitoring_policy_get", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Portfolio Monitoring Policy", "description": "Update the monitoring policy for the portfolio.", "operationId": "update_portfolio_monitoring_policy_portfolio_monitoring_policy_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/portfolio/groups/{group_id}/monitoring_policy": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Group Monitoring Policy", "description": "Get the monitoring policy for a portfolio group.", "operationId": "get_portfolio_group_monitoring_policy_portfolio_groups__group_id__monitoring_policy_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Portfolio Group Monitoring Policy", "description": "Update the monitoring policy for a portfolio group.", "operationId": "update_portfolio_group_monitoring_policy_portfolio_groups__group_id__monitoring_policy_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } } } } }, "delete": { "tags": [ "Portfolio Monitoring" ], "summary": "Delete Portfolio Group Monitoring Policy", "description": "Delete the monitoring policy for a portfolio group.", "operationId": "delete_portfolio_group_monitoring_policy_portfolio_groups__group_id__monitoring_policy_delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/notification_policies": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Notification Policies", "description": "Get notification policies directly bound to the portfolio.\n\nA portfolio policy's digest covers every item in the portfolio,\nincluding items in groups that have policies of their own.", "operationId": "get_portfolio_notification_policies_portfolio_notification_policies_get", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" }, "type": "array" } }, "application/vnd.baselayer.v1+json": { "schema": { "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" }, "type": "array" } } } } }, "security": [ { "APIKeyHeader": [] } ] }, "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Notification Policy", "description": "Create a notification policy for the portfolio.\n\nIts digest covers every item in the portfolio, including items in\ngroups that have policies of their own.", "operationId": "create_portfolio_notification_policy_portfolio_notification_policies_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } } }, "required": true }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/portfolio/groups/{group_id}/notification_policies": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Group Notification Policies", "description": "Get notification policies directly bound to a portfolio group.\n\nA group policy's digest covers the group's items in addition to\nany portfolio-wide digest; it does not remove them from one.", "operationId": "get_portfolio_group_notification_policies_portfolio_groups__group_id__notification_policies_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Group Notification Policy", "description": "Create a notification policy for a portfolio group.\n\nIts digest covers the group's items in addition to any\nportfolio-wide digest; it does not remove them from one.", "operationId": "create_portfolio_group_notification_policy_portfolio_groups__group_id__notification_policies_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } } } } } }, "/portfolio/items/{item_id}/notification_policies": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Notification Policies", "description": "Get notification policies directly bound to a portfolio item.\n\nAn item policy's digest covers the item in addition to any\nportfolio or group digest; it does not remove the item from one.", "operationId": "get_portfolio_item_notification_policies_portfolio_items__item_id__notification_policies_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Portfolio Monitoring" ], "summary": "Create Portfolio Item Notification Policy", "description": "Create a notification policy for a portfolio item.\n\nIts digest covers the item in addition to any portfolio or group\ndigest; it does not remove the item from one.", "operationId": "create_portfolio_item_notification_policy_portfolio_items__item_id__notification_policies_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateNotificationPolicyRequest" } } } } } }, "/notification_policies/{notification_policy_id}": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Notification Policy", "description": "Get a notification policy by ID.", "operationId": "get_notification_policy_notification_policies__notification_policy_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "notification_policy_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Notification Policy Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Notification Policy", "description": "Update a notification policy by ID.", "operationId": "update_notification_policy_notification_policies__notification_policy_id__put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "notification_policy_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Notification Policy Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.NotificationPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.UpdateNotificationPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.UpdateNotificationPolicyRequest" } } } } }, "delete": { "tags": [ "Portfolio Monitoring" ], "summary": "Delete Notification Policy", "description": "Delete a notification policy by ID.", "operationId": "delete_notification_policy_notification_policies__notification_policy_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "notification_policy_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Notification Policy Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/monitoring_policy": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Monitoring Policy", "description": "Get the monitoring policy for a portfolio item.", "operationId": "get_portfolio_item_monitoring_policy_portfolio_items__item_id__monitoring_policy_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Portfolio Monitoring" ], "summary": "Update Portfolio Item Monitoring Policy", "description": "Update the monitoring policy for a portfolio item.", "operationId": "update_portfolio_item_monitoring_policy_portfolio_items__item_id__monitoring_policy_put", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.MonitoringPolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.CreateMonitoringPolicyRequest" } } } } }, "delete": { "tags": [ "Portfolio Monitoring" ], "summary": "Delete Portfolio Item Monitoring Policy", "description": "Delete the monitoring policy for a portfolio item.", "operationId": "delete_portfolio_item_monitoring_policy_portfolio_items__item_id__monitoring_policy_delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/monitoring_policies": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Monitoring Policies", "description": "Get all monitoring policies in the organization with pagination.\nPolicies are sorted by created_at in ascending order.", "operationId": "get_monitoring_policies_monitoring_policies_get", "security": [ { "APIKeyHeader": [] } ], "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.MonitoringPolicyListResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.MonitoringPolicyListResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/notification_policies": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Notification Policies", "description": "Get all notification policies in the organization with pagination.\nPolicies are sorted by created_at in ascending order.", "operationId": "get_notification_policies_notification_policies_get", "security": [ { "APIKeyHeader": [] } ], "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." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyListResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.NotificationPolicyListResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/updates": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Updates", "operationId": "get_portfolio_updates_portfolio_updates_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio updates will be returned." }, "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio updates will be returned." }, { "name": "attributes[]", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/NotifiableAttributes" } }, { "type": "null" } ], "description": "Filter by notification attributes", "title": "Attributes[]" }, "description": "Filter by notification attributes" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of records to return in a single page. Must be between 1 and 100.", "default": 10, "title": "Limit" }, "description": "Maximum number of records to return in a single page. Must be between 1 and 100." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/groups/{group_id}/updates": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Group Updates", "operationId": "get_portfolio_group_updates_portfolio_groups__group_id__updates_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Group Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio updates will be returned." }, "description": "The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio updates will be returned." }, { "name": "attributes[]", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/NotifiableAttributes" } }, { "type": "null" } ], "description": "Filter by notification attributes", "title": "Attributes[]" }, "description": "Filter by notification attributes" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of records to return in a single page. Must be between 1 and 100.", "default": 10, "title": "Limit" }, "description": "Maximum number of records to return in a single page. Must be between 1 and 100." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/portfolio/items/{item_id}/updates": { "get": { "tags": [ "Portfolio Monitoring" ], "summary": "Get Portfolio Item Updates", "operationId": "get_portfolio_item_updates_portfolio_items__item_id__updates_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "attributes[]", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/NotifiableAttributes" } }, { "type": "null" } ], "description": "Filter by notification attributes", "title": "Attributes[]" }, "description": "Filter by notification attributes" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of records to return in a single page. Must be between 1 and 100.", "default": 10, "title": "Limit" }, "description": "Maximum number of records to return in a single page. Must be between 1 and 100." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PortfolioItemUpdateResponse" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches": { "get": { "tags": [ "Lien Search" ], "summary": "Get All Lien Searches", "description": "This endpoint returns all lien searches.", "operationId": "get_all_lien_searches_lien_searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "title": "Limit", "description": "The maximum number of lien searches to return.", "default": 10 }, "description": "The maximum number of lien searches to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "title": "Offset", "description": "The number of lien searches to skip before starting to return the lien searches.", "default": 0 }, "description": "The number of lien searches to skip before starting to return the lien searches." }, { "name": "type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SearchRequestSubjectType", "title": "Type", "description": "The type of lien searches to return.", "examples": [ "Business", "Person", "BusinessSearch" ] }, "description": "The type of lien searches to return." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.LiensSearchState" }, "title": "Response Get All Lien Searches Lien Searches Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Lien Search" ], "summary": "Start Liens Search", "description": "This endpoint starts a liens search for a given person or business.\nExactly one of `business_id` or `person_id` must be provided. If `person_id`\nis provided, `search_states` must be provided.\n\nBy default, this endpoint executes synchronously and returns the completed\nresult. Send ``Prefer: respond-async`` to opt into asynchronous execution,\nwhich returns ``202 Accepted`` immediately and delivers results via\nwebhooks or polling.", "operationId": "start_liens_search_lien_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessLiensSearchRequest" }, { "$ref": "#/components/schemas/v1.PersonLiensSearchRequest" }, { "$ref": "#/components/schemas/v1.BusinessSearchLiensSearchRequest" } ], "title": "Liens Request Object", "description": "Request body for starting a liens search, discriminated by `type`. Use a business record with `business_id` (and optional `search_states`), or a person record with `person_id` and required `search_states`.", "examples": [ { "type": "Business", "business_id": "1991a845-6721-48c9-8463-92b2b4e09e64", "search_states": [ "CA", "NY" ] }, { "type": "Person", "person_id": "a4374bcd-9454-4da1-a385-af1cc027b558", "search_states": [ "DE", "NJ" ] }, { "type": "BusinessSearch", "business_search_id": "fcc84b87-f3a1-41e4-9e41-d5c8fb74193b", "search_states": [ "CA", "NY" ], "additional_search_entities": [ { "name": "John Doe", "type": "Person", "search_states": [ "CA" ] }, { "name": "Alt Name LLC", "type": "Business", "search_states": [ "NY", "CA" ] } ] } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches/adhoc": { "get": { "tags": [ "Lien Search" ], "summary": "Get Adhoc Lien Searches", "description": "This endpoint returns all adhoc lien searches.", "operationId": "get_adhoc_lien_searches_lien_searches_adhoc_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.AdhocLiensSearchState" }, "title": "Response Get Adhoc Lien Searches Lien Searches Adhoc Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Lien Search" ], "summary": "Start Liens Adhoc Search", "description": "Start an ad-hoc liens search using a name and explicit search states.\n\nBy default, this endpoint executes synchronously and returns the completed\nresult. Send ``Prefer: respond-async`` to opt into asynchronous execution,\nwhich returns ``202 Accepted`` immediately and delivers results via\nwebhooks or polling.", "operationId": "start_liens_adhoc_search_lien_searches_adhoc_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocLiensSearchRequest", "title": "Ad-hoc liens request", "description": "Start a liens search by name and target states (no business or person record).", "examples": [ { "name": "John Doe", "search_states": [ "CA", "NY" ] }, { "name": "Acme Corp", "search_states": [ "CA", "NY" ] } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocLiensSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AdhocLiensSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches/{liens_search_request_id}": { "get": { "tags": [ "Lien Search" ], "summary": "Get Liens", "description": "This endpoint retrieves a specific lien search request by its unique\nidentifier. It returns a LiensSearchRequest object that includes\nthe state of the request and a list of lien filings associated with the request.\n\nThe lien filings provide detailed information about each lien,\nincluding the filing number, type, date, status, and associated\nbusiness and search request. The model also links to any amendments\nand the involved parties.", "operationId": "get_liens_lien_searches__liens_search_request_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "liens_search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Liens Search Request ID", "description": "The unique identifier of the liens search request.", "examples": [ "3498e822-1cbc-41ba-a0d4-996a64aebcca" ] }, "description": "The unique identifier of the liens search request." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches/adhoc/{liens_search_request_id}": { "get": { "tags": [ "Lien Search" ], "summary": "Get Adhoc Liens", "description": "This endpoint retrieves a specific adhoc lien search request by its unique\nidentifier. It returns a LiensSearchRequest object that includes\nthe state of the request and a list of lien filings associated with the request.\n\nThe lien filings provide detailed information about each lien,\nincluding the filing number, type, date, status, and associated\nbusiness and search request. The model also links to any amendments\nand the involved parties.", "operationId": "get_adhoc_liens_lien_searches_adhoc__liens_search_request_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "liens_search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Adhoc Liens Search Request ID", "description": "The unique identifier of the adhoc liens search request.", "examples": [ "aca4c9b0-53af-4932-978a-7fdd31ec1b2d" ] }, "description": "The unique identifier of the adhoc liens search request." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdhocLiensSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AdhocLiensSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches/{liens_search_request_id}/status": { "get": { "tags": [ "Lien Search" ], "summary": "Get Liens Search Status", "description": "This endpoint retrieves the status of a specific lien search request by its unique\nidentifier. It returns a LiensSearchState object that includes\nthe state of the request.", "operationId": "get_liens_search_status_lien_searches__liens_search_request_id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "liens_search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Liens Search Request ID", "description": "The unique identifier of the liens search request.", "examples": [ "fe120e5b-b546-4b91-a602-a44ef13418ea" ] }, "description": "The unique identifier of the liens search request." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchState" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_searches/{liens_search_request_id}/filings/{filing_id}": { "get": { "tags": [ "Lien Search" ], "summary": "Get Lien Filing Documents", "description": "This endpoint downloads a PDF document associated with a specific lien filing record.\nThe PDF document contains detailed information about the lien filing.", "operationId": "get_lien_filing_documents_lien_searches__liens_search_request_id__filings__filing_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "liens_search_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Liens Search Request ID", "description": "The unique identifier of the liens search request.", "examples": [ "4fb8158e-3d26-4fb8-83ba-00f1b9b479be" ] }, "description": "The unique identifier of the liens search request." }, { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Liens Filing ID", "description": "The unique identifier of the liens filing record.", "examples": [ "463bd31a-b468-4a56-93bb-e980c39bfbca" ] }, "description": "The unique identifier of the liens filing record." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Download the liens documents as a combined PDF file." }, "404": { "description": "The lien filing document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "The lien filing document is still being processed. Try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "LienFilingDocumentStillProcessing", "description": "The lien filing document is still being processed. Please try again later.", "examples": [ { "code": 800, "message": "The lien filing document is still being processed. Please try again later.", "metadata": {} } ] } } } } } } }, "/lien_submissions": { "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Filing Submissions", "description": "This endpoint retrieves a list of lien filing submissions made by the authenticated organization.\nEach submission includes summary information such as filing type, date, number, and parties involved.", "operationId": "get_lien_filing_submissions_lien_submissions_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "The maximum number of lien filing submissions to return.", "default": 10, "title": "Limit" }, "description": "The maximum number of lien filing submissions to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "The number of lien filing submissions to skip before starting to return the submissions.", "default": 0, "title": "Offset" }, "description": "The number of lien filing submissions to skip before starting to return the submissions." }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search by filing number, filing name, or debtor name. Ignored when not provided.", "examples": [ "Cook County Lien", "Harris County Filing", "Los Angeles Submission" ], "title": "Q" }, "description": "Search by filing number, filing name, or debtor name. Ignored when not provided." }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/LienFilingSubmissionStatus" } }, { "type": "null" } ], "description": "Filter lien filing submissions by their status. Repeat the parameter to match several.", "title": "Status" }, "description": "Filter lien filing submissions by their status. Repeat the parameter to match several." }, { "name": "origin", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingOrigin" }, { "type": "null" } ], "description": "Filter lien filing submissions by their `origin` — how the organization came to hold the filing: `filed_via_baselayer` (submitted through Baselayer) or `imported` (claimed from the public record). This is the filing's own provenance, NOT the channel the request arrived on.", "title": "Origin" }, "description": "Filter lien filing submissions by their `origin` — how the organization came to hold the filing: `filed_via_baselayer` (submitted through Baselayer) or `imported` (claimed from the public record). This is the filing's own provenance, NOT the channel the request arrived on." }, { "name": "import_batch_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Filter to the filings a single bulk import batch created.", "title": "Import Batch Id" }, "description": "Filter to the filings a single bulk import batch created." }, { "name": "filed_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive filing-date lower bound.", "title": "Filed From" }, "description": "Inclusive filing-date lower bound." }, { "name": "filed_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive filing-date upper bound.", "title": "Filed To" }, "description": "Inclusive filing-date upper bound." }, { "name": "lapse_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive displayed lapse-date lower bound.", "title": "Lapse From" }, "description": "Inclusive displayed lapse-date lower bound." }, { "name": "lapse_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive displayed lapse-date upper bound.", "title": "Lapse To" }, "description": "Inclusive displayed lapse-date upper bound." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation" }, { "type": "null" } ], "description": "The filing's jurisdiction.", "title": "State" }, "description": "The filing's jurisdiction." }, { "name": "standing", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LienHistoryStanding" }, { "type": "null" } ], "description": "Standing of an initial filing; excludes UCC-3 amendment submissions.", "title": "Standing" }, "description": "Standing of an initial filing; excludes UCC-3 amendment submissions." }, { "name": "filing_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingSubmissionType" }, { "type": "null" } ], "description": "`UCC1` (initial filing) or `UCC3` (amendment).", "title": "Filing Type" }, "description": "`UCC1` (initial filing) or `UCC3` (amendment)." }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAmendmentActionType" }, { "type": "null" } ], "description": "The action a UCC-3 amendment takes.", "title": "Action" }, "description": "The action a UCC-3 amendment takes." }, { "name": "secured_party", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ], "description": "Case-insensitive partial secured-party name, including an amendment’s initial filing.", "title": "Secured Party" }, "description": "Case-insensitive partial secured-party name, including an amendment’s initial filing." }, { "name": "sort_by", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/LienHistorySortField", "description": "The displayed date to order by; undated filings sort last.", "default": "updated_at" }, "description": "The displayed date to order by; undated filings sort last." }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortMethod", "description": "Ascending or descending.", "default": "desc" }, "description": "Ascending or descending." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionImportedResponse" } ] }, "title": "Response Get Lien Filing Submissions Lien Submissions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Lien Filing" ], "summary": "Create New Standalone Ucc1 Lien Filing Submission", "description": "Creates a new standalone lien filing submission in a draft\nstate, without anchoring it to a business or person known to the\nplatform. Use this when the debtor has not gone through a KYB\nsearch — all debtors are supplied manually through the `debtors`\nlist and remain fully editable while the submission is a draft.\n\nUnlike the business- and person-anchored variants, the response\ncarries no `assigned_debtor`; every debtor lives in `debtors`.\n\nParties may be supplied incomplete while drafting. Draft values\nare persisted as entered, and submit-time validation reports\nanything still missing.\n\nIf the request body does not include secured parties, the system\nwill attempt to generate the first secured party using the\norganization's lien filing preferences, if they are present in\nthe organization's profile.\n\nThe actual filing with the appropriate jurisdiction does not\noccur at this stage; submit the draft through the\n`POST /lien_submissions/{filing_id}/submit` endpoint.", "operationId": "create_new_standalone_UCC1_lien_filing_submission_lien_submissions_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionCreateStandaloneUCC1Request", "title": "Liens Filing UCC-1 Submission Request", "description": "The request object containing all the Lien Filing Submission details, specifically for UCC-1 filings.", "examples": [ { "reference_data": "123456", "submission_filing_name": "My new lien filing", "filing_type": "UCC1", "state": "IL", "debtors": [ { "mailing_address": "456 Debtor Ave", "city": "Springfield", "state": "IL", "postal_code": "62701", "capacity": "NONE_OF_THE_ABOVE", "organization_name": "Debtor Industries LLC", "organization_type": "LLC", "type": "ORGANIZATION" } ], "secured_parties": [ { "mailing_address": "123 Main St", "city": "Springfield", "state": "IL", "postal_code": "62701", "organization_name": "Acme Inc", "organization_type": "B_CORPORATION", "type": "ORGANIZATION" } ], "collateral_statements": { "text": "All inventory, equipment, accounts, and proceeds now owned or hereafter acquired by the debtor.", "type": "TEXT" } } ] } } } }, "responses": { "201": { "description": "Successfully created a draft standalone lien filing submission record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/import": { "post": { "tags": [ "Lien Filing" ], "summary": "Import Lien Filing Submission", "description": "Imports a lien that already exists in the public record, so an\norganization can track a filing it did not file through Baselayer\nalongside the ones it did.\n\nThe lien is identified by the state and filing number the filing\noffice assigned it. An amendment's filing number is accepted too and\nresolves to the initial financing statement it amends, because that\nis the filing the lien itself is identified by. Only consensual UCC\nfilings can be imported: statutory, judicial and tax liens are\nimposed on a debtor rather than granted by one.\n\nThe filing number is matched against the spellings the filing is\nknown to be ingested under (leading zeros, spacing), so the record\nreturned carries the public record's canonical filing number, which\nmay differ from the one posted.\n\nNothing is filed and nothing is copied: the imported record links to\nthe public filing, so its status, parties and amendment history are\nalways the ones the jurisdiction currently reports. Imported filings\ncannot be updated, submitted, cancelled or amended — delete the\nimport to give up the claim.\n\nImporting the same lien twice is not an error: the existing record is\nreturned with a `200 OK` instead of a `201 Created`. A lien the\norganization already filed through Baselayer is a `409 Conflict`\ninstead — it is the same lien, and a second record would only drift\napart from the first.\n\nNot available to sandbox applications: an import claims a filing\nthat already exists in the public record, so there is nothing to\nsimulate.", "operationId": "import_lien_filing_submission_lien_submissions_import_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionImportRequest", "title": "Lien Filing Import Request", "description": "The request object identifying the lien filing to import.", "examples": [ { "state": "IL", "filing_number": "P98172", "filing_name": "Acme Inc — 2023 equipment lien" } ] } } }, "required": true }, "responses": { "201": { "description": "Successfully imported the lien filing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionImportedResponse" } } } }, "200": { "description": "The organization had already imported this lien filing; the existing record is returned." }, "402": { "description": "The calling application is a sandbox application, which cannot claim filings from the public record, or the organization is locked.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "PaymentRequiredSandboxApplication", "description": "Payment Required. Sandbox applications do not support this request.", "examples": [ { "code": 500, "message": "Payment Required. Sandbox applications do not support this request.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "OrganizationLocked", "description": "The organization is locked due to payment issues. Please update your payment information.", "examples": [ { "code": 3004, "message": "The organization is locked due to payment issues. Please update your payment information.", "metadata": {} } ] } ], "title": "Response 402 Import Lien Filing Submission Lien Submissions Import Post" } } } }, "404": { "description": "No lien filing with the given state and filing number exists in the public record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "409": { "description": "The organization already holds this lien as a filing made through Baselayer, or as an unverified attestation-based record.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "LienFilingAlreadyHeld", "description": "This lien filing is already held by the organization as a Baselayer filing.", "examples": [ { "code": 489, "message": "This lien filing is already held by the organization as a Baselayer filing.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "LienFilingHeldAsUnverifiedImport", "description": "This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says.", "examples": [ { "code": 491, "message": "This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says.", "metadata": {} } ] } ], "title": "Response 409 Import Lien Filing Submission Lien Submissions Import Post" } } } }, "422": { "description": "The public record filing is not a consensual UCC filing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "CannotImportNonConsensualLienFiling", "description": "Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements.", "examples": [ { "code": 490, "message": "Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements.", "metadata": {} } ] } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/lien_submissions/import/batches": { "post": { "tags": [ "Lien Filing" ], "summary": "Import Lien Filings In Bulk", "description": "Submit a CSV of liens to import from the public record (one lien per row). Always processed asynchronously (202 + batch id); poll GET /lien_submissions/import/batches/{batch_id} and download per-row results via /lien_submissions/import/batches/{batch_id}/download. Batches are capped at 40,000 rows. Columns: state, filing_number, filing_name (required: state, filing_number). Only the file as a whole is validated on upload — headers, encoding, size and row count; a row the parser cannot map is reported per-row in the results instead. Rows are identified by their ORIGINAL line number in the uploaded file (the header is line 1, and skipped blank lines still take up their line). One row per line: a quoted field may not contain a line break, and a file with one is rejected naming the line the row starts on.", "operationId": "import_lien_filings_in_bulk_lien_submissions_import_batches_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_lien_filings_in_bulk_lien_submissions_import_batches_post" } } } }, "responses": { "202": { "description": "The import batch was accepted and is being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingImportBatchResponse" } } } }, "400": { "description": "The upload is not a CSV, is not UTF-8, carries unknown/missing/duplicate headers, or has no data rows.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "InvalidFileType", "description": "Invalid file type. Please upload a CSV file.", "examples": [ { "code": 602, "message": "Invalid file type. Please upload a CSV file.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "InvalidCSVFormat", "description": "Invalid CSV format. Please ensure the file is encoded in UTF-8.", "examples": [ { "code": 604, "message": "Invalid CSV format. Please ensure the file is encoded in UTF-8.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "InvalidCSVHeaders", "description": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "examples": [ { "code": 600, "message": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "LienImportBatchEmpty", "description": "A bulk lien import must contain at least one row.", "examples": [ { "code": 802, "message": "A bulk lien import must contain at least one row.", "metadata": {} } ] } ], "title": "Response 400 Import Lien Filings In Bulk Lien Submissions Import Batches Post" } } } }, "402": { "description": "The calling application is a sandbox application, which cannot import filings from the public record, or the organization is locked.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "PaymentRequiredSandboxApplication", "description": "Payment Required. Sandbox applications do not support this request.", "examples": [ { "code": 500, "message": "Payment Required. Sandbox applications do not support this request.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "OrganizationLocked", "description": "The organization is locked due to payment issues. Please update your payment information.", "examples": [ { "code": 3004, "message": "The organization is locked due to payment issues. Please update your payment information.", "metadata": {} } ] } ], "title": "Response 402 Import Lien Filings In Bulk Lien Submissions Import Batches Post" } } } }, "413": { "description": "The uploaded file exceeds the maximum allowed size.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "FileTooLarge", "description": "The file is too large. Please upload a smaller file.", "examples": [ { "code": 900, "message": "The file is too large. Please upload a smaller file.", "metadata": {} } ] } } } }, "422": { "description": "The CSV carries more rows than a single batch may hold.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "LienImportBatchTooLarge", "description": "A bulk lien import exceeds the maximum allowed number of rows.", "examples": [ { "code": 801, "message": "A bulk lien import exceeds the maximum allowed number of rows.", "metadata": {} } ] } } } }, "502": { "description": "The upload could not be stored. Nothing was recorded — send the file again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ThirdPartyServiceFailure", "description": "The request could not be completed due to a failure in an external service.", "examples": [ { "code": 7, "message": "The request could not be completed due to a failure in an external service.", "metadata": {} } ] } } } } } }, "get": { "tags": [ "Lien Filing" ], "summary": "List Lien Filing Import Batches", "description": "Lists the bulk lien import batches visible to the caller, most\nrecently created first.", "operationId": "list_lien_filing_import_batches_lien_submissions_import_batches_get", "security": [ { "APIKeyHeader": [] } ], "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." } ], "responses": { "200": { "description": "List of bulk lien import batches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.LienFilingImportBatchResponse" }, "title": "Response List Lien Filing Import Batches Lien Submissions Import Batches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/import/batches/{batch_id}": { "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Filing Import Batch", "description": "Gets the status and per-outcome counts of a bulk lien import.", "operationId": "get_lien_filing_import_batch_lien_submissions_import_batches__batch_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Import Batch ID", "description": "The unique identifier of the bulk lien import batch.", "examples": [ "69917824-3024-48aa-b9e1-f6a56af3c32d" ] }, "description": "The unique identifier of the bulk lien import batch." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingImportBatchResponse" } } } }, "404": { "description": "The import batch does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/import/batches/{batch_id}/download": { "get": { "tags": [ "Lien Filing" ], "summary": "Download Lien Filing Import Batch Results", "description": "Answers with a signed URL of the batch's per-row results (JSONL),\none line per uploaded row recording what became of it.\n\nAvailable once the batch has reached a terminal state and written its\nreport — including a Failed batch, which reports the rows it did get\nthrough before it stopped.", "operationId": "download_lien_filing_import_batch_results_lien_submissions_import_batches__batch_id__download_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Import Batch ID", "description": "The unique identifier of the bulk lien import batch.", "examples": [ "4c19d0e9-f066-4e19-b19b-99d48f944d8d" ] }, "description": "The unique identifier of the bulk lien import batch." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Download the per-row import results as JSONL." }, "404": { "description": "The import batch does not exist, or has not finished and so has written no results.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "FileNotAvailable", "description": "File not available.", "examples": [ { "code": 6, "message": "File not available.", "metadata": {} } ] } ], "title": "Response 404 Download Lien Filing Import Batch Results Lien Submissions Import Batches Batch Id Download Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/initial_filing_lookup": { "post": { "tags": [ "Lien Filing" ], "summary": "Lookup Initial Filing For Amendment", "description": "Resolve the initial financing statement a UCC-3 will amend, from\nthe state and file number the filer copies off the UCC-1.\nFile date is optional for lookup and required when\n`allow_unverified` is true.\n\nThe search a filer must run before creating a UCC-3. Resolution is\nthree-way: a UCC-1 the organization filed through Baselayer resolves\nto that submission; a filing known from the public record is claimed\nas an imported filing (creating the record if this is the first\nclaim, exactly as `POST /lien_submissions/import` would); and a\nfiling Baselayer cannot verify at all is reported as `not_found` —\nunless `allow_unverified` is set, in which case it is held as an\nunverified imported filing built from the details supplied here.\nKeep `allow_unverified` off until the filer has seen the `not_found`\nanswer and confirmed they want to proceed anyway.\n\nThe resolved filing is what `POST /lien_submissions/{filing_id}/amend`\nthen targets. `warnings` flags a file date that disagrees with the\nmatched filing, a date past its lapse date, or a filing that is no\nlonger Active — none of them block the lookup.\n\nThe file number is validated against the state's format where the\nformat is known (length and character checks otherwise), and the\nsupplied file date must not be in the future nor predate the revised UCC\nArticle 9 effective date (2001-07-01).\n\nNot available to sandbox applications: the lookup reads the real\npublic record and can claim a filing off it, so there is nothing\nto simulate.", "operationId": "lookup_initial_filing_for_amendment_lien_submissions_initial_filing_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienInitialFilingLookupRequest", "title": "Initial Filing Lookup Request", "description": "The initial financing statement details to resolve, as they appear on the UCC-1.", "examples": [ { "state": "IL", "filing_number": "P98172", "filing_date": "2023-01-15", "allow_unverified": false } ] } } }, "required": true }, "responses": { "200": { "description": "The lookup resolved (or reported `not_found`) without creating a record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienInitialFilingLookupResponse" } } } }, "201": { "description": "The lookup created an imported filing record and resolved to it." }, "402": { "description": "The calling application is a sandbox application, which cannot claim filings from the public record, or the organization is locked.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "PaymentRequiredSandboxApplication", "description": "Payment Required. Sandbox applications do not support this request.", "examples": [ { "code": 500, "message": "Payment Required. Sandbox applications do not support this request.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "OrganizationLocked", "description": "The organization is locked due to payment issues. Please update your payment information.", "examples": [ { "code": 3004, "message": "The organization is locked due to payment issues. Please update your payment information.", "metadata": {} } ] } ], "title": "Response 402 Lookup Initial Filing For Amendment Lien Submissions Initial Filing Lookup Post" } } } }, "409": { "description": "The organization already holds this lien as a filing made through Baselayer, or a concurrent request held it as an unverified attestation-based record.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "LienFilingAlreadyHeld", "description": "This lien filing is already held by the organization as a Baselayer filing.", "examples": [ { "code": 489, "message": "This lien filing is already held by the organization as a Baselayer filing.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "LienFilingHeldAsUnverifiedImport", "description": "This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says.", "examples": [ { "code": 491, "message": "This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says.", "metadata": {} } ] } ], "title": "Response 409 Lookup Initial Filing For Amendment Lien Submissions Initial Filing Lookup Post" } } } }, "422": { "description": "The public record filing is not a consensual UCC filing, or the request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "CannotImportNonConsensualLienFiling", "description": "Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements.", "examples": [ { "code": 490, "message": "Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements.", "metadata": {} } ] } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/businesses/{business_id}/lien_submissions": { "post": { "tags": [ "Lien Filing" ], "summary": "Create New Ucc1 Lien Filing Submission For Business", "description": "Creates a new lien filing submission against a specified business\nin a draft state. This endpoint enables clients to submit all\nnecessary information required for a lien filing, including\nthe type of filing, relevant parties (secured parties and debtors),\nand a comprehensive description of the collateral.\n\nUpon successful creation, the system assigns a unique identifier\nto the lien filing draft, which can be utilized for\nfuture modifications or inquiries.\n\nThe creation process entails the validation of the submitted\ninformation, its association with the designated business entity,\nand the preparation of the filing for subsequent processing steps.\n\nIf the request body does not include secured parties, the system\nwill attempt to generate the first secured party using the\norganization's lien filing preferences, if they are present in\nthe organization's profile.\n\nIt's important to note that the actual filing with\nthe appropriate jurisdiction does not occur at this stage;\nthis endpoint essentially sets up the submission in a draft state,\nready for submission through\nthe `POST /lien_submissions/{filing_id}/submit` endpoint.", "operationId": "create_new_UCC1_lien_filing_submission_for_business_businesses__business_id__lien_submissions_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "business_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID to file a Lien against", "description": "The unique identifier of the business to file a lien against.", "examples": [ "e988dc23-4e4c-4fda-afcb-2b4fe6780322" ] }, "description": "The unique identifier of the business to file a lien against." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionCreateUCC1Request", "title": "Liens Filing UCC-1 Submission Request", "description": "The request object containing all the Lien Filing Submission details, specifically for UCC-1 filings.", "examples": [ { "reference_data": "123456", "submission_filing_name": "My new lien filing", "search_to_reflect": true, "filing_type": "UCC1", "state": "AL", "debtors": [ { "mailing_address": "123 Main St", "city": "Springfield", "state": "IL", "postal_code": "62701", "capacity": "TRUST", "suffix": "Sr.", "last_name": "Doe", "first_name": "John", "type": "INDIVIDUAL" } ], "secured_parties": [ { "mailing_address": "123 Main St", "city": "Springfield", "state": "IL", "postal_code": "62701", "organization_name": "Acme Inc", "organization_type": "B_CORPORATION", "type": "ORGANIZATION" } ], "collateral_statements": { "text": "All inventory, equipment, accounts, and proceeds now owned or hereafter acquired by the debtor, including but not limited to the property located at 123 Main Street, Anytown, CA 90210.", "type": "TEXT" } } ] } } } }, "responses": { "201": { "description": "Successfully created a draft lien filing submission record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" } } } }, "404": { "description": "The business for the given business ID not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/people/{person_id}/lien_submissions": { "post": { "tags": [ "Lien Filing" ], "summary": "Create New Ucc1 Lien Filing Submission For Person", "description": "Creates a new lien filing submission against a specified person\nin a draft state. This endpoint enables clients to submit all\nnecessary information required for a lien filing, including\nthe type of filing, relevant parties (secured parties and debtors),\nand a comprehensive description of the collateral.", "operationId": "create_new_UCC1_lien_filing_submission_for_person_people__person_id__lien_submissions_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "person_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Person ID to file a Lien against", "description": "The unique identifier of the person to file a lien against.", "examples": [ "65c2d311-76f9-4628-9ca2-458ef712b399" ] }, "description": "The unique identifier of the person to file a lien against." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionCreateUCC1Request", "title": "Liens Filing UCC-1 Submission Request", "description": "The request object containing all the Lien Filing Submission details, specifically for UCC-1 filings.", "examples": [ { "reference_data": "123456", "submission_filing_name": "My new lien filing", "search_to_reflect": true, "filing_type": "UCC1", "state": "AL", "debtors": [ { "mailing_address": "123 Main St", "city": "Springfield", "state": "IL", "postal_code": "62701", "capacity": "TRUST", "suffix": "Sr.", "last_name": "Doe", "first_name": "John", "type": "INDIVIDUAL" } ], "secured_parties": [ { "mailing_address": "123 Main St", "city": "Springfield", "state": "IL", "postal_code": "62701", "organization_name": "Acme Inc", "organization_type": "B_CORPORATION", "type": "ORGANIZATION" } ], "collateral_statements": { "text": "All inventory, equipment, accounts, and proceeds now owned or hereafter acquired by the debtor, including but not limited to the property located at 123 Main Street, Anytown, CA 90210.", "type": "TEXT" } } ] } } } }, "responses": { "201": { "description": "Successfully created a draft lien filing submission record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/amend": { "post": { "tags": [ "Lien Filing" ], "summary": "Create New Ucc3 Lien Filing Submission", "description": "Create a new UCC-3 lien filing submission to amend an existing UCC-1 filing.\n\nThis endpoint allows users to initiate an amendment process for an existing UCC-1 lien filing.\nIt creates a new UCC-3 filing submission, which can be used to modify, continue, or terminate\nthe original UCC-1 filing.\n\nThe `filing_id` in the URL represents the unique identifier of the original UCC-1 filing\nthat is being amended. The request body contains the necessary information to create\nthe new UCC-3 filing, including details such as the submission filing name and any\nreference data.\n\nUpon successful creation, a draft UCC-3 lien filing submission record is generated,\nallowing for further modifications before final submission.", "operationId": "create_new_UCC3_lien_filing_submission_lien_submissions__filing_id__amend_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to amend", "description": "The unique identifier of the lien filing submission to amend.", "examples": [ "850a043e-9dc2-47ff-a2aa-505c856631fc" ] }, "description": "The unique identifier of the lien filing submission to amend." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionCreateUCC3Request", "title": "Liens Filing UCC-3 Submission Request", "description": "The request object containing all the Lien Filing Submission details, specifically for UCC-3 filings.", "examples": [ { "reference_data": "123456-100", "submission_filing_name": "Filing for a 1967 Ford Mustang", "filing_type": "UCC3" } ] } } } }, "responses": { "201": { "description": "Successfully created a draft UCC-3 lien filing submission record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" } } } }, "404": { "description": "The business or lien filing submission not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}": { "get": { "tags": [ "Lien Filing" ], "summary": "Fetch Existing Lien Filing", "description": "Fetch an existing lien filing submission by its unique identifier.\n\nThis endpoint retrieves the details of a specific lien filing submission,\nincluding the filing status, parties involved, and any attachments or collateral descriptions.\n\nAn imported filing is rendered from the public record it claims, so\nits status, parties and amendment history are always the ones the\njurisdiction currently reports.", "operationId": "fetch_existing_lien_filing_lien_submissions__filing_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to fetch.", "description": "The unique identifier of the lien filing submission to fetch." }, "description": "The unique identifier of the lien filing submission to fetch." } ], "responses": { "200": { "description": "The lien filing submission found.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionImportedResponse" } ], "title": "Response Fetch Existing Lien Filing Lien Submissions Filing Id Get" } } } }, "404": { "description": "The lien filing submission not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Lien Filing" ], "summary": "Patch Existing Lien Filing Submission", "description": "Patches an existing lien filing submission with new information\nprovided by the user. This endpoint allows for the modification\nof lien filing submissions that are in a draft state.\n\nThis route manages both UCC-1 and UCC-3 lien filing types. For specific\ndetails on the request models for each type, please refer to the\n`LienFilingSubmissionUpdateUCC1Request` and `LienFilingSubmissionUpdateUCC3Request`\nschemas.\n\nUsers can update debtor and secured party information, as well\nas add or remove attachments related to the lien filing, depending\non the filing type.\n\nParty lists replace the corresponding role atomically. An empty\nlist explicitly clears that role. Draft parties are stored exactly\nas entered, including incomplete rows; completeness is enforced\nwhen the filing is submitted.\n\nPreserve each party's `id` when echoing a GET response. A party\nwithout an `id` creates a new entry; it does not replace a party\nprotected by a Filed assignment, whose historical link is retained.\n\nIt is important to note that only lien filings in a draft state\ncan be updated. Attempting to update a lien filing that has\nalready been submitted will result in an error.\n\nThe updated information will be validated according to the lien\nfiling requirements before being saved. If the validation fails,\nthe update will not be processed, and an error message will be returned.\n\nSuccessful updates will return the updated lien filing submission details.", "operationId": "patch_existing_lien_filing_submission_lien_submissions__filing_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to update.", "description": "The unique identifier of the lien filing submission to update." }, "description": "The unique identifier of the lien filing submission to update." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUpdateUCC1Request" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUpdateUCC3Request" } ], "discriminator": { "propertyName": "filing_type", "mapping": { "UCC1": "#/components/schemas/v1.LienFilingSubmissionUpdateUCC1Request", "UCC3": "#/components/schemas/v1.LienFilingSubmissionUpdateUCC3Request" } }, "title": "Liens Filing Submission Request", "description": "The request object containing all the Lien Filing Submission details." } } } }, "responses": { "202": { "description": "Successfully updated the lien filing submission record.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" } ], "title": "Response Patch Existing Lien Filing Submission Lien Submissions Filing Id Patch" } } } }, "404": { "description": "The lien filing submission not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Lien Filing" ], "summary": "Delete Lien Filing Submission", "description": "Deletes a draft lien filing submission.\n\nThis endpoint allows users to delete a lien filing submission only if it is in 'Draft' status.\n\nAn imported lien filing is always deletable: deleting it is how an\norganization gives up its claim over a filing in the public record.", "operationId": "delete_lien_filing_submission_lien_submissions__filing_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to delete.", "description": "The unique identifier of the lien filing submission to delete." }, "description": "The unique identifier of the lien filing submission to delete." } ], "responses": { "204": { "description": "Successfully deleted the draft lien filing submission." }, "404": { "description": "The lien filing submission does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "400": { "description": "Cannot delete a lien filing submission that is not in draft status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "CannotDeleteNonDraftLienFiling", "description": "Cannot delete a lien filing submission that is not in 'Draft' status.", "examples": [ { "code": 431, "message": "Cannot delete a lien filing submission that is not in 'Draft' status.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/submit": { "post": { "tags": [ "Lien Filing" ], "summary": "Submit Lien Filing Submission", "description": "Processes a lien filing submission.\n\nThis endpoint performs the following steps:\n1. Validates the lien form for completeness and accuracy.\n2. If valid, changes the status from 'Draft' to 'Requested'.\n3. Initiates the submission for further processing.\n\nRequired fields vary by filing type:\n\nUCC1 filings:\n- `email_contact`\n- `collateral_statements`\n- `secured_parties` (at least one)\n- `submission_principal_indebted_amount` (Tennessee only)\n- `submission_documentary_tax_stamp_required` (Florida only)\n\nUCC3 filings:\n- `email_contact`\n- `amendment_action`\n- `authorizing_party`\n\n**Note:** Once submitted, the lien filing becomes unmodifiable.\nIt will undergo review and processing, potentially resulting\nin official filing with the appropriate jurisdiction.", "operationId": "submit_lien_filing_submission_lien_submissions__filing_id__submit_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to submit.", "description": "The unique identifier of the lien filing submission to submit." }, "description": "The unique identifier of the lien filing submission to submit." } ], "responses": { "202": { "description": "Successfully sent a request to submit the lien filing.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" } ], "title": "Response Submit Lien Filing Submission Lien Submissions Filing Id Submit Post" } } } }, "404": { "description": "The lien filing submission not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/cancel": { "post": { "tags": [ "Lien Filing" ], "summary": "Cancel Lien Filing Submission", "description": "Cancels a lien filing submission that has been rejected and sent\nback for revision (i.e. 'Needs Attention' status).\n\nThis endpoint allows users to cancel a lien filing submission only\nif it is in 'Needs Attention' status.", "operationId": "cancel_lien_filing_submission_lien_submissions__filing_id__cancel_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID to cancel.", "description": "The unique identifier of the lien filing submission to cancel." }, "description": "The unique identifier of the lien filing submission to cancel." } ], "responses": { "200": { "description": "Successfully canceled the lien filing submission.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC3Response" } ], "title": "Response Cancel Lien Filing Submission Lien Submissions Filing Id Cancel Post" } } } }, "404": { "description": "The lien filing submission does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "400": { "description": "Cannot cancel a lien filing submission that is not in rejected status.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "CannotCancelLienFilingNotInNeedsAttentionStatus", "description": "Cannot cancel a lien filing submission that is not in 'Needs Attention' status.", "examples": [ { "code": 433, "message": "Cannot cancel a lien filing submission that is not in 'Needs Attention' status.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/attachments": { "post": { "tags": [ "Lien Filing" ], "summary": "Upload Lien Submission Attachment Item Attachment", "description": "Upload attachments for a specific lien filing submission.\n\nThis endpoint allows users to upload one or more PDF attachments to a lien filing submission.\nThe attachments can include documents supporting the lien claim.", "operationId": "upload_lien_submission_attachment_item_attachment_lien_submissions__filing_id__attachments_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The unique identifier of the lien filing submission." }, "description": "The unique identifier of the lien filing submission." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_lien_submission_attachment_item_attachment_lien_submissions__filing_id__attachments_post" } } } }, "responses": { "201": { "description": "The lien filing attachments have been successfully uploaded.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.LienFilingAttachment" }, "title": "Response Upload Lien Submission Attachment Item Attachment Lien Submissions Filing Id Attachments Post" } } } }, "404": { "description": "The lien filing document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Submission Attachments", "description": "Retrieve attachments for a specific lien filing submission.\n\nThis endpoint allows you to fetch a list of attachments associated with a given lien filing submission.\nThe attachments provide additional documentation or evidence related to the lien filing.", "operationId": "get_lien_submission_attachments_lien_submissions__filing_id__attachments_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing to retrieve attachments for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576" ] }, "description": "The ID of the lien filing to retrieve attachments for." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "title": "Limit", "description": "The maximum number of lien filing attachments to return.", "default": 10 }, "description": "The maximum number of lien filing attachments to return." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "title": "Offset", "description": "The number of lien filing attachments to skip before starting to return the attachments.", "default": 0 }, "description": "The number of lien filing attachments to skip before starting to return the attachments." } ], "responses": { "200": { "description": "The lien filing attachments.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.LienFilingAttachment" }, "title": "Response Get Lien Submission Attachments Lien Submissions Filing Id Attachments Get" } } } }, "404": { "description": "The lien filing document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/attachments/{attachment_id}": { "delete": { "tags": [ "Lien Filing" ], "summary": "Delete Lien Submission Attachment", "description": "Deletes a specific attachment from a lien filing submission.\n\nThis endpoint allows users to delete an attachment associated with a lien filing submission.\nThe attachment is identified by its unique ID, and the lien filing submission is identified\nby its unique filing ID.", "operationId": "delete_lien_submission_attachment_lien_submissions__filing_id__attachments__attachment_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing to delete the attachment from." }, "description": "The ID of the lien filing to delete the attachment from." }, { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Attachment ID", "description": "The ID of the attachment to delete from the lien filing." }, "description": "The ID of the attachment to delete from the lien filing." } ], "responses": { "204": { "description": "The lien filing attachment has been successfully deleted." }, "404": { "description": "The lien filing document or attachment does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Submission Attachment", "description": "Retrieve a lien submission attachment.\n\nThis endpoint allows you to download an attachment associated with a specific lien submission.\nThe attachment is identified by its unique ID, and the lien submission is identified by its unique filing ID.", "operationId": "get_lien_submission_attachment_lien_submissions__filing_id__attachments__attachment_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing to retrieve the attachment for." }, "description": "The ID of the lien filing to retrieve the attachment for." }, { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Attachment ID", "description": "The ID of the attachment to retrieve." }, "description": "The ID of the attachment to retrieve." } ], "responses": { "307": { "description": "Download the liens submission attachment.", "content": { "application/json": { "schema": {} } } }, "404": { "description": "The lien filing document or attachment does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/filed_document": { "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Submission Filed Document", "description": "Retrieve the filed lien document for a specific lien submission.", "operationId": "get_lien_submission_filed_document_lien_submissions__filing_id__filed_document_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing submission to retrieve the filed document for." }, "description": "The ID of the lien filing submission to retrieve the filed document for." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Download the filed lien document." }, "404": { "description": "The lien filing submission or filed document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/submission_document": { "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Submission Document", "description": "Download the PDF saved with the latest successful submission.", "operationId": "get_lien_submission_document_lien_submissions__filing_id__submission_document_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing submission to retrieve the submission document for." }, "description": "The ID of the lien filing submission to retrieve the submission document for." }, { "name": "redirect", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy.", "default": true, "title": "Redirect" }, "description": "When false, respond 200 with the signed URL as JSON instead of redirecting to it. Intended for browser callers, whose cross-origin redirect to storage is subject to the bucket's CORS policy." } ], "responses": { "200": { "description": "The signed URL as JSON (`redirect=false`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SignedURLResponse" } } } }, "307": { "description": "Download the saved submission PDF." }, "404": { "description": "The lien filing submission or submission document does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/lien_submissions/{filing_id}/preview_document": { "get": { "tags": [ "Lien Filing" ], "summary": "Get Lien Submission Preview Document", "description": "Render a watermarked preview of the national IACA UCC-1/UCC-3\nstandard form, filled from the current draft.\n\nThis endpoint regenerates the PDF from the live submission on\nevery request without storing it. Submitting the filing saves a\nseparate snapshot. Both carry the \"PREVIEW — NOT FILED\" watermark.", "operationId": "get_lien_submission_preview_document_lien_submissions__filing_id__preview_document_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "filing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Lien Filing ID", "description": "The ID of the lien filing submission to preview." }, "description": "The ID of the lien filing submission to preview." } ], "responses": { "200": { "description": "The watermarked standard-form preview PDF.", "content": { "application/json": { "schema": {} }, "application/pdf": {} } }, "404": { "description": "The lien filing submission does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "The submission has no draft form or exceeds the 25-page preview limit.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/APIError", "title": "LienFilingPreviewUnavailable", "description": "A standard-form preview is only available for UCC-1 and UCC-3 submissions filed through Baselayer; an imported filing mirrors the public record and has no draft form to preview.", "examples": [ { "code": 494, "message": "A standard-form preview is only available for UCC-1 and UCC-3 submissions filed through Baselayer; an imported filing mirrors the public record and has no draft form to preview.", "metadata": {} } ] }, { "$ref": "#/components/schemas/APIError", "title": "LienFilingPreviewTooLarge", "description": "This filing exceeds the 25-page preview limit. You can still review and submit the filing.", "examples": [ { "code": 495, "message": "This filing exceeds the 25-page preview limit. You can still review and submit the filing.", "metadata": {} } ] } ], "title": "Response 422 Get Lien Submission Preview Document Lien Submissions Filing Id Preview Document Get" } } } } } } }, "/businesses/{id}": { "get": { "tags": [ "Business" ], "summary": "Get Business", "description": "Retrieve a business by its UUID.", "operationId": "get_business_businesses__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID", "description": "The unique identifier of the business to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the business to retrieve." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.BusinessResponse" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/registrations": { "get": { "tags": [ "Business" ], "summary": "Get Business Registrations", "description": "Retrieve a business's corporate registrations by its UUID.", "operationId": "get_business_registrations_businesses__id__registrations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID", "description": "The unique identifier of the business to retrieve registrations for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the business to retrieve registrations for." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.RegistrationResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.RegistrationResponse" } } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/officers": { "get": { "tags": [ "Business" ], "summary": "Get Business Officers", "description": "Retrieve a business's officers by its UUID.", "operationId": "get_business_officers_businesses__id__officers_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID", "description": "The unique identifier of the business to retrieve officers for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the business to retrieve officers for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessOfficerResponse" }, "title": "Response Get Business Officers Businesses Id Officers Get" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/applications": { "get": { "tags": [ "Business" ], "summary": "Get Business Application History", "operationId": "get_business_application_history_businesses__id__applications_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "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." } ], "responses": { "200": { "description": "List of application velocity responses.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.ApplicationVelocityResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.ApplicationVelocityResponse" } } } }, "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" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/search_combinations": { "get": { "tags": [ "Business" ], "summary": "Get Business Search Combinations", "operationId": "get_business_search_combinations_businesses__id__search_combinations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.ApplicationDetailCombinationsResponse" }, "title": "Response Get Business Search Combinations Businesses Id Search Combinations Get" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/searches": { "get": { "tags": [ "Business" ], "summary": "Get Business Searches", "description": "List BusinessSearches that resolved to this business, newest first.\n\nScoped to the caller's dominant scope so callers only see\nsearches their own organization (or application) ran.", "operationId": "get_business_searches_businesses__id__searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID", "description": "The unique identifier of the Business to list searches for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the Business to list searches for." }, { "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." } ], "responses": { "200": { "description": "Paginated list of BusinessSearches that resolved to this business, newest first. Scoped to the caller's dominant scope (organization or application).", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessSearchResponse" } } }, "application/vnd.baselayer.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessSearchResponse" } } } }, "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" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/registrations/{id}": { "get": { "tags": [ "Business" ], "summary": "Get Registration", "description": "Retrieve a Registration by its UUID.", "operationId": "get_registration_registrations__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Registration ID", "description": "The unique identifier of the Registration to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the Registration to retrieve." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.RegistrationResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.RegistrationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/consortium/searches": { "post": { "tags": [ "Consortium" ], "summary": "Search Consortium", "operationId": "search_consortium_consortium_searches_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.ConsortiumCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.ConsortiumCheckResult" } } } }, "403": { "description": "No active consortium membership.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ConsortiumMembershipRequired", "description": "Your organization does not have an active fraud consortium membership. Submit exclusion data to gain access to consortium checks.", "examples": [ { "code": 605, "message": "Your organization does not have an active fraud consortium membership. Submit exclusion data to gain access to consortium checks.", "metadata": {} } ] } } } }, "422": { "description": "The request body is malformed." } }, "security": [ { "APIKeyHeader": [] } ] } }, "/consortium/searches/batches": { "post": { "tags": [ "Consortium" ], "summary": "Post Consortium Search Batch", "description": "Submit a CSV of consortium searches (one search per row, one of each identifier). Always processed asynchronously (202 + batch id); poll GET /consortium/searches/batches/{batch_id} and download per-row results via /consortium/searches/batches/{batch_id}/download. Batches are capped at 40,000 rows. Allowed columns: reference_id, ein, phone, email, website, business_name, officer_first_name, officer_last_name, officer_state, address_street, address_city, address_state, address_zip, business_id.", "operationId": "post_consortium_search_batch_consortium_searches_batches_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_post_consortium_search_batch_consortium_searches_batches_post" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.ConsortiumCheckBatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/consortium/searches/batches/{batch_id}": { "get": { "tags": [ "Consortium" ], "summary": "Get Consortium Search Batch", "operationId": "get_consortium_search_batch_consortium_searches_batches__batch_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.ConsortiumCheckBatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/consortium/searches/batches/{batch_id}/download": { "get": { "tags": [ "Consortium" ], "summary": "Download Consortium Search Results", "operationId": "download_consortium_search_results_consortium_searches_batches__batch_id__download_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } } ], "responses": { "307": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/consortium/submissions": { "post": { "tags": [ "Consortium" ], "summary": "Post Submission", "operationId": "post_submission_consortium_submissions_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_post_submission_consortium_submissions_post" } } } }, "responses": { "202": { "description": "Submission accepted for processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmissionResponse" } } } }, "400": { "description": "Invalid request due to missing required headers or invalid file format.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "InvalidCSVHeaders", "description": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "examples": [ { "code": 600, "message": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "metadata": {} } ] } } } }, "422": { "description": "CSV contains valid headers but no valid data rows.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "InvalidCSVData", "description": "Cannot process CSV file due to invalid data. Please ensure your CSV data is valid.", "examples": [ { "code": 601, "message": "Cannot process CSV file due to invalid data. Please ensure your CSV data is valid.", "metadata": {} } ] } } } } } }, "get": { "tags": [ "Consortium" ], "summary": "Get Submissions", "description": "List the organization's consortium submissions, newest first.\n\nHistory is organization-wide: submissions uploaded through any of\nthe organization's applications are visible. Paginated via the\nshared limit/offset (or keyset) ``PaginationQuery``, mirroring the\nOFAC batch listing; pagination metadata rides the response headers.", "operationId": "get_submissions_consortium_submissions_get", "security": [ { "APIKeyHeader": [] } ], "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." } ], "responses": { "200": { "description": "The organization's consortium submissions, newest first.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubmissionResponse" }, "title": "Response Get Submissions Consortium Submissions Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/consortium/submissions/{submission_id}/download": { "get": { "tags": [ "Consortium" ], "summary": "Download Submission", "description": "Download the originally uploaded CSV via a signed GCS URL\nredirect, matching the OFAC batch download pattern.", "operationId": "download_submission_consortium_submissions__submission_id__download_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission ID", "description": "The unique identifier of the submission to download." }, "description": "The unique identifier of the submission to download." } ], "responses": { "307": { "description": "Redirect to a signed URL of the originally uploaded CSV.", "content": { "application/json": { "schema": {} } } }, "404": { "description": "The submission does not exist or its file is not available.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ofac/searches/batches": { "post": { "tags": [ "OFAC" ], "summary": "Post Ofac Batch", "description": "Submit a CSV for batch OFAC search, no larger than 5MB.\nExpects two columns with the headers `entity_name` and `reference_id`. Supports an optional `date_of_birth` column (YYYY-MM-DD format) with optional values. See sample template [here](https://storage.googleapis.com/osiris-public-assets-prod/schemas/ofac_batch_csv_example.csv)", "operationId": "post_ofac_batch_ofac_searches_batches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "similarity_threshold", "in": "query", "required": false, "schema": { "type": "number", "maximum": 1.0, "minimum": 0.0, "description": "The similarity threshold for the OFAC search.", "default": 0.9, "title": "Similarity Threshold" }, "description": "The similarity threshold for the OFAC search." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_post_ofac_batch_ofac_searches_batches_post" } } } }, "responses": { "202": { "description": "Batch accepted for processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OFACBatchResponse" } } } }, "400": { "description": "Invalid request due to missing required headers, invalid file format, or invalid similarity threshold.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "InvalidCSVHeaders", "description": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "examples": [ { "code": 600, "message": "Cannot process CSV file due to missing required headers. Please ensure your CSV includes all required headers.", "metadata": {} } ] } } } }, "413": { "description": "The file is too large. Please upload a smaller file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "FileTooLarge", "description": "The file is too large. Please upload a smaller file.", "examples": [ { "code": 900, "message": "The file is too large. Please upload a smaller file.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "OFAC" ], "summary": "List Ofac Batches", "description": "List all OFAC batches for the authenticated organization.", "operationId": "list_ofac_batches_ofac_searches_batches_get", "security": [ { "APIKeyHeader": [] } ], "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." } ], "responses": { "200": { "description": "List of OFAC batches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.OFACBatchResponse" }, "title": "Response List Ofac Batches Ofac Searches Batches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ofac/searches/batches/{batch_id}": { "get": { "tags": [ "OFAC" ], "summary": "Get Ofac Batch", "description": "Get the status of an OFAC batch.", "operationId": "get_ofac_batch_ofac_searches_batches__batch_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "OFAC Batch ID", "description": "The unique identifier of the OFAC batch to download.", "examples": [ "deacc294-99a8-436b-8440-318a23ac5a6b" ] }, "description": "The unique identifier of the OFAC batch to download." } ], "responses": { "200": { "description": "Retrieved status of the OFAC batch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OFACBatchResponse" } } } }, "404": { "description": "The OFAC batch does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ofac/searches/batches/{batch_id}/download": { "get": { "tags": [ "OFAC" ], "summary": "Get Ofac Batch File", "description": "Download the resulting OFAC batch file in .jsonl format.\nSee example output file [here](https://storage.googleapis.com/osiris-public-assets-prod/schemas/ofac_batch_result_example.jsonl)", "operationId": "get_ofac_batch_file_ofac_searches_batches__batch_id__download_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "OFAC Batch ID", "description": "The unique identifier of the OFAC batch to download.", "examples": [ "3edcbf88-3373-44f5-9db7-a14e084af073" ] }, "description": "The unique identifier of the OFAC batch to download." } ], "responses": { "307": { "description": "Download the OFAC batch file.", "content": { "application/json": { "schema": {} } } }, "404": { "description": "The OFAC batch does not exist or file is not available.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "ResourceNotFound", "description": "Could not locate the resource for the given URI.", "examples": [ { "code": 1, "message": "Could not locate the resource for the given URI.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/prefill/businesses": { "get": { "tags": [ "Prefill" ], "summary": "Business Prefill", "description": "Prefill businesses by searching officer names.\nBusiness name is optional and used only for matching comparison in the response.", "operationId": "business_prefill_prefill_businesses_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "officer_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Officer name to search", "title": "Officer Name" }, "description": "Officer name to search" }, { "name": "business_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Business name to use for matching comparison (not used for searching)", "title": "Business Name" }, "description": "Business name to use for matching comparison (not used for searching)" }, { "name": "similarity_threshold", "in": "query", "required": false, "schema": { "type": "number", "maximum": 1.0, "minimum": 0.5, "description": "Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.", "default": 0.9, "title": "Similarity Threshold" }, "description": "Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Maximum number of results to return", "default": 50, "title": "Limit" }, "description": "Maximum number of results to return" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PrefillRegistrationResponse" }, "title": "Response Business Prefill Prefill Businesses Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/autocomplete/sessions": { "post": { "tags": [ "Autocomplete" ], "summary": "Mint an autocomplete session", "description": "Mints the grant every request to the autocomplete service carries in ``X-Autocomplete-Session``. Minting writes one Order; the keystrokes it admits write nothing. An organization mints without limit unless one is set for it, ``sessions_per_window`` per ten minutes and ``sessions_per_day`` per rolling day (each ``null`` when there is none), one pool drawn from by every caller in it; past either the mint answers 429. The grant is bound to the ``Origin`` it was minted with, expires after ``expires_in`` seconds (refresh at about 80% of it; ``expires_at`` is the same instant as a UTC timestamp, for display) and admits ``request_budget`` requests per route. A sandbox application's grant is served the sandbox's own index, and its mint writes no Order and counts against neither limit. A caller whose ``autocomplete.enabled`` override is off is answered 403; a locked organization is answered 402.", "operationId": "mint_autocomplete_session_autocomplete_sessions_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.AutocompleteSessionRequest" }, { "type": "null" } ], "title": "Request" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AutocompleteSessionGrantResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.AutocompleteSessionGrantResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/autocomplete": { "get": { "tags": [ "Business Autocomplete" ], "summary": "Autocomplete", "description": "Suggest businesses matching a partial name, for typeahead UIs.", "operationId": "autocomplete_autocomplete_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "entity_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AutocompleteEntityType", "description": "The type of entity to suggest. Only `business` is currently supported." }, "description": "The type of entity to suggest. Only `business` is currently supported." }, { "name": "business.name", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "description": "Partial business name to complete.", "examples": [ "apple", "acme plumb" ], "title": "Business.Name" }, "description": "Partial business name to complete." }, { "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation" }, { "type": "null" } ], "description": "Restrict suggestions to businesses registered in this state.", "title": "State" }, "description": "Restrict suggestions to businesses registered in this state." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 20, "minimum": 1, "description": "Maximum suggestions to return.", "default": 10, "title": "Limit" }, "description": "Maximum suggestions to return." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AutocompleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches": { "get": { "tags": [ "Search" ], "summary": "Get Searches", "description": "Retrieve a list of business searches.", "operationId": "get_searches_searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, { "name": "tin_matched", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter by TIN match status. True returns searches where the TIN was matched, False returns searches where the TIN was not matched.", "title": "Tin Matched" }, "description": "Filter by TIN match status. True returns searches where the TIN was matched, False returns searches where the TIN was not matched." }, { "name": "verified", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter by verification status. True returns verified searches, False returns unverified searches.", "title": "Verified" }, "description": "Filter by verification status. True returns verified searches, False returns unverified searches." }, { "name": "business_website_match", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter by business website match status. True returns searches where the website was matched, False returns searches where it was not.", "title": "Business Website Match" }, "description": "Filter by business website match status. True returns searches where the website was matched, False returns searches where it was not." }, { "name": "business_name_match", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Filter by business name match level. Values: NO_MATCH, SIMILAR, EXACT.", "title": "Business Name Match" }, "description": "Filter by business name match level. Values: NO_MATCH, SIMILAR, EXACT." }, { "name": "business_officer_match", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Filter by business officer match level. Values: NO_MATCH, SIMILAR, EXACT.", "title": "Business Officer Match" }, "description": "Filter by business officer match level. Values: NO_MATCH, SIMILAR, EXACT." }, { "name": "registered_agent_match", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Filter by registered agent match level. Values: NO_MATCH, SIMILAR, EXACT.", "title": "Registered Agent Match" }, "description": "Filter by registered agent match level. Values: NO_MATCH, SIMILAR, EXACT." }, { "name": "business_address_match", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Filter by business address match level. Values: NO_MATCH, CITY, STATE, SIMILAR, EXACT.", "title": "Business Address Match" }, "description": "Filter by business address match level. Values: NO_MATCH, CITY, STATE, SIMILAR, EXACT." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of business searches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessSearchResponse" }, "title": "Response Get Searches Searches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Search" ], "summary": "Post Search", "description": "Create a new business search.\n\nIdentify the business by ``name`` and ``address``, or by an autocomplete\nsuggestion's ``business_token`` alone: one or the other, never both.\n\nSupports both the legacy ``Accept: application/vnd.osiris.sync+json`` header\n(v1 backward compatibility) and the new ``Prefer`` header (RFC 7240) for\ncontrolling sync/async execution. When both are present, ``Prefer`` takes\nprecedence.", "operationId": "post_search_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, or ``wait=N`` to specify a synchronous timeout hint in seconds. When present, takes precedence over the legacy Accept header sync flag.", "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, or ``wait=N`` to specify a synchronous timeout hint in seconds. When present, takes precedence over the legacy Accept header sync flag." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Accept", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The MIME type of the response to accept.", "examples": [ "application/json", "application/vnd.osiris.sync+json" ], "title": "Accept" }, "description": "The MIME type of the response to accept." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessSearchRequest" }, { "$ref": "#/components/schemas/v1.PreIdentifiedBusinessSearchRequest" } ], "title": "Business Search Request", "description": "Identify the business by `name` and `address`, or by an autocomplete suggestion's `business_token` alone: one or the other, never both.", "examples": [ { "name": "White, Floyd and Cook", "address": "155 Carla Circles Jordanfurt, OK 59066", "options": [] }, { "options": [], "business_token": "AwICAgICAgICAgICAgbWyUlKV8H908y8yFynwrKjtdHv67GNcd2H4Pt4-3R_dX8eN20E6j1HjcHoiPU2f2le2dXT-7RWFQ" } ] } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.GetBusinessSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.GetBusinessSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches/batches": { "get": { "tags": [ "Search" ], "summary": "List search batches", "description": "List all search batches for the authenticated user's organization.", "operationId": "list_search_batches_searches_batches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "Search query. Can be a batch ID (UUID) or batch name. If UUID, filters by exact ID match. Otherwise, filters by case-insensitive name match." }, "description": "Search query. Can be a batch ID (UUID) or batch name. If UUID, filters by exact ID match. Otherwise, filters by case-insensitive name match." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of search batches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.BusinessSearchBatchResponse" }, "title": "Response List Search Batches Searches Batches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches/{id}": { "get": { "tags": [ "Search" ], "summary": "Get Search", "description": "Retrieve a business search by ID.", "operationId": "get_search_searches__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Search ID", "description": "The unique identifier of the search to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the search to retrieve." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.GetBusinessSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.GetBusinessSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches/{id}/status": { "get": { "tags": [ "Search" ], "summary": "Get Task Status", "description": "Retrieve the status of a business search by ID.", "operationId": "get_task_status_searches__id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Search ID", "description": "The unique identifier of the search to retrieve the status for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the search to retrieve the status for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches/{id}/export": { "post": { "tags": [ "Search" ], "summary": "Export Search To Pdf", "operationId": "export_search_to_pdf_searches__id__export_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Search ID", "description": "The unique identifier of the search to export.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the search to export." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/person_searches": { "get": { "tags": [ "Person Search" ], "summary": "Get Person Searches", "operationId": "get_person_searches_person_searches_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, "description": "The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored." }, { "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": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or after this date (format: YYYY-MM-DD).", "title": "Start Date" }, "description": "Filter records created on or after this date (format: YYYY-MM-DD)." }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Filter records created on or before this date (format: YYYY-MM-DD).", "title": "End Date" }, "description": "Filter records created on or before this date (format: YYYY-MM-DD)." }, { "name": "tz", "in": "query", "required": false, "schema": { "type": "string", "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).", "examples": [ "UTC", "America/Los_Angeles", "Europe/London" ], "default": "UTC", "title": "Tz" }, "description": "IANA timezone identifier used to interpret start_date and end_date (defaults to UTC)." } ], "responses": { "200": { "description": "List of person searches.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.PersonSearchResponse" }, "title": "Response Get Person Searches Person Searches Get" } } }, "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": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Person Search" ], "summary": "Create Person Search", "operationId": "create_person_search_person_searches_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." }, { "name": "Prefer", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue.", "examples": [ "respond-async", "wait=30", "priority=low" ], "title": "Prefer" }, "description": "Request execution preference (RFC 7240). Use ``respond-async`` for asynchronous execution, ``wait=N`` to specify a synchronous timeout hint in seconds, or ``priority=low`` to route the task to the low-priority queue." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchRequest" } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchResponse" } }, "application/vnd.baselayer.v1+json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/person_searches/{id}": { "get": { "tags": [ "Person Search" ], "summary": "Get Person Search", "operationId": "get_person_search_person_searches__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/person_searches/{id}/status": { "get": { "tags": [ "Person Search" ], "summary": "Get Person Search Status", "operationId": "get_person_search_status_person_searches__id__status_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/searches/batch/{id}": { "get": { "tags": [ "Search" ], "summary": "Get Search Batch", "description": "Retrieve a SearchBatch by ID and return it in `SearchBatchResponse` format.\n\nThe two TIN counts are computed per request rather than stored.\n``tin_matching_pending_count`` counts the batch's searches still\ninside the IRS TIN-match retry budget, so it falls as verdicts land;\nwhile it is positive the batch's exports are a provisional snapshot\nthat will be regenerated — ``exports_generated_at`` moves forward each\ntime — so a caller that cached a download should re-read this response\nbefore trusting it.\n\nIt reaching zero means nothing is left to retry, NOT that every TIN\nwas verified. ``tin_matching_unresolved_count`` is the companion that\nsays how many rows FINISHED without a verdict and dropped out of the\nretry pool (budget spent, retries disabled for the program, or the\nsearch cancelled). Both come from one scan so they cannot disagree.\n\nThe two do not partition the batch's TIN rows: a search that is still\nrunning is in neither, because its TIN match has not been attempted to\na conclusion. On a ``COMPLETED`` batch two zeroes therefore do mean\nevery TIN was verified; on one still processing they mean only that\nnothing has been given up on yet.", "operationId": "get_search_batch_searches_batch__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch ID", "description": "The unique identifier of the search batch to retrieve searches for.", "examples": [ "a3c16db9-52f0-4f67-9ce3-0fae6f9f3f31", "3b7b12c4-12e4-4f2e-9b67-1a9e34339372" ] }, "description": "The unique identifier of the search batch to retrieve searches for." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchBatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ofac/searches": { "post": { "tags": [ "OFAC" ], "summary": "Search Ofac", "description": "Search for OFAC matches by name.", "operationId": "search_ofac_ofac_searches_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OFACSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OFACSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/pep/searches": { "post": { "tags": [ "PEP" ], "summary": "Search Pep", "description": "Search for Politically Exposed Persons (PEP) matches by name.", "operationId": "search_pep_pep_searches_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PEPSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PEPSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/watchlists": { "get": { "tags": [ "Watchlists" ], "summary": "Search Multiple Watchlists", "description": "Search a name across one or more watchlists, grouped by source.", "operationId": "search_multiple_watchlists_watchlists_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "description": "The name to search for across the watchlists.", "examples": [ "banco nacional de cuba", "vladimir putin" ], "title": "Q" }, "description": "The name to search for across the watchlists." }, { "name": "watchlists", "in": "query", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WatchlistSearchSource" }, "minItems": 1, "description": "Watchlists to search. Repeat the param to search several (e.g. ?watchlists=OFAC&watchlists=PEP). At least one required; one billable order is written per requested watchlist.", "title": "Watchlists" }, "description": "Watchlists to search. Repeat the param to search several (e.g. ?watchlists=OFAC&watchlists=PEP). At least one required; one billable order is written per requested watchlist." }, { "name": "similarity_threshold", "in": "query", "required": false, "schema": { "type": "number", "maximum": 1.0, "minimum": 0.0, "description": "Minimum similarity for a match (0.0–1.0).", "default": 0.9, "title": "Similarity Threshold" }, "description": "Minimum similarity for a match (0.0–1.0)." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Maximum matches to return per watchlist.", "default": 5, "title": "Limit" }, "description": "Maximum matches to return per watchlist." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WatchlistSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tin_verifications": { "get": { "tags": [ "TIN Verification" ], "summary": "List Tin Verifications", "description": "List all Federations that the authenticated actor has access to.", "operationId": "list_tin_verifications_tin_verifications_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "q", "description": "A search query to limit the TIN Verifications returned by matching on ID, name, or external ID.", "examples": [ "Acme, Inc.", "Baselayer", "The Avengers" ] }, "description": "A search query to limit the TIN Verifications returned by matching on ID, name, or external ID." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.TINVerificationResponse" }, "title": "Response List Tin Verifications Tin Verifications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "TIN Verification" ], "summary": "Submit Tin Verification", "description": "Search for a TIN (Tax Identification Number) against IRS records by name.\n\nNote: An error will be raised if the IRS validation service is experiencing an outage.\nCheck status.baselayer.com for service updates.", "operationId": "submit_tin_verification_tin_verifications_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.", "title": "Idempotency-Key" }, "description": "An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked `Idempotent-Replayed: true`, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tin_verifications/{id}": { "get": { "tags": [ "TIN Verification" ], "summary": "Get Tin Verification", "description": "Retrieve a TIN Verification Request by ID.", "operationId": "get_tin_verification_tin_verifications__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "TIN Verification ID", "description": "The unique identifier of the TIN verification request to retrieve.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the TIN verification request to retrieve." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/businesses/{id}/exclusions": { "get": { "tags": [ "Exclusions" ], "summary": "Get Exclusions For Search", "description": "Retrieve exclusion records related to a specific business search.\n\nThis endpoint returns exclusion records that match the business information\nfrom the specified search, such as business name, tax ID, or other identifiers.\nResults are only available if the caller's organization has an active\nconsortium membership (granted by submitting exclusion data).\n\nResults are paginated and ordered by creation date (newest first).", "operationId": "get_exclusions_for_search_businesses__id__exclusions_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Business ID", "description": "The unique identifier of the business to retrieve exclusions for.", "examples": [ "412a49b5-7466-426b-bf1e-081b00b54576", "9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5" ] }, "description": "The unique identifier of the business to retrieve exclusions for." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Maximum number of exclusion records to return", "default": 10, "title": "Limit" }, "description": "Maximum number of exclusion records to return" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Number of exclusion records to skip", "default": 0, "title": "Offset" }, "description": "Number of exclusion records to skip" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1.ExclusionResponse" }, "title": "Response Get Exclusions For Search Businesses Id Exclusions Get" } } } }, "308": { "description": "The business was merged into another business. `Location` is this same URL under the canonical id; the body carries both ids in `metadata`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError", "title": "BusinessMovedPermanently", "description": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "examples": [ { "code": 39, "message": "The business was merged into another business. Follow the Location header; the canonical business id is in metadata.canonical_business_id.", "metadata": {} } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/criminal_checks": { "post": { "tags": [ "Criminal Checks" ], "summary": "Create Criminal Check", "description": "Create a new criminal check.", "operationId": "create_criminal_check_criminal_checks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CreateCriminalCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CriminalCheckResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/criminal_checks/{id}": { "get": { "tags": [ "Criminal Checks" ], "summary": "Get Criminal Check", "description": "Get a criminal check by ID.", "operationId": "get_criminal_check_criminal_checks__id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.CriminalCheckResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "webhooks": { "InternationalBusinessSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "InternationalBusinessSearch.submitted", "description": "Emitted when an International Business search has been submitted for processing.", "operationId": "webhook_handlerInternationalBusinessSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "InternationalBusinessSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "InternationalBusinessSearch.completed", "description": "Emitted when an International Business search has completed and results are available.", "operationId": "webhook_handlerInternationalBusinessSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "InternationalBusinessSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "InternationalBusinessSearch.failed", "description": "Emitted when an International Business search has failed.", "operationId": "webhook_handlerInternationalBusinessSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.InternationalBusinessSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "OnboardingSession.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "OnboardingSession.completed", "description": "Emitted when a hosted enrollment session completes. Carries the session's state, verdict and pairwise refs. A direct verification sends `Verification.completed` instead.", "operationId": "webhook_handlerOnboardingSession_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OnboardingSessionCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "OnboardingSession.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "OnboardingSession.failed", "description": "Emitted when a hosted enrollment session fails. Carries the `OnboardingSession.completed` payload plus `terminal_reason`. A direct verification sends `Verification.failed` instead.", "operationId": "webhook_handlerOnboardingSession_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OnboardingSessionFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "OnboardingSession.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "OnboardingSession.updated", "description": "Emitted once per manual decision a reviewer records on a completed under-review hosted enrollment session. Carries the session status plus the decision, its reason, when it was made, and the open findings it resolved. A direct verification sends `Verification.updated` instead.", "operationId": "webhook_handlerOnboardingSession_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OnboardingSessionUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "Verification.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "Verification.completed", "description": "Emitted when a direct verification completes. The payload is the verification as `GET /issuance/identities/verifications/{verification_id}` returns it. A hosted enrollment session sends `OnboardingSession.completed` instead.", "operationId": "webhook_handlerVerification_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.VerificationCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "Verification.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "Verification.failed", "description": "Emitted when a direct verification fails. The payload is the verification as `GET /issuance/identities/verifications/{verification_id}` returns it. A hosted enrollment session sends `OnboardingSession.failed` instead.", "operationId": "webhook_handlerVerification_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.VerificationFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "Verification.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "Verification.updated", "description": "Emitted once per manual decision a reviewer records on a direct verification. The payload is the verification as `GET /issuance/identities/verifications/{verification_id}` returns it, with the decision's `verdict`. A hosted enrollment session sends `OnboardingSession.updated` instead.", "operationId": "webhook_handlerVerification_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.VerificationUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebsiteAnalysisRequest.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "WebsiteAnalysisRequest.submitted", "description": "Emitted when a Website Analysis request has been submitted for processing.", "operationId": "webhook_handlerWebsiteAnalysisRequest_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisRequestSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebsiteAnalysisRequest.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "WebsiteAnalysisRequest.completed", "description": "Emitted when a Website Analysis request has completed and results are available.", "operationId": "webhook_handlerWebsiteAnalysisRequest_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisRequestCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebsiteAnalysisRequest.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "WebsiteAnalysisRequest.failed", "description": "Emitted when a Website Analysis request has failed.", "operationId": "webhook_handlerWebsiteAnalysisRequest_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.WebsiteAnalysisRequestFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebPresenceRequest.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "WebPresenceRequest.submitted", "description": "Emitted when a Web Presence request has been submitted for processing.", "operationId": "webhook_handlerWebPresenceRequest_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebPresenceRequestSubmittedWebhook" }, { "$ref": "#/components/schemas/v2.WebPresenceRequestSubmittedWebhook" } ], "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebPresenceRequest.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "WebPresenceRequest.completed", "description": "Emitted when a Web Presence request has completed and results are available.", "operationId": "webhook_handlerWebPresenceRequest_completed_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebPresenceRequestCompletedWebhook" }, { "$ref": "#/components/schemas/v2.WebPresenceRequestCompletedWebhook" } ], "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "WebPresenceRequest.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "WebPresenceRequest.failed", "description": "Emitted when a Web Presence request has failed.", "operationId": "webhook_handlerWebPresenceRequest_failed_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebPresenceRequestFailedWebhook" }, { "$ref": "#/components/schemas/v2.WebPresenceRequestFailedWebhook" } ], "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "AdverseMediaSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "AdverseMediaSearch.submitted", "description": "Emitted when an Adverse Media Search request has been submitted for processing.", "operationId": "webhook_handlerAdverseMediaSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdverseMediaSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "AdverseMediaSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "AdverseMediaSearch.completed", "description": "Emitted when an Adverse Media Search request has completed and results are available.", "operationId": "webhook_handlerAdverseMediaSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdverseMediaSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "AdverseMediaSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "AdverseMediaSearch.failed", "description": "Emitted when an Adverse Media Search request has failed.", "operationId": "webhook_handlerAdverseMediaSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.AdverseMediaSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "EmployeeVerificationRequest.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "EmployeeVerificationRequest.submitted", "description": "Emitted when an Employee Verification Request has been submitted for processing.", "operationId": "webhook_handlerEmployeeVerificationRequest_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "EmployeeVerificationRequest.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "EmployeeVerificationRequest.completed", "description": "Emitted when an Employee Verification Request has completed and results are available.", "operationId": "webhook_handlerEmployeeVerificationRequest_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "EmployeeVerificationRequest.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "EmployeeVerificationRequest.failed", "description": "Emitted when an Employee Verification Request has failed.", "operationId": "webhook_handlerEmployeeVerificationRequest_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmployeeVerificationRequestFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "NAICSPredictionRequest.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "NAICSPredictionRequest.submitted", "description": "Emitted when a NAICS code prediction request has been submitted for processing.", "operationId": "webhook_handlerNAICSPredictionRequest_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NAICSPredictionRequestSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "NAICSPredictionRequest.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "NAICSPredictionRequest.completed", "description": "Emitted when a NAICS code prediction request has completed and results are available.", "operationId": "webhook_handlerNAICSPredictionRequest_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NAICSPredictionRequestCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "NAICSPredictionRequest.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "NAICSPredictionRequest.failed", "description": "Emitted when a NAICS code prediction request has failed.", "operationId": "webhook_handlerNAICSPredictionRequest_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.NAICSPredictionRequestFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "Order.created": { "post": { "tags": [ "Webhook Events" ], "summary": "Order.created", "description": "Emitted when an Order has been placed for a Baselayer product.", "operationId": "webhook_handlerOrder_created_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.OrderCreatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketSearch.submitted", "description": "Emitted when a Docket search for a business has been submitted for processing.", "operationId": "webhook_handlerDocketSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketSearch.completed", "description": "Emitted when a Docket search for a business has completed and results are available.", "operationId": "webhook_handlerDocketSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketSearch.failed", "description": "Emitted when a Docket search for a business has failed.", "operationId": "webhook_handlerDocketSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketDetailsSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketDetailsSearch.submitted", "description": "Emitted when a Docket Details search for a given Docket has been submitted for processing.", "operationId": "webhook_handlerDocketDetailsSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailsSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketDetailsSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketDetailsSearch.completed", "description": "Emitted when a Docket Details search for a given Docket has completed and results are available.", "operationId": "webhook_handlerDocketDetailsSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailsSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketDetailsSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketDetailsSearch.failed", "description": "Emitted when a Docket Details search for a given Docket has failed.", "operationId": "webhook_handlerDocketDetailsSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketDetailsSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketExhibitSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketExhibitSearch.submitted", "description": "Emitted when a Docket Exhibit search for a given Docket Exhibit has been submitted for processing.", "operationId": "webhook_handlerDocketExhibitSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketExhibitSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketExhibitSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketExhibitSearch.completed", "description": "Emitted when a Docket Exhibit search for a given Docket Exhibit has completed and results are available. The document associated with the Docket Exhibit may or may not be available for download, depending on whether it was successfully retrieved from the court's system.", "operationId": "webhook_handlerDocketExhibitSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketExhibitSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DocketExhibitSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "DocketExhibitSearch.failed", "description": "Emitted when a Docket Exhibit search for a given Docket Exhibit has failed.", "operationId": "webhook_handlerDocketExhibitSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DocketExhibitSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DMFSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "DMFSearch.submitted", "description": "Emitted when a Death Master File search has been submitted for processing.", "operationId": "webhook_handlerDMFSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DMFSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "DMFSearch.completed", "description": "Emitted when a Death Master File search has completed and results are available.", "operationId": "webhook_handlerDMFSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "DMFSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "DMFSearch.failed", "description": "Emitted when a Death Master File search has failed.", "operationId": "webhook_handlerDMFSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.DMFSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioItem.created": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioItem.created", "description": "Emitted when a business was added to the portfolio.", "operationId": "webhook_handlerPortfolioItem_created_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemCreatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioItem.updated": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioItem.updated", "description": "Emitted when a portfolio item has been updated.", "operationId": "webhook_handlerPortfolioItem_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioItem.deleted": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioItem.deleted", "description": "Emitted when a portfolio item has been deleted.", "operationId": "webhook_handlerPortfolioItem_deleted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioItemDeletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioGroup.created": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioGroup.created", "description": "Emitted when a portfolio group was created.", "operationId": "webhook_handlerPortfolioGroup_created_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupCreatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioGroup.updated": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioGroup.updated", "description": "Emitted when a portfolio group was updated.", "operationId": "webhook_handlerPortfolioGroup_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PortfolioGroup.deleted": { "post": { "tags": [ "Portfolio Monitoring", "Webhook Events" ], "summary": "PortfolioGroup.deleted", "description": "Emitted when a portfolio group was deleted.", "operationId": "webhook_handlerPortfolioGroup_deleted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PortfolioGroupDeletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LiensSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "LiensSearch.submitted", "description": "Emitted when a Liens search for a Business has been submitted for processing.", "operationId": "webhook_handlerLiensSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LiensSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "LiensSearch.completed", "description": "Emitted when a Liens search for a Business has completed and results are available.", "operationId": "webhook_handlerLiensSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LiensSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "LiensSearch.failed", "description": "Emitted when a Liens search for a Business has failed.", "operationId": "webhook_handlerLiensSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LiensSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LienFiling.created": { "post": { "tags": [ "Webhook Events" ], "summary": "LienFiling.created", "description": "Emitted when a Liens filing document has been created.", "operationId": "webhook_handlerLienFiling_created_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingCreatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LienFiling.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "LienFiling.updated", "description": "Emitted when a Liens filing document has been updated.", "operationId": "webhook_handlerLienFiling_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LienFiling.deleted": { "post": { "tags": [ "Webhook Events" ], "summary": "LienFiling.deleted", "description": "Emitted when a Liens filing document has been deleted.", "operationId": "webhook_handlerLienFiling_deleted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingDeletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LienFilingImportBatch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "LienFilingImportBatch.completed", "description": "Emitted when a bulk lien import batch has finished processing; the payload carries the per-outcome row counts.", "operationId": "webhook_handlerLienFilingImportBatch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingImportBatchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "LienFilingImportBatch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "LienFilingImportBatch.failed", "description": "Emitted when a bulk lien import batch has failed.", "operationId": "webhook_handlerLienFilingImportBatch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.LienFilingImportBatchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "EmailSender.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "EmailSender.failed", "description": "Emitted when the organization's SMTP sender has failed code emails for a reason the organization must fix, at most once an hour.", "operationId": "webhook_handlerEmailSender_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.EmailSenderFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "APIKey.created": { "post": { "tags": [ "Webhook Events" ], "summary": "APIKey.created", "description": "Emitted when a new API Key is created.", "operationId": "webhook_handlerAPIKey_created_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.APIKeyCreatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "APIKey.deleted": { "post": { "tags": [ "Webhook Events" ], "summary": "APIKey.deleted", "description": "Emitted when an API Key is deleted.", "operationId": "webhook_handlerAPIKey_deleted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.APIKeyDeletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "BusinessSearch.submitted", "description": "Emitted when a Business search has been submitted for processing.", "operationId": "webhook_handlerBusinessSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "BusinessSearch.completed", "description": "Emitted when a Business search has completed and business detail results are available.", "operationId": "webhook_handlerBusinessSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "BusinessSearch.failed", "description": "Emitted when a Business search has failed.", "operationId": "webhook_handlerBusinessSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.cancelled": { "post": { "tags": [ "Webhook Events" ], "summary": "BusinessSearch.cancelled", "description": "Emitted when a Business search has been cancelled.", "operationId": "webhook_handlerBusinessSearch_cancelled_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchCancelledWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "BusinessSearch.updated", "description": "Emitted when a Business search has been updated. E.g. if the IRS was down for tin matching, the search may be updated at a later date with the correct tin_matched result.", "operationId": "webhook_handlerBusinessSearch_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "BusinessSearch.updated.legacy": { "post": { "tags": [ "Webhook Events" ], "summary": "Business Search Legacy Updated", "description": "Emitted when a Business search has been updated. E.g. if the IRS was down for tin matching, the search may be updated at a later date with the correct tin_matched result.", "operationId": "business_search_legacy_updatedBusinessSearch_updated_legacy_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.BusinessSearchBusinessResponse" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "SearchBatch.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "SearchBatch.updated", "description": "Emitted when a search batch's downloadable results have been regenerated. A batch's CSV/JSONL/ZIP export and report are a snapshot taken when the batch finished, while some TIN (EIN) verifications were still resolving with the IRS; once those verdicts land the files are rewritten in place with the final results and this event is sent. The payload carries the batch's new `exports_generated_at`; re-download the export to pick up the change. The export URLs themselves are stable, so a cached copy is what goes stale, not the link.", "operationId": "webhook_handlerSearchBatch_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.SearchBatchUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "TINVerification.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "TINVerification.submitted", "description": "Emitted when a TIN verification has been submitted for processing.", "operationId": "webhook_handlerTINVerification_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "TINVerification.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "TINVerification.completed", "description": "Emitted when a TIN verification has completed.", "operationId": "webhook_handlerTINVerification_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "TINVerification.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "TINVerification.failed", "description": "Emitted when a TIN verification has failed.", "operationId": "webhook_handlerTINVerification_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.TINVerificationFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PersonSearch.submitted": { "post": { "tags": [ "Webhook Events" ], "summary": "PersonSearch.submitted", "description": "Emitted when a Person search has been submitted for processing.", "operationId": "webhook_handlerPersonSearch_submitted_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchSubmittedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PersonSearch.completed": { "post": { "tags": [ "Webhook Events" ], "summary": "PersonSearch.completed", "description": "Emitted when a Person search has completed and results are available.", "operationId": "webhook_handlerPersonSearch_completed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchCompletedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PersonSearch.failed": { "post": { "tags": [ "Webhook Events" ], "summary": "PersonSearch.failed", "description": "Emitted when a Person search has failed.", "operationId": "webhook_handlerPersonSearch_failed_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchFailedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "PersonSearch.updated": { "post": { "tags": [ "Webhook Events" ], "summary": "PersonSearch.updated", "description": "Emitted when a Person search has been updated. E.g. if the IRS was down for tin matching, the search may be updated at a later date with the correct tin_matched result.", "operationId": "webhook_handlerPersonSearch_updated_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.PersonSearchUpdatedWebhook" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "APIError": { "properties": { "code": { "type": "integer", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uri" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, "type": "object", "required": [ "code", "message" ], "title": "APIError", "description": "APIError is a Pydantic model for standardizing error responses from the API.\n\nThis class is used internally by APIException for JSON serialization.\nUsers should typically work with APIException directly in exception catalogs." }, "AddOperation": { "properties": { "op": { "type": "string", "const": "add", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" }, "value": { "title": "Value", "description": "The value to add" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path", "value" ], "title": "AddOperation", "description": "Add operation: adds a value to the target location.", "examples": [ { "op": "add", "path": "/servers/web3", "value": { "status": "healthy" } }, { "op": "add", "path": "/services/-", "value": "redis" } ] }, "AddPortfolioItemRequest": { "properties": { "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The optional UUID of the search that this portfolio item is based on.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ] }, "person_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Search Id", "description": "The optional UUID of the search that this portfolio item is based on.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ] }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id", "description": "The optional UUID of the group to add the newly created item to.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ] } }, "type": "object", "title": "AddPortfolioItemRequest" }, "AddPortfolioItemsBulkError": { "properties": { "business_search_id": { "type": "string", "format": "uuid", "title": "Business Search Id", "description": "The business search that failed to import." }, "code": { "$ref": "#/components/schemas/AddPortfolioItemsBulkErrorCode", "description": "A stable error code for the failed import.", "examples": [ "not_found", "already_exists", "ineligible" ] }, "existing_item_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Existing Item Id", "description": "The existing portfolio item ID for already monitored rows." } }, "type": "object", "required": [ "business_search_id", "code" ], "title": "AddPortfolioItemsBulkError", "description": "Minimal per-search failure returned by the bulk portfolio item endpoint.\n\nKeep bulk row errors small on purpose. The frontend needs row correlation,\na stable code for summaries, and the existing item ID when the business is\nalready monitored." }, "AddPortfolioItemsBulkErrorCode": { "type": "string", "enum": [ "not_found", "already_exists", "ineligible", "duplicate_request", "sandbox_fixture" ], "title": "AddPortfolioItemsBulkErrorCode", "description": "Stable per-search error codes returned by the bulk add endpoint." }, "AddPortfolioItemsBulkItemResponse": { "properties": { "business_search_id": { "type": "string", "format": "uuid", "title": "Business Search Id", "description": "The business search that was imported." }, "portfolio_item_id": { "type": "string", "format": "uuid", "title": "Portfolio Item Id", "description": "The created portfolio item ID." }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "The monitored business ID for targeted frontend cache refresh." } }, "type": "object", "required": [ "business_search_id", "portfolio_item_id", "business_id" ], "title": "AddPortfolioItemsBulkItemResponse", "description": "Minimal success payload for a created bulk portfolio item.\n\nKeep bulk successes small on purpose. The frontend needs these IDs for\ncounts, row correlation, and targeted cache refresh; full PortfolioItem\nhydration belongs behind the single-item GET endpoint." }, "AddPortfolioItemsBulkRequest": { "properties": { "business_search_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 250, "minItems": 1, "title": "Business Search Ids", "description": "The UUIDs of the business searches to add to portfolio monitoring.", "examples": [ [ "ede786f3-33ae-4894-843d-af2025f1d5b0", "e1d5e9e1-6de2-46c0-8492-564998a7426a" ] ] }, "group_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Group Id", "description": "The optional UUID of the group to add the newly created items to.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ] } }, "type": "object", "required": [ "business_search_ids" ], "title": "AddPortfolioItemsBulkRequest", "description": "Request body for adding multiple BusinessSearches to monitoring." }, "AddPortfolioItemsBulkResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AddPortfolioItemsBulkItemResponse" }, "type": "array", "title": "Items", "description": "Portfolio items successfully created." }, "errors": { "items": { "$ref": "#/components/schemas/AddPortfolioItemsBulkError" }, "type": "array", "title": "Errors", "description": "Per-search failures that did not block the whole request." } }, "type": "object", "title": "AddPortfolioItemsBulkResponse", "description": "Partial-success response for bulk portfolio item creation." }, "AddressMatchType": { "type": "string", "enum": [ "NO_MATCH", "CITY", "STATE", "SIMILAR", "EXACT" ], "title": "AddressMatchType" }, "AddressValidationLevel": { "type": "string", "enum": [ "FULL", "PARTIAL", "INVALID" ], "title": "AddressValidationLevel" }, "ApplicationChannel": { "type": "string", "enum": [ "OG", "BR", "ISO", "Other" ], "title": "ApplicationChannel" }, "ApplicationType": { "type": "string", "enum": [ "sandbox", "production" ], "title": "ApplicationType" }, "AuditEventType": { "type": "string", "enum": [ "issuance", "consumption", "identity_registration", "counterparty_registration", "credential_revocation", "credential_mint_failed", "operator_link_decision", "internal_join", "acceptance_audiences_changed", "acceptance_browser_key_changed" ], "title": "AuditEventType", "description": "The kinds of event recorded in the tamper-evident audit log.\n\n``Consumption`` dominates by volume — it fires on every agent request to\nevery merchant.\n\nThis diverges deliberately from the original brief's \"five event types\".\nConsent was dropped (it went unused), and the two categories that the brief\ntreated as single types each carry genuinely different payloads, so they are\nsplit rather than discriminated inside one type:\n\n* registration — a counterparty publishing its disclosure profile is\n unrelated to a person completing identity verification;\n* revocation — one short-lived credential killed by ``jti``. Nothing\n withdraws a subject's authority to mint, so this is the only shape.\n\nBecause ``event_type`` is a VARCHAR column rather than a native Postgres\nenum, adding or renaming a member here needs no migration." }, "AuditLogSortField": { "type": "string", "enum": [ "occurred_at" ], "title": "AuditLogSortField", "description": "What the audit log sorts by." }, "AutocompleteEntityType": { "type": "string", "enum": [ "business" ], "title": "AutocompleteEntityType", "description": "Entity types the GET /autocomplete route can suggest.\n\nOnly businesses are searchable today; officers, agents, and addresses\nrequire their own collections before they can join this enum." }, "AutocompleteRelation": { "type": "string", "enum": [ "businesses", "people", "addresses" ], "title": "AutocompleteRelation", "description": "A kind of row a suggestion relates to: the key of ``related.``." }, "AutocompleteRoute": { "type": "string", "enum": [ "businesses", "people", "addresses" ], "title": "AutocompleteRoute", "description": "A route of the autocomplete service a session may query: the path segment\nafter ``/autocomplete/``. A session's scope names the routes it reaches and,\nper route, the relations a request may include or filter by." }, "AutocompleteSessionScopeRequest": { "properties": { "routes": { "anyOf": [ { "additionalProperties": { "items": { "$ref": "#/components/schemas/AutocompleteRelation" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/AutocompleteRoute" }, "type": "object" }, { "type": "null" } ], "minLength": 1, "title": "Routes", "description": "The routes the session may query and, per route, the relations a request may include or filter by. Each must be one the caller may reach (else 403) and a relation of its route (else 422); none at all is a 422, since that session could query nothing. Left out, every route the caller may query, with every relation.", "examples": [ { "businesses": [ "addresses" ] } ] }, "max_limit": { "anyOf": [ { "type": "integer", "maximum": 20, "minimum": 1 }, { "type": "null" } ], "title": "Max Limit", "description": "The most suggestions a request may ask for. Left out, 20.", "examples": [ 5 ] } }, "additionalProperties": false, "type": "object", "title": "AutocompleteSessionScopeRequest", "description": "A narrowing of what a session may search; either part left out narrows\nnothing on that side." }, "Body_import_lien_filings_in_bulk_lien_submissions_import_batches_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_import_lien_filings_in_bulk_lien_submissions_import_batches_post" }, "Body_post_consortium_search_batch_consortium_searches_batches_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_post_consortium_search_batch_consortium_searches_batches_post" }, "Body_post_ofac_batch_ofac_searches_batches_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_post_ofac_batch_ofac_searches_batches_post" }, "Body_post_submission_consortium_submissions_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_post_submission_consortium_submissions_post" }, "Body_upload_lien_submission_attachment_item_attachment_lien_submissions__filing_id__attachments_post": { "properties": { "attachments": { "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "type": "array", "title": "Lien Filing Attachments", "description": "A list of files to be attached to the lien filing submission. These can include documents supporting the lien claim." } }, "type": "object", "required": [ "attachments" ], "title": "Body_upload_lien_submission_attachment_item_attachment_lien_submissions__filing_id__attachments_post" }, "BusinessKybOutcome": { "type": "string", "enum": [ "VERIFIED", "NOT_VERIFIED" ], "title": "BusinessKybOutcome", "description": "What the organization's latest confirmation concluded about a business.\n\nTwo values only: a listed business always has a KYB match behind its\nreference, so a check that never finished (stored NULL) is NOT_VERIFIED\nwith ``BusinessNotVerifiedReason.VerificationIncomplete``, not a third\noutcome." }, "BusinessOperatorLinkShortfall": { "type": "string", "enum": [ "TIN_NOT_PROVIDED", "TIN_NOT_MATCHED", "KYB_NOT_VERIFIED" ], "title": "BusinessOperatorLinkShortfall", "description": "Which leg of the operator-link evidence recipe a covering evaluation\nfailed.\n\nReviewer-facing: a session whose evaluation reports any shortfall records\nan UNDER_REVIEW link, and these name what a reviewer would be overriding\nby verifying it anyway. An evaluation that reports none earns VERIFIED on\nits own." }, "BusinessOperatorLinkStatus": { "type": "string", "enum": [ "VERIFIED", "UNDER_REVIEW", "REJECTED" ], "title": "BusinessOperatorLinkStatus", "description": "Your organization's status for the link between an individual and a\nbusiness they operate.\n\nVERIFIED is earned by the full evidence recipe (TIN provided +\nIRS-matched + KYB-verified) on one of your own sessions, or decided by\nyour organization; UNDER_REVIEW is every automatic shortfall; REJECTED\nis your organization's refusal, which stands until you decide again.\nAnother organization's evidence or decision never changes it." }, "BusinessOrPersonType": { "type": "string", "enum": [ "Business", "Person" ], "title": "BusinessOrPersonType" }, "BusinessSearchOptions": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ] }, "BusinessSearchOptionsOutput": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptionsOutput" }, "BusinessStructure": { "type": "string", "enum": [ "SOLE_PROPRIETORSHIP", "GENERAL_PARTNERSHIP", "LLC", "LLP", "LLLP", "LP", "C_CORPORATION", "S_CORPORATION", "B_CORPORATION", "NONPROFIT", "COOPERATIVE", "TRUST", "PROFESSIONAL_ASSOCIATION", "PROFESSIONAL_CORPORATION", "TRADE_NAME", "BANK", "CREDIT_UNION", "INSURANCE", "OTHER" ], "title": "BusinessStructure" }, "Channel": { "type": "string", "maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "title": "Channel", "examples": [ "project_1337" ] }, "ChargeCategory": { "type": "string", "enum": [ "Criminal Intent", "Drugs & Alcohol", "Fraud & Deception", "Homicide", "Security", "Sexual", "Statutory", "Theft & Property", "Vehicles & Traffic", "Violence", "unclassified" ], "title": "ChargeCategory", "description": "The highest level of categorization of a charge." }, "ChargeSubcategory": { "type": "string", "enum": [ "Accessory", "Conspiracy", "Court Orders", "Criminal Tools", "Obstruction", "Organized Crime", "Alcohol & Tobacco", "Driving under the Influence (DUI)", "Drugs-Marijuana Possession/Use", "Drugs-Possession/Use", "Drugs-Sale & Manufacture", "Bribery & Corruption", "Business & Tax", "Cyber Crimes", "Embezzlement", "Forgery", "Fraud", "Identity Theft & Impersonation", "Worthless Check", "Attempted Homicide", "Intentional Homicide", "Unintentional Killing", "Immigration", "Terrorism", "Treason", "Lewd Behavior", "Prostitution", "Sexual Abuse", "Animal Ordinances", "Custody & Support", "Fish & Game", "Gambling", "Miscellaneous Citations & Violations", "Public Nuisance", "Safety & Zoning", "Arson", "Burglary", "Petty Theft", "Possession of Stolen Property", "Robbery", "Theft", "Trespassing", "Vandalism & Mischief", "License & Registration", "Parking", "Speeding", "Unsafe Operation", "Vehicle Equipment", "Abduction & Restraint", "Animal Cruelty", "Assault & Battery", "Child & Elder Abuse", "Disorderly Behavior", "Harassment & Threats", "Weapons & Endangerment", "unclassified" ], "title": "ChargeSubcategory", "description": "The second level of categorization of a charge." }, "ChargeType": { "type": "string", "enum": [ "felony", "misdemeanor", "petty_offense", "unknown" ], "title": "ChargeType", "description": "The level / severity of a charge." }, "CheckOperation": { "properties": { "op": { "type": "string", "const": "test", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" }, "value": { "title": "Value", "description": "The value to test against" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path", "value" ], "title": "CheckOperation", "description": "Test operation: tests that a value at the target location equals a specified value.\n\nNote: Renamed from TestOperation to avoid pytest collection warnings.", "examples": [ { "op": "test", "path": "/servers/web1/status", "value": "healthy" }, { "op": "test", "path": "/version", "value": "1.2.3" } ] }, "ClaimDisplay": { "properties": { "locale": { "type": "string", "title": "Locale", "default": "en-US" }, "label": { "type": "string", "title": "Label" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "additionalProperties": false, "type": "object", "required": [ "label" ], "title": "ClaimDisplay" }, "ClaimMetadata": { "properties": { "path": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Path" }, "display": { "items": { "$ref": "#/components/schemas/ClaimDisplay" }, "type": "array", "title": "Display" }, "sd": { "$ref": "#/components/schemas/SelectiveDisclosure" }, "mandatory": { "type": "boolean", "title": "Mandatory", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "path", "display", "sd" ], "title": "ClaimMetadata", "description": "One ``claims`` entry (§5.6). ``sd`` is always explicit, because an\nomitted ``sd`` means ``allowed``." }, "ClosureReason": { "type": "string", "enum": [ "WPF", "WIF", "WSF", "WFU", "WBC", "WUP", "WBK", "WCX", "CAE", "PIF" ], "title": "ClosureReason", "description": "The specific cause of closure.\n\nDistinct from :class:`ClosureStatus` (what happened to the money) and\n:class:`ClosureFamily` (which bucket the cause falls in). When a case fits\nmore than one family, members file the primary driver: confirmed fraud\nbeats compliance beats credit, and within fraud, synthetic beats\nfirst-party." }, "ClosureStatus": { "type": "string", "enum": [ "WO", "SD", "CL", "PIF" ], "title": "ClosureStatus", "description": "What happened to the money when the account closed." }, "ConfirmedAddressFields": { "properties": { "street_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street Address", "description": "Street address line." }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City." }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State", "description": "State or region." }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Postal Code", "description": "Postal / ZIP code." }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "ISO country code.", "default": "US" } }, "additionalProperties": false, "type": "object", "title": "ConfirmedAddressFields", "description": "A postal address, split into its parts." }, "ContactRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "email": { "type": "string", "format": "email", "title": "Email" } }, "type": "object", "required": [ "name", "email" ], "title": "ContactRequest" }, "CopyOperation": { "properties": { "op": { "type": "string", "const": "copy", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" }, "from": { "type": "string", "title": "From", "description": "JSON Pointer path to source location" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path", "from" ], "title": "CopyOperation", "description": "Copy operation: copies a value from one location to another.", "examples": [ { "from": "/servers/web1", "op": "copy", "path": "/servers/web1-backup" }, { "from": "/config/template", "op": "copy", "path": "/config/instance1" } ] }, "CreateOrganizationRequest": { "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 3, "title": "Name" }, "domain_name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Domain Name" }, "type": { "$ref": "#/components/schemas/OrganizationType" }, "external_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 3 }, { "type": "null" } ], "title": "External Id" }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/ContactRequest" }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "type" ], "title": "CreateOrganizationRequest" }, "CreatePortfolioGroupRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name", "description": "The name of the portfolio group." } }, "type": "object", "required": [ "name" ], "title": "CreatePortfolioGroupRequest" }, "CredentialEventKind": { "type": "string", "enum": [ "ISSUED", "REVOKED" ], "title": "CredentialEventKind", "description": "What happened to a credential, as one row of its event stream." }, "CredentialEventSortField": { "type": "string", "enum": [ "occurred_at" ], "title": "CredentialEventSortField", "description": "What a credential event list sorts by." }, "CredentialMintLevel": { "type": "string", "enum": [ "L2", "L3" ], "title": "CredentialMintLevel", "description": "The credential layer a subject mint request selects (KYA).\n\nDeliberately narrower than ``IssuedCredentialType``: the individual\nand business mint routes issue only the two subject layers.\nCounterparty credentials have their own route and request shape, so\na ``level`` of COUNTERPARTY must stay an edge-level payload refusal\n— this enum is what keeps issuance-record vocabulary growth from\nwidening the mint requests." }, "CredentialPresetSortField": { "type": "string", "enum": [ "name" ], "title": "CredentialPresetSortField", "description": "What the credential presets list sorts by." }, "CredentialSortField": { "type": "string", "enum": [ "issued_at", "expires_at" ], "title": "CredentialSortField", "description": "What a credential list sorts by." }, "CriminalCheckType": { "type": "string", "enum": [ "instant_criminal", "sex_offender_registry" ], "title": "CriminalCheckType", "description": "The type of criminal check to run." }, "CurrencyCode": { "type": "string", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD" ], "title": "CurrencyCode", "description": "Currencies a CURRENCY element can denominate its amount in." }, "DMFSearchRequest": { "properties": { "name": { "type": "string", "maxLength": 250, "title": "Name", "description": "The name of the person of interest" }, "ssn": { "type": "string", "format": "password", "title": "Ssn", "description": "The social security number of the person of interest", "writeOnly": true } }, "type": "object", "required": [ "name", "ssn" ], "title": "DMFSearchRequest" }, "DataTestKYBAnswers": { "properties": { "current_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Provider", "examples": [ "Middesk" ] }, "new_applications_per_month": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "New Applications Per Month", "examples": [ 500 ] }, "avg_uw_time_hours": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Uw Time Hours", "examples": [ 24 ] }, "avg_uw_time_minutes": { "anyOf": [ { "type": "integer", "maximum": 59, "minimum": 0 }, { "type": "null" } ], "title": "Avg Uw Time Minutes", "examples": [ 2 ] }, "match_rate_pct": { "anyOf": [ { "type": "number", "maximum": 100.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Match Rate Pct", "examples": [ 25.0 ] }, "approval_rate_pct": { "anyOf": [ { "type": "number", "maximum": 100.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Approval Rate Pct", "examples": [ 72.0 ] } }, "type": "object", "title": "DataTestKYBAnswers", "description": "Business Verification / KYB answers from the data-test questionnaire." }, "DataTestLiensAnswers": { "properties": { "current_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Provider", "examples": [ "LexisNexis" ] } }, "type": "object", "title": "DataTestLiensAnswers", "description": "Liens Search answers from the data-test questionnaire." }, "DataTestLitigationsAnswers": { "properties": { "current_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Provider", "examples": [ "LexisNexis" ] } }, "type": "object", "title": "DataTestLitigationsAnswers", "description": "Litigations Search answers from the data-test questionnaire." }, "DataTestQuestionnaire": { "properties": { "kyb": { "anyOf": [ { "$ref": "#/components/schemas/DataTestKYBAnswers" }, { "type": "null" } ] }, "web_presence": { "anyOf": [ { "$ref": "#/components/schemas/DataTestWebPresenceAnswers" }, { "type": "null" } ] }, "liens": { "anyOf": [ { "$ref": "#/components/schemas/DataTestLiensAnswers" }, { "type": "null" } ] }, "litigations": { "anyOf": [ { "$ref": "#/components/schemas/DataTestLitigationsAnswers" }, { "type": "null" } ] } }, "type": "object", "title": "DataTestQuestionnaire", "description": "Answers collected from the data-test Product Selection step.\n\nPersisted on the parent :class:`osiris.models.SearchBatch` row as a\nJSONB column for later analysis, and echoed to Slack for real-time\nops visibility." }, "DataTestWebPresenceAnswers": { "properties": { "existing_workflow_step": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Existing Workflow Step" }, "current_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Provider", "examples": [ "Built in-house" ] } }, "type": "object", "title": "DataTestWebPresenceAnswers", "description": "Web Presence Review answers from the data-test questionnaire.\n\nThe list of sub-products the prospect opted into for Web Presence\n(Industry Prediction, Website Analysis, etc.) is deliberately not\ncaptured here — those selections are already represented by\n:class:`osiris.enums.BusinessSearchOptions` on the parent batch\n(``options`` on :class:`BusinessSearchBatchRequest`)." }, "DatePrecision": { "type": "string", "enum": [ "NO_YEAR", "NO_MONTH", "NO_DAY", "ONLY_YEAR", "ONLY_MONTH", "ONLY_DAY", "FULL" ], "title": "DatePrecision" }, "DefaultRequestMode": { "type": "string", "enum": [ "sync", "async" ], "title": "DefaultRequestMode", "description": "Controls whether API key-authenticated requests default to synchronous or asynchronous execution.\n\nExisting API keys default to ``Async`` for backward compatibility. New organizations\nand federations are provisioned with ``Sync`` so new customers get immediate results.\nThe ``Prefer`` header (RFC 7240) always takes precedence over this default." }, "DiffFormat": { "type": "string", "enum": [ "json", "notifications", "json_patch" ], "title": "DiffFormat", "description": "Format options for portfolio item snapshot diff responses." }, "DirectoryBusinessSortField": { "type": "string", "enum": [ "name" ], "title": "DirectoryBusinessSortField", "description": "What the directory of businesses sorts by." }, "DispositionType": { "type": "string", "enum": [ "Conviction", "Dismissed", "Invalid", "Merged", "Pending", "Transferred", "Warrant", "Unclassified" ], "title": "DispositionType", "description": "The type of disposition." }, "DocketSearchOptions": { "type": "string", "enum": [ "Order.Litigations", "Order.Bankruptcy" ] }, "EmailSendResultKind": { "type": "string", "enum": [ "SENT", "REJECTED_RECIPIENT", "REJECTED_SENDER", "AUTH_FAILED", "DEFERRED", "DEFERRED_RECIPIENT", "UNREACHABLE", "TIMEOUT" ], "title": "EmailSendResultKind", "description": "How a send ended. Every kind but ``SENT`` is a failure." }, "EmailSenderStatus": { "type": "string", "enum": [ "UNVERIFIED", "VERIFIED", "FAILING" ], "title": "EmailSenderStatus", "description": "Whether an organization's SMTP sender may carry its flows' code emails." }, "EmployeeVerificationContact": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email address." }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone", "description": "Phone number." } }, "type": "object", "title": "EmployeeVerificationContact" }, "EmployeeVerificationMiscLink": { "properties": { "label": { "type": "string", "title": "Label", "description": "Description of the link (e.g. 'GitHub profile', 'Personal website')." }, "url": { "type": "string", "title": "Url", "description": "URL." } }, "type": "object", "required": [ "label", "url" ], "title": "EmployeeVerificationMiscLink" }, "EmployeeVerificationSocial": { "properties": { "platform": { "$ref": "#/components/schemas/SocialSite", "description": "Social media platform." }, "url": { "type": "string", "title": "Url", "description": "Profile URL." } }, "type": "object", "required": [ "platform", "url" ], "title": "EmployeeVerificationSocial" }, "EmployeeVerificationSource": { "properties": { "url": { "type": "string", "title": "Url", "description": "URL of the source." }, "description": { "type": "string", "title": "Description", "description": "What this source says about the person." } }, "type": "object", "required": [ "url", "description" ], "title": "EmployeeVerificationSource" }, "EndpointIn": { "properties": { "channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Channel" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Channels", "description": "List of message channels this endpoint listens to (omit for all)", "examples": [ [ "project_123", "group_2" ] ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "default": "", "examples": [ "An example endpoint name" ] }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled", "default": false, "examples": [ false ] }, "filter_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterType" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Filter Types", "examples": [ [ "user.signup", "user.deleted" ] ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "default": {} }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Rate Limit" }, "secret": { "anyOf": [ { "type": "string", "pattern": "^(whsec_)?[a-zA-Z0-9+/=]{32,100}$" }, { "type": "null" } ], "title": "Secret", "description": "The endpoint's verification secret. If `null` is passed, a secret is automatically generated. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. Recommended size: 24.", "examples": [ "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD" ] }, "uid": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$" }, { "type": "null" } ], "title": "Uid", "description": "Optional unique identifier for the endpoint", "examples": [ "unique-ep-identifier" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "examples": [ "https://example.com/webhook/" ] }, "version": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Version", "default": 1, "examples": [ 1 ] } }, "type": "object", "required": [ "url" ], "title": "EndpointIn" }, "EndpointOut": { "properties": { "channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Channel" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Channels", "description": "List of message channels this endpoint listens to (omit for all)", "examples": [ [ "project_123", "group_2" ] ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "description": { "type": "string", "title": "Description", "description": "An example endpoint name" }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled", "default": false, "examples": [ false ] }, "filter_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterType" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Filter Types", "examples": [ [ "user.signup", "user.deleted" ] ] }, "id": { "type": "string", "title": "Id", "description": "The ep's ID", "examples": [ "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2" ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Metadata" }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Rate Limit" }, "uid": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$" }, { "type": "null" } ], "title": "Uid", "description": "Optional unique identifier for the endpoint", "examples": [ "unique-ep-identifier" ] }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "examples": [ "https://example.com/webhook/" ] }, "version": { "type": "integer", "minimum": 1, "title": "Version", "examples": [ 1 ] } }, "type": "object", "required": [ "created_at", "description", "id", "metadata", "updated_at", "url", "version" ], "title": "EndpointOut" }, "EndpointPatch": { "properties": { "channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Channel" }, "type": "array" }, { "type": "null" } ], "title": "Channels" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled" }, "filter_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterType" }, "type": "array" }, { "type": "null" } ], "title": "Filter Types" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Rate Limit" }, "secret": { "anyOf": [ { "type": "string", "pattern": "^(whsec_)?[a-zA-Z0-9+/=]{32,100}$" }, { "type": "null" } ], "title": "Secret", "description": "The endpoint's verification secret. If `null` is passed, a secret is automatically generated. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. Recommended size: 24.", "examples": [ "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD" ] }, "uid": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$" }, { "type": "null" } ], "title": "Uid", "description": "The ep's UID", "examples": [ "unique-ep-identifier" ] }, "url": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Url" }, "version": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Version", "examples": [ 1 ] } }, "type": "object", "title": "EndpointPatch" }, "EndpointUpdate": { "properties": { "channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Channel" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Channels", "description": "List of message channels this endpoint listens to (omit for all)", "examples": [ [ "project_123", "group_2" ] ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "default": "", "examples": [ "An example endpoint name" ] }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled", "default": false, "examples": [ false ] }, "filter_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterType" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Filter Types", "examples": [ [ "user.signup", "user.deleted" ] ] }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata", "default": {} }, "rate_limit": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Rate Limit" }, "uid": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$" }, { "type": "null" } ], "title": "Uid", "description": "Optional unique identifier for the endpoint", "examples": [ "unique-ep-identifier" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "examples": [ "https://example.com/webhook/" ] }, "version": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Version", "default": 1, "examples": [ 1 ] } }, "type": "object", "required": [ "url" ], "title": "EndpointUpdate" }, "EntityType": { "type": "string", "enum": [ "CORPORATION", "LLC", "PARTNERSHIP", "SOLE PROPRIETORSHIP", "NON-PROFIT", "TRUST", "AGENT", "UNKNOWN" ], "title": "EntityType" }, "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." }, "FederationGrant": { "type": "string", "enum": [ "sandbox", "production", "admin" ], "title": "FederationGrant", "description": "Capabilities granted to a federation-owner API key.\n\nPopulated only on ``APIKey`` rows where ``owner == Federation``; ``NULL``\nelsewhere. A federation key must have at least one grant." }, "FilterType": { "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "title": "FilterType", "description": "The event type's name", "examples": [ "user.signup" ] }, "Gender": { "type": "string", "enum": [ "M", "F" ], "title": "Gender" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "IRSTINMatchType": { "type": "string", "enum": [ "SSN", "EIN", "UNKNOWN" ], "title": "IRSTINMatchType" }, "ISO2CountryCode": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ISO2CountryCode", "description": "Enumeration of ISO 3166-1 alpha-2 country codes.\n\nAttributes:\n (Various country codes like Andorra = \"AD\", etc.)" }, "IdentityBusinessSortField": { "type": "string", "enum": [ "last_activity", "name", "created_at" ], "title": "IdentityBusinessSortField", "description": "What the businesses list sorts by." }, "IdentityDirectoryLink": { "type": "string", "enum": [ "linked", "link_request", "none" ], "title": "IdentityDirectoryLink", "description": "The people list's business segments, read off the organization's own\noperator links." }, "IdentityIndividualSortField": { "type": "string", "enum": [ "last_activity", "name", "verified_at" ], "title": "IdentityIndividualSortField", "description": "What the people list sorts by." }, "IdentityMatchConfidenceLevel": { "type": "string", "enum": [ "high", "medium", "low", "unknown", "insufficient_information" ], "title": "IdentityMatchConfidenceLevel", "description": "How strongly a criminal case aligns with the submitted PII.\n\nhigh/medium/low are assigned by Checkr's ML algorithm. ``unknown`` means\nidentity matching was enabled but no label could be determined for the\ncase; ``insufficient_information`` means identity matching was skipped.\nOmitted entirely when identity matching was not enabled for the check." }, "IdentityVerificationState": { "type": "string", "enum": [ "CURRENT", "EXPIRED", "SUPERSEDED" ], "title": "IdentityVerificationState", "description": "Verification state of an identity, as seen by the referencing\norganization.\n\nCURRENT: an unexpired verification exists and credentials can be\nminted. EXPIRED: the verification's validity window has lapsed —\nre-verify before minting. SUPERSEDED: no active verification record\nremains; a new submission is required." }, "InputSocialProfile": { "properties": { "site": { "type": "string", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "description": "The social media platform.", "examples": [ "linked_in:company" ] }, "value": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Value", "description": "A username, handle, URL, or name associated with the business on the specified platform.", "examples": [ "acme-corp", "https://www.linkedin.com/company/acme-corp/" ] } }, "type": "object", "required": [ "site", "value" ], "title": "InputSocialProfile" }, "InternationalAddressMatchType": { "type": "string", "enum": [ "NO_MATCH", "REGION", "CITY", "COUNTRY", "EXACT" ], "title": "InternationalAddressMatchType" }, "InternationalBusinessSearchOptions": { "type": "string", "enum": [ "Order.Pep", "Order.Enhanced" ] }, "InternationalSearchISO2CountryCode": { "type": "string", "enum": [ "AR", "AU", "AT", "BH", "BE", "BA", "BR", "BN", "KH", "CA", "CN", "CO", "HR", "CW", "CY", "CZ", "DK", "DO", "EE", "FI", "FR", "GF", "PF", "GE", "DE", "GI", "GR", "GP", "GG", "HK", "IS", "IN", "IE", "IM", "IL", "IT", "JP", "KE", "LV", "LI", "LT", "LU", "MY", "MH", "MQ", "YT", "MX", "ME", "NL", "NC", "NZ", "NG", "NO", "OM", "PK", "PA", "PE", "PL", "PT", "QA", "RE", "RO", "RU", "BL", "PM", "WS", "SA", "SG", "SK", "SI", "SB", "ES", "SE", "CH", "TW", "TT", "TR", "UG", "UA", "GB", "UY", "VI", "VU", "WF" ], "title": "InternationalSearchISO2CountryCode", "description": "Enumeration of ISO 3166-1 alpha-2 country codes supported for international searches.\n\nThis is a subset of ISO2CountryCode that includes only jurisdictions where\ninternational search capabilities are available." }, "IssuedCredentialLifecycleState": { "type": "string", "enum": [ "ACTIVE", "EXPIRED", "REVOKED" ], "title": "IssuedCredentialLifecycleState", "description": "A credential's effective state as an issuance-log reader sees it.\n\nDerived, never stored: ``IssuedCredentialStatus`` deliberately keeps\nexpiry out of the persisted status (verifiers check ``exp``), but the\nconsole and API consumers filter the log by what a credential *is*\nright now — still presentable, aged out, or killed." }, "JSONPatchOperationType": { "type": "string", "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "title": "JSONPatchOperationType", "description": "Enumeration of valid JSON Patch operation types." }, "JsonValue": {}, "KYBResult": { "properties": { "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Normalized onboarding verdict." }, "search": { "anyOf": [ { "$ref": "#/components/schemas/v1.GetBusinessSearchResponse" }, { "type": "null" } ], "description": "The complete business-search payload backing the KYB check — identical in shape to GET /searches/{id} — frozen at packet delivery. Null when the check minted no search (no business input reached it)." } }, "additionalProperties": false, "type": "object", "title": "KYBResult", "description": "Business verification (KYB) result: the verdict plus the full business\nsearch, in the shape ``GET /searches/{id}`` returns, frozen when the\nsession completed." }, "KYCAssociationRecord": { "properties": { "value": { "type": "string", "title": "Value", "description": "The associated value." }, "first_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Seen", "description": "Provider first-seen date." }, "last_seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen", "description": "Provider last-seen date." }, "matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Matched", "description": "Whether it matched the submitted value." } }, "additionalProperties": false, "type": "object", "required": [ "value" ], "title": "KYCAssociationRecord", "description": "One historical value (phone / address / email) linked to the identity." }, "KYCAttributeMatch": { "properties": { "attribute": { "$ref": "#/components/schemas/KYCMatchAttribute", "description": "The identity attribute compared." }, "level": { "$ref": "#/components/schemas/KYCCorrelationLevel", "description": "How closely the attribute matched." } }, "additionalProperties": false, "type": "object", "required": [ "attribute", "level" ], "title": "KYCAttributeMatch", "description": "How one submitted identity attribute compared against verified records." }, "KYCCorrelationLevel": { "type": "string", "enum": [ "EXACT", "PARTIAL", "NO_MATCH" ], "title": "KYCCorrelationLevel", "description": "How strongly a submitted identity field correlates to verified records.\n\nThe reviewer-facing discretization of a provider's identity-match\nsignals; each provider adapter maps its own convention onto these levels." }, "KYCEvidence": { "properties": { "attribute_matches": { "items": { "$ref": "#/components/schemas/KYCAttributeMatch" }, "type": "array", "title": "Attribute Matches", "description": "Per-attribute identity match classifications." }, "watchlist_hits": { "anyOf": [ { "items": { "$ref": "#/components/schemas/KYCWatchlistHit" }, "type": "array" }, { "type": "null" } ], "title": "Watchlist Hits", "description": "Watchlist sources with hits against the person, mirroring the business watchlist_hits shape. An empty list is an affirmative all-clear (screening ran, nothing found); None means the provider ran no watchlist screening." }, "risk_signals": { "items": { "$ref": "#/components/schemas/KYCRiskSignal" }, "type": "array", "title": "Risk Signals", "description": "Risk findings the evaluation affirmatively flagged; empty when nothing was flagged." }, "identity_history": { "anyOf": [ { "$ref": "#/components/schemas/KYCIdentityHistory" }, { "type": "null" } ], "description": "Historical identity associations." }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At", "description": "When the evaluation's findings were created (the provider evaluation end time), mirroring the KYB search's created_at." } }, "additionalProperties": false, "type": "object", "title": "KYCEvidence", "description": "The evidence behind a KYC verdict. Every field is optional." }, "KYCIdentityHistory": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases", "description": "Known name aliases." }, "addresses": { "items": { "$ref": "#/components/schemas/KYCAssociationRecord" }, "type": "array", "title": "Addresses", "description": "Associated addresses." }, "phones": { "items": { "$ref": "#/components/schemas/KYCAssociationRecord" }, "type": "array", "title": "Phones", "description": "Associated phone numbers." }, "emails": { "items": { "$ref": "#/components/schemas/KYCAssociationRecord" }, "type": "array", "title": "Emails", "description": "Associated emails." } }, "additionalProperties": false, "type": "object", "title": "KYCIdentityHistory", "description": "Historical associations the provider has observed for this identity." }, "KYCIdentitySource": { "type": "string", "enum": [ "PREFILL", "SELF_ENTERED", "CUSTOMER_ASSERTED" ], "title": "KYCIdentitySource", "description": "How the identity a KYC check ran against was established.\n\nPREFILL: disclosed by the identity provider after the applicant proved\npossession of their phone. SELF_ENTERED: typed by the applicant.\nCUSTOMER_ASSERTED: submitted by you through the identity-submission API." }, "KYCMatchAttribute": { "type": "string", "enum": [ "NAME", "DOB", "ADDRESS", "PHONE", "NATIONAL_ID" ], "title": "KYCMatchAttribute", "description": "Identity attribute a KYC check compares against verified records." }, "KYCResult": { "properties": { "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Normalized onboarding verdict." }, "search": { "anyOf": [ { "$ref": "#/components/schemas/KYCEvidence" }, { "type": "null" } ], "description": "The identity evaluation's distilled, provider-neutral findings — the KYC analogue of the KYB section's embedded search. None when KYC never evaluated (no confirmed identity to run against)." } }, "additionalProperties": false, "type": "object", "title": "KYCResult", "description": "Identity verification (KYC) result: the verdict and its evidence." }, "KYCRiskSignal": { "type": "string", "enum": [ "DECEASED", "CORRECTIONAL_ADDRESS", "NATIONAL_ID_BEFORE_DOB", "RECENT_SIM_SWAP", "RECENT_PORT", "CALL_FORWARDING", "VOIP_LINE", "RECYCLED_PHONE", "VELOCITY_ANOMALY", "NO_IDENTITY_FOR_PHONE" ], "title": "KYCRiskSignal", "description": "Discrete risk findings a KYC evaluation affirmatively flagged.\n\nA closed vocabulary of conditions any identity verification provider can\nreport; adapters map their own wire signals onto these members, and a\nsignal appears only when the provider flagged the condition (absence\nmeans \"not flagged\", never \"not checked\")." }, "KYCWatchlistHit": { "properties": { "name": { "$ref": "#/components/schemas/KYCWatchlistSource", "description": "Watchlist source, named as in business watchlist results. OTHER carries hits from sources outside that list.", "examples": [ "OFAC" ] }, "count": { "type": "integer", "title": "Count", "description": "Number of hits found in this source." } }, "additionalProperties": false, "type": "object", "required": [ "name", "count" ], "title": "KYCWatchlistHit", "description": "One watchlist source with hits against the person." }, "KYCWatchlistSource": { "type": "string", "enum": [ "OFAC", "PEP", "CSL", "FBI", "CNS", "OIG", "OTHER" ], "title": "KYCWatchlistSource", "description": "Watchlist a KYC check can report hits from. OTHER covers any source\noutside this list; its records are kept on the hit's details." }, "LienFilingAlternativeNameDesignation": { "type": "string", "enum": [ "AGLIEN", "BAILEE_BAILOR", "CONSIGNEE_CONSIGNOR", "LESSEE_LESSOR", "NON_UCC_FILING", "SELLER_BUYER", "LICENSEE", "DEBTOR_SECURED_PARTY" ], "title": "LienFilingAlternativeNameDesignation" }, "LienFilingAlternativeType": { "type": "string", "enum": [ "TRANSMITTING_UTILITY", "MANUFACTURED_HOME", "PUBLIC_FINANCE", "NOT_APPLICABLE" ], "title": "LienFilingAlternativeType" }, "LienFilingAmendmentActionType": { "type": "string", "enum": [ "TERMINATION", "CONTINUATION", "ASSIGNMENT", "DEBTOR_AMENDMENT", "SECURED_PARTY_AMENDMENT", "COLLATERAL_AMENDMENT" ], "title": "LienFilingAmendmentActionType", "description": "The `LienFilingAmendmentActionType` enum represents the actions that can be taken on a UCC-3\nlien filing submission." }, "LienFilingCollateralAmendmentType": { "type": "string", "enum": [ "ADD", "RESTATE", "DELETE" ], "title": "LienFilingCollateralAmendmentType", "description": "Enum representing the types of amendments that can be made to collateral in a lien filing.\n\nThis enum defines the possible actions that can be taken when amending\ninformation about collateral in a lien filing." }, "LienFilingCollateralStatementDesignation": { "type": "string", "enum": [ "NONE", "TRUST", "PERSONAL_REPRESENTATIVE" ], "title": "LienFilingCollateralStatementDesignation", "description": "Enumeration of possible designations for a lien collateral statement." }, "LienFilingOrigin": { "type": "string", "enum": [ "filed_via_baselayer", "imported" ], "title": "LienFilingOrigin" }, "LienFilingStatus": { "type": "string", "enum": [ "Active", "Inactive", "Lapsed", "Released", "Satisfied", "Expired", "Pending", "Contested", "Disputed", "Perfected", "Unperfected", "Void", "Invalid", "Enforcement", "Foreclosure", "Subordinated", "Avoided", "Terminated", "Draft", "InPreperation", "Unknown" ], "title": "LienFilingStatus", "description": "Enumeration of possible statuses for a lien filing. A lien filing's status\nindicates its current state within its lifecycle and legal enforceability." }, "LienFilingSubmissionStatus": { "type": "string", "enum": [ "Draft", "Requested", "InReview", "NeedsAttention", "Submitted", "Filed", "Cancelled" ], "title": "LienFilingSubmissionStatus", "description": "Enum class delineating the various stages of a lien filing submission's lifecycle." }, "LienFilingSubmissionType": { "type": "string", "enum": [ "UCC1", "UCC3" ], "title": "LienFilingSubmissionType", "description": "Enum for Lien Filing Submission Types.\n\nThis enum defines the different types of lien filing submissions that can be made.\nCurrently, it includes UCC1 and UCC3 as possible submission types, representing\ninitial financing statements and amendments or continuations respectively." }, "LienFilingTaxExemptReason": { "type": "string", "enum": [ "DEBTOR_COOPERATIVE_MARKETING_ASSOCIATION", "DEBTOR_CREDIT_UNION", "DEBTOR_TELEPHONE_COOPERATIVE", "GOVERNMENT_AGENCY", "JUDGEMENT_LIEN", "MUNICIPALITY", "REORGANIZATION", "SECURITIES", "STATE_AGENCY", "NOT_EXEMPT" ], "title": "LienFilingTaxExemptReason", "description": "Enum for the tax exempt reason for a lien filing." }, "LienHistorySortField": { "type": "string", "enum": [ "updated_at", "filing_date", "lapse_date" ], "title": "LienHistorySortField", "description": "The column an organization's lien filing history is ordered by." }, "LienHistoryStanding": { "type": "string", "enum": [ "Active", "Lapsed", "Terminated", "Unknown" ], "title": "LienHistoryStanding", "description": "The standings the lien filing history derives, a subset of\n`LienFilingStatus`: the renderer never shows the others for a filing." }, "LienInitialFilingLookupOutcome": { "type": "string", "enum": [ "filed_via_baselayer", "imported", "imported_unverified", "not_found" ], "title": "LienInitialFilingLookupOutcome", "description": "How an initial-filing lookup for a UCC-3 resolved (ENG-6940).\n\nThe lookup starts a UCC-3 amendment from a `(state, filing number)` pair,\nand the outcome names which record the amendment can now target." }, "LienInitialFilingLookupWarning": { "type": "string", "enum": [ "filing_date_mismatch", "filing_date_after_lapse_date", "filing_not_active", "public_record_available", "secured_party_preferences_missing" ], "title": "LienInitialFilingLookupWarning", "description": "Non-blocking flags an initial-filing lookup raises about its match." }, "LienPartyDebtorCapacity": { "type": "string", "enum": [ "ESTATE", "TRUST", "TRUSTEE", "NONE_OF_THE_ABOVE" ], "title": "LienPartyDebtorCapacity", "description": "Defines the various capacities a debtor may assume in the context of\na lien, aiding in the comprehension of their legal standing and\nobligations concerning the lien." }, "ListResponseEndpointOut": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EndpointOut" }, "type": "array", "title": "Data" }, "done": { "type": "boolean", "title": "Done" }, "iterator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Iterator", "examples": [ "iterator" ] }, "prev_iterator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prev Iterator", "examples": [ "-iterator" ] } }, "type": "object", "required": [ "data", "done" ], "title": "ListResponseEndpointOut" }, "ManualOnboardingDecision": { "type": "string", "enum": [ "APPROVED", "REJECTED" ], "title": "ManualOnboardingDecision", "description": "Customer-authored manual override for completed under-review sessions." }, "MaritalStatus": { "type": "string", "enum": [ "married", "single", "divorced", "widowed", "separated", "domestic_partner", "civil_union", "other" ], "title": "MaritalStatus" }, "MatchType": { "type": "string", "enum": [ "NO_MATCH", "SIMILAR", "EXACT" ], "title": "MatchType" }, "MonitorableAttributes": { "type": "string", "enum": [ "sos", "liens", "litigations", "bankruptcies", "website_analysis", "pep", "ofac", "identity_network" ], "title": "MonitorableAttributes", "description": "The attributes that can be monitored." }, "MoveOperation": { "properties": { "op": { "type": "string", "const": "move", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" }, "from": { "type": "string", "title": "From", "description": "JSON Pointer path to source location" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path", "from" ], "title": "MoveOperation", "description": "Move operation: moves a value from one location to another.", "examples": [ { "from": "/servers/web1", "op": "move", "path": "/archive/web1" }, { "from": "/config/old_setting", "op": "move", "path": "/config/new_setting" } ] }, "NewsSentiment": { "type": "string", "enum": [ "positive", "negative", "neutral" ], "title": "NewsSentiment" }, "NotifiableAttributes": { "type": "string", "enum": [ "registration_health", "new_registrations", "addresses", "officers", "alternative_names", "kyb_score", "risk_score", "identity_network", "pep", "ofac", "liens", "litigations", "bankruptcies", "website_analysis" ] }, "OnboardingApplicationScore": { "properties": { "grade": { "$ref": "#/components/schemas/OnboardingScoreGrade", "description": "Overall application letter grade." }, "score": { "type": "number", "maximum": 100.0, "minimum": 0.0, "title": "Score", "description": "Numeric application score (0–100): the weighted average of the component scores, or the representative F value when the rejected-identity override applies." }, "confidence": { "$ref": "#/components/schemas/OnboardingScoreConfidence", "description": "How complete the evidence behind the grade was." }, "badges": { "items": { "$ref": "#/components/schemas/OnboardingScoreBadge" }, "type": "array", "title": "Badges", "description": "Reviewer-facing qualifiers on the score card." }, "components": { "items": { "$ref": "#/components/schemas/OnboardingComponentScore" }, "type": "array", "title": "Components", "description": "The graded components the application grade composes." } }, "type": "object", "required": [ "grade", "score", "confidence" ], "title": "OnboardingApplicationScore", "description": "The application's overall grade, scored when the session completed." }, "OnboardingBusiness": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Business legal name supplied by the applicant." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "Business address supplied by the applicant." }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ein", "description": "Employer Identification Number, if supplied." }, "officer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Officer Name", "description": "Business officer name supplied on the business screen, if any." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "Business officer names asserted on an API-channel submission, kept separate from the consumer identity." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative business names, if supplied." }, "dba": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dba", "description": "Doing-business-as name supplied by the applicant; KYB consumes it as an alternative name." }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Business phone number, if supplied." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Business email, if supplied." }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "Business website, if supplied." }, "selected": { "anyOf": [ { "$ref": "#/components/schemas/SelectedBusinessFields" }, { "type": "null" } ], "description": "Business the applicant selected from autocomplete, carrying the registration reference KYB resolved against." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified." }, "operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the individual-operates-business link as of this session's evaluation." }, "operator_link_shortfalls": { "items": { "$ref": "#/components/schemas/BusinessOperatorLinkShortfall" }, "type": "array", "title": "Operator Link Shortfalls", "description": "Legs of the operator-link evidence recipe this session's evaluation failed. Empty when the evaluation earned a verified link on its own, and when the flow resolved no business to link to." }, "field_provenance": { "additionalProperties": { "$ref": "#/components/schemas/OnboardingFieldProvenance" }, "type": "object", "title": "Field Provenance", "description": "Where each attribute of this business came from: BUSINESS_AUTOCOMPLETE for fields from the registry pick, SELF_ENTERED for text the applicant typed, CUSTOMER_ASSERTED for fields submitted through the API. Keys are drawn from name, address, ein, officer_name, dba, phone_number, email and website. Empty on sessions completed before provenance was recorded." } }, "additionalProperties": false, "type": "object", "title": "OnboardingBusiness", "description": "The asserted and KYB-resolved identity of the business.\n\nEvery asserted business fact lives here (not under ``inputs``); the\nKYB-resolved references (registration selection, pairwise business ref,\noperator link) sit alongside so the business identity reads in one place." }, "OnboardingComponentScore": { "properties": { "component": { "$ref": "#/components/schemas/OnboardingScoreComponent", "description": "Which slice of the application this grades." }, "grade": { "$ref": "#/components/schemas/OnboardingScoreGrade", "description": "Letter grade for the component." }, "score": { "type": "number", "maximum": 100.0, "minimum": 0.0, "title": "Score", "description": "Numeric score (0–100) behind the grade." }, "narrative": { "type": "string", "title": "Narrative", "description": "Human-readable explanation, frozen at packet delivery with the session's specifics (e.g. the applicant's name)." }, "match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Officer match level, on the connection component only — drives the dossier's Exact Match chip." }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject", "description": "Display name of the beneficial owner this row grades — OWNER_KYC rows repeat per owner and this is their discriminator. None on every other component." } }, "type": "object", "required": [ "component", "grade", "score", "narrative" ], "title": "OnboardingComponentScore", "description": "One graded slice of the application (KYC, KYB, or the connection)." }, "OnboardingDataKey": { "type": "string", "enum": [ "CONSUMER_FIRST_NAME", "CONSUMER_MIDDLE_NAME", "CONSUMER_LAST_NAME", "CONSUMER_DOB", "CONSUMER_PHONE", "CONSUMER_EMAIL", "CONSUMER_NATIONAL_ID", "CONSUMER_ADDRESS", "BUSINESS_LEGAL_NAME", "BUSINESS_ADDRESS", "BUSINESS_EIN", "BUSINESS_OFFICER_NAME", "BUSINESS_PHONE", "BUSINESS_EMAIL", "BUSINESS_WEBSITE", "BUSINESS_DBA" ], "title": "OnboardingDataKey", "description": "Shared vocabulary between page collection and processors." }, "OnboardingDocumentReference": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Onboarding document id." }, "page_key": { "type": "string", "title": "Page Key", "description": "Template page the document was collected on." }, "element_key": { "type": "string", "title": "Element Key", "description": "FILE_UPLOAD element the document satisfies." }, "document_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Document Category", "description": "Authored document category, when set." }, "filename": { "type": "string", "title": "Filename", "description": "Original filename supplied by the applicant." }, "mime": { "type": "string", "title": "Mime", "description": "Uploaded content type." }, "size_bytes": { "type": "integer", "title": "Size Bytes", "description": "Stored object size in bytes." }, "has_thumbnail": { "type": "boolean", "title": "Has Thumbnail", "description": "Whether a first-page preview image was rendered at upload. False for formats that cannot be previewed.", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "id", "page_key", "element_key", "filename", "mime", "size_bytes" ], "title": "OnboardingDocumentReference", "description": "A document the applicant uploaded during the session." }, "OnboardingFieldProvenance": { "type": "string", "enum": [ "PREFILL", "SELF_ENTERED", "CUSTOMER_ASSERTED", "BUSINESS_AUTOCOMPLETE", "MATCHED_INPUT", "VERIFIED_POSSESSION" ], "title": "OnboardingFieldProvenance", "description": "Where one person, business or owner attribute came from.\n\nPREFILL: disclosed by the identity provider. MATCHED_INPUT: typed by the\napplicant and confirmed by the provider. SELF_ENTERED: typed by the\napplicant. CUSTOMER_ASSERTED: submitted by you through the API.\nBUSINESS_AUTOCOMPLETE: taken from the business the applicant picked.\nVERIFIED_POSSESSION: typed by the applicant and proven with a one-time\ncode sent to it." }, "OnboardingFindingCheck": { "type": "string", "enum": [ "KYC", "KYB", "CHECKS" ], "title": "OnboardingFindingCheck", "description": "Which verification check an onboarding finding pertains to.\n\n``Checks`` covers session-level findings that no single check owns\n(collect-only templates, a check missing its packet result)." }, "OnboardingFindingCode": { "type": "string", "enum": [ "IDENTITY_NOT_APPROVED", "KYC_MISSING_RESULT", "OWNER_KYC_MISSING", "KYB_MISSING_RESULT", "BUSINESS_NOT_FOUND", "BUSINESS_NOT_VERIFIED", "TIN_MISMATCH", "WEBSITE_NOT_CORROBORATED", "OFFICER_PARTIAL_MATCH", "OFFICER_NOT_MATCHED", "NO_CHECKS_CONFIGURED", "NEEDS_REVIEW", "EMAIL_UNVERIFIED", "EMAIL_SEND_FAILED" ], "title": "OnboardingFindingCode", "description": "Machine-readable code for a materialized onboarding finding.\n\nFindings are derived once at packet delivery (see\n``osiris.onboarding.findings``) and persisted on the session, so the\nreview queue can filter by them. Gating codes name the verdict conjunct\nthat held the session in review; evidence codes (website corroboration,\nofficer match) flag reviewer-facing evidence that never gates the\nautomated verdict." }, "OnboardingIndividual": { "properties": { "first_name": { "type": "string", "title": "First Name", "description": "Legal first name." }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "Legal middle name, if any." }, "last_name": { "type": "string", "title": "Last Name", "description": "Legal last name." }, "dob": { "type": "string", "title": "Dob", "description": "Date of birth (YYYY-MM-DD)." }, "phone_e164": { "type": "string", "title": "Phone E164", "description": "Confirmed mobile phone in E.164 format." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Applicant email address, when supplied." }, "address": { "anyOf": [ { "$ref": "#/components/schemas/ConfirmedAddressFields" }, { "type": "null" } ], "description": "Confirmed residential address." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it." }, "ssn_last_four": { "anyOf": [ { "type": "string", "maxLength": 4 }, { "type": "null" } ], "title": "Ssn Last Four", "description": "Last four characters of the collected national id (an SSN everywhere the product collects one — the API channel validates a nine-digit US SSN), pre-masked at packet delivery. The packet never carries the full value." }, "field_provenance": { "additionalProperties": { "$ref": "#/components/schemas/OnboardingFieldProvenance" }, "type": "object", "title": "Field Provenance", "description": "Where each attribute of this individual came from: PREFILL, MATCHED_INPUT, SELF_ENTERED, CUSTOMER_ASSERTED, or VERIFIED_POSSESSION (an email the applicant proved with a one-time code). Keys are drawn from first_name, middle_name, last_name, dob, phone_e164, email, address and ssn_last_four. Empty on sessions completed before provenance was recorded." } }, "additionalProperties": false, "type": "object", "required": [ "first_name", "last_name", "dob", "phone_e164" ], "title": "OnboardingIndividual", "description": "The confirmed identity of the individual the session verified.\n\nExtends the confirmed identity fields with the org-scoped pairwise\nreference issued when the flow anchored a principal identity (KYA)." }, "OnboardingInputs": { "properties": { "phone_e164": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone E164", "description": "Applicant phone in E.164 format." }, "custom_values": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Custom Values", "description": "Page values collected under CUSTOM: data keys, keyed by the full data key." }, "custom_value_currencies": { "additionalProperties": { "$ref": "#/components/schemas/CurrencyCode" }, "type": "object", "title": "Custom Value Currencies", "description": "Currency denominating each CURRENCY-collected entry in custom_values, keyed by the same CUSTOM: data key. Only CURRENCY elements record one; packets delivered before per-field currencies carry an empty map." }, "documents": { "items": { "$ref": "#/components/schemas/OnboardingDocumentReference" }, "type": "array", "title": "Documents", "description": "Documents the applicant attached via FILE_UPLOAD elements, limited to those referenced by the submitted page values." }, "identity_source": { "anyOf": [ { "$ref": "#/components/schemas/KYCIdentitySource" }, { "type": "null" } ], "description": "How the individual's identity was collected: PREFILL (provider disclosure behind phone + DOB + possession), SELF_ENTERED (typed by the applicant), or CUSTOMER_ASSERTED (submitted through the direct identity-submission API). Null when the flow ran no KYC evaluation." } }, "additionalProperties": true, "type": "object", "title": "OnboardingInputs", "description": "What the applicant/customer submitted during the session.\n\nRaw session-level submissions only: the asserted individual identity lives\nin the ``individual`` section once confirmed, and the asserted business\nidentity in the ``business`` section." }, "OnboardingOwner": { "properties": { "first_name": { "type": "string", "minLength": 1, "title": "First Name", "description": "Owner first name." }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "Owner middle name, if supplied." }, "last_name": { "type": "string", "minLength": 1, "title": "Last Name", "description": "Owner last name." }, "dob": { "type": "string", "title": "Dob", "description": "Owner date of birth (YYYY-MM-DD)." }, "phone_e164": { "type": "string", "title": "Phone E164", "description": "Owner phone in E.164 format." }, "ownership_percentage": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Ownership Percentage", "description": "The owner's stake in the business, in whole percent." }, "ssn_last_four": { "type": "string", "maxLength": 4, "minLength": 4, "title": "Ssn Last Four", "description": "Last four digits of the owner's Social Security number.", "examples": [ "6789" ] }, "kyc": { "anyOf": [ { "$ref": "#/components/schemas/KYCResult" }, { "type": "null" } ], "description": "The owner's KYC check result; null when the evaluation wrote no result." }, "field_provenance": { "additionalProperties": { "$ref": "#/components/schemas/OnboardingFieldProvenance" }, "type": "object", "title": "Field Provenance", "description": "Where each attribute of this beneficial owner came from; always SELF_ENTERED, since the applicant enters owners. Empty on sessions completed before provenance was recorded." } }, "additionalProperties": false, "type": "object", "required": [ "first_name", "last_name", "dob", "phone_e164", "ownership_percentage", "ssn_last_four" ], "title": "OnboardingOwner", "description": "One beneficial owner collected by the session, with their KYC result.\n\nSessions are single-actor: the applicant entered these details on the\nowner's behalf, so every owner evaluation ran on the self-entered path\n(no prefill, possession, or identity anchoring for owners)." }, "OnboardingRejectReason": { "type": "string", "enum": [ "NOT_ENOUGH_INFORMATION", "OTHER" ], "title": "OnboardingRejectReason", "description": "Why a reviewer rejected an onboarding session, beside the free-text note." }, "OnboardingResults": { "properties": { "verification_level": { "anyOf": [ { "$ref": "#/components/schemas/v1.VerificationLevel" }, { "type": "null" } ], "description": "Overall verification level (the KYA tier, serialized as its integer value: 1 = VL1, 2 = VL2, 3 = VL3), derived at packet delivery from the active keys the session's evidence earned under the trust-framework recipes — the same derivation and wire form as GET /issuance/identities/individuals/{individual_ref} and minted credentials. When the flow ran KYB, this is the business strength, provided the person reaches some strength (null otherwise); without KYB it is the person strength alone. Null also when the earned keys satisfy no strength recipe (including collect-only templates and sessions whose checks failed). Frozen at delivery; a manual decision changes the session verdict, never this value." }, "kyc": { "anyOf": [ { "$ref": "#/components/schemas/KYCResult" }, { "type": "null" } ], "description": "KYC check result; null when the flow ran no KYC check." }, "kyb": { "anyOf": [ { "$ref": "#/components/schemas/KYBResult" }, { "type": "null" } ], "description": "KYB check result; null when the flow ran no KYB check." }, "application_score": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingApplicationScore" }, { "type": "null" } ], "description": "Application-level letter grade with its component scores (KYC, KYB, KYC ⟷ KYB connection), evidence confidence, and qualifier badges. Derived at packet delivery from the check outcomes and frozen; null when nothing scorable ran (collect-only templates, checks that wrote no result)." } }, "additionalProperties": false, "type": "object", "title": "OnboardingResults", "description": "The outcome of the session's verification checks." }, "OnboardingScoreBadge": { "type": "string", "enum": [ "IDENTITY_REJECTED", "SELF_ENTERED_IDENTITY", "LOW_DATA_CONFIDENCE" ], "title": "OnboardingScoreBadge", "description": "Reviewer-facing qualifier badges on the application score card." }, "OnboardingScoreComponent": { "type": "string", "enum": [ "KYC", "KYB", "CONNECTION", "OWNER_KYC" ], "title": "OnboardingScoreComponent", "description": "Which slice of the application a component score grades.\n\n``Connection`` is the KYC ⟷ KYB link: whether the verified identity\nmatches an officer on the verified business's registration.\n``OwnerKyc`` repeats — one component row per collected beneficial\nowner, discriminated by the row's ``subject`` (the owner's name)." }, "OnboardingScoreConfidence": { "type": "string", "enum": [ "HIGH", "MEDIUM", "LOW" ], "title": "OnboardingScoreConfidence", "description": "How complete the evidence behind an application score was.\n\nGrades say what the checks concluded; confidence says how much\ncorroborating data they had to work with (identity provenance and\nevidence, TIN collection, website corroboration)." }, "OnboardingScoreGrade": { "type": "string", "enum": [ "A", "B", "C", "F" ], "title": "OnboardingScoreGrade", "description": "Letter grade for an onboarding application score.\n\nDeliberately the scoring engine's vocabulary (KYB/Risk grades are\nA/B/C/F; there is no D or E anywhere in the product), so the KYB\ncomponent score can carry the business search's rating verbatim." }, "OnboardingVerdict": { "type": "string", "enum": [ "APPROVED", "UNDER_REVIEW", "REJECTED" ], "title": "OnboardingVerdict", "description": "Normalized onboarding verdict used across provider-specific outputs." }, "OperatorLinkSortField": { "type": "string", "enum": [ "created_at", "name" ], "title": "OperatorLinkSortField", "description": "What the operator-links list sorts by." }, "OrderType": { "type": "string", "enum": [ "BusinessSearch.submitted", "BusinessSearch.exported", "PersonSearch.submitted", "LiensSearch.submitted", "LiensSearch.submitted.v2", "RegistrationEnrichment.submitted", "RegistrationEnrichment.submitted.DE", "WebsiteAnalysisRequest.submitted", "WebsiteAnalysisRequest.submitted.v2", "WebPresenceRequest.submitted", "DocketSearch.submitted", "DocketUpdateRequest.submitted", "DocketDocumentUpdateRequest.submitted", "LitigationSearch.submitted", "LitigationSearch.submitted.v2", "BankruptcySearch.submitted", "BankruptcySearch.submitted.v2", "LienFiling.submitted", "LienFiling.search_to_reflect", "NAICSPredictionRequest.submitted", "NAICSPredictionRequest.submitted.v2", "NAICSPredictionRequest.submitted.v3", "DMFSearch.submitted", "TINVerification.submitted", "AdverseMediaSearch.submitted", "EmployeeVerificationRequest.submitted", "InternationalBusinessSearch.submitted", "InternationalEnhancedProfile.submitted", "SCRASearch.submitted", "MLASearch.submitted", "OFACSearch.submitted", "PEPSearch.submitted", "PEPSearch.submitted.v2", "PEPSearch.submitted.v3", "CSLSearch.submitted", "FBISearch.submitted", "CNSSearch.submitted", "OIGSearch.submitted", "Prefill.submitted", "PrefillV2.submitted", "AutocompleteSession.submitted", "AutocompleteSession.submitted.v2", "EnhancedAddOn.submitted", "SocialMediaSearch.submitted", "ReviewSummarySearch.submitted", "ReviewFullSearch.submitted", "DirectoryListingsSearch.submitted", "InternationalOnlinePresenceSurcharge.submitted", "CriminalCheck.submitted", "PortfolioItem.monitored" ], "title": "OrderType", "description": "The OrderType enumeration represents the type of order that can be placed." }, "Orderable": { "properties": { "type": { "$ref": "#/components/schemas/OrderableType", "title": "Orderable Type", "description": "The type of optional orderable object that was requested as part of the Business Search options." }, "id": { "type": "string", "format": "uuid", "title": "Orderable Object Identifier", "description": "The unique identifier of the orderable object." }, "url": { "type": "string", "title": "Orderable Object URL", "description": "The URL to the orderable object.", "readOnly": true, "examples": [ "https://api.baselayer.com/website_analysis_requests/9083e7e2-1f6b-11ef-8f0f-1edb1b067314" ] }, "option": { "$ref": "#/components/schemas/BusinessSearchOptionsOutput", "title": "Bussiness Search Option", "description": "The business search option that requested the orderable object.", "readOnly": true } }, "type": "object", "required": [ "type", "id", "url", "option" ], "title": "Orderable" }, "OrderableType": { "type": "string", "enum": [ "WebsiteAnalysisRequest", "NAICSPredictionRequest" ], "title": "OrderableType" }, "OrganizationGrant": { "type": "string", "enum": [ "api", "exports", "nevermined" ], "title": "OrganizationGrant", "description": "Surfaces an organization-owner API key may reach (ENG-6872).\n\n``NULL`` means *ungranted* — the historical blanket behavior: the full\ncustomer API, and no SFTP. Every key minted before this column existed is\nNULL, which is what makes the column backwards compatible by construction.\n\nA non-``NULL`` set is authoritative and must be non-empty. Populated only\non rows where ``owner == Organization``; ``NULL`` elsewhere." }, "OrganizationType": { "type": "string", "enum": [ "neobank", "community_bank", "credit_union", "regional_bank", "national_bank", "fintech", "smb_lender", "merchant_cash_advanced", "processor", "infrastructure", "other" ], "title": "OrganizationType" }, "PEPPosition": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the position held.", "examples": [ "Member of the National Assembly" ] }, "country": { "anyOf": [ { "$ref": "#/components/schemas/ISO2CountryCode" }, { "type": "null" } ], "description": "ISO2 country code of the office held.", "examples": [ "FR" ] }, "subnational_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subnational Area", "description": "State, province, or region of the office held.", "examples": [ "California" ] }, "categories": { "items": { "$ref": "#/components/schemas/PEPRiskCategory" }, "type": "array", "title": "Categories", "description": "Risk categories associated with the position.", "examples": [ [ "GOVERNMENT_LEGISLATIVE", "GOVERNMENT_NATIONAL" ] ] }, "start_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date", "description": "Date the person assumed the position.", "examples": [ "2019-05-20" ] }, "end_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date", "description": "Date the person left the position.", "examples": [ "2023-01-31" ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/PEPPositionStatus" }, { "type": "null" } ], "description": "Whether the position is currently held.", "examples": [ "CURRENT" ] } }, "type": "object", "required": [ "name" ], "title": "PEPPosition", "description": "A position (occupancy) held by a politically exposed person, from the\nOpenSanctions PEP dataset. Stored on ``PEPEntity.positions`` (JSONB) and\nsurfaced verbatim in PEP search results." }, "PEPPositionStatus": { "type": "string", "enum": [ "CURRENT", "ENDED", "UNKNOWN" ], "title": "PEPPositionStatus", "description": "Whether a PEP currently holds a position, per the OpenSanctions\noccupancy `status` values (current / ended / unknown)." }, "PEPRecordType": { "type": "string", "enum": [ "PERSON", "ORGANIZATION" ], "title": "PEPRecordType", "description": "Enumeration of record types associated with Politically Exposed Persons (PEPs).\nDerived from the types used in the PEP data source." }, "PEPRiskCategory": { "type": "string", "enum": [ "GOVERNMENT_EXECUTIVE", "GOVERNMENT_FINANCIAL", "GOVERNMENT_HEAD", "INTERGOVERNMENTAL_ORGANIZATION", "GOVERNMENT_JUDICIAL", "GOVERNMENT_LEGISLATIVE", "GOVERNMENT_MUNICIPAL", "GOVERNMENT_NATIONAL", "GOVERNMENT_SECURITY", "STATE_OWNED_ENTERPRISE", "STATE_GOVERNMENT", "MILITARY", "PERSON_OF_INTEREST", "POLITICAL_PARTY", "DIPLOMAT", "JUDGE", "POLITICALLY_EXPOSED_PERSON", "RELATIVES_OR_CLOSE_ASSOCIATES", "WANTED" ], "title": "PEPRiskCategory", "description": "Enumeration of risk categories associated with Politically Exposed Persons (PEPs).\nDerived from the categories used in the PEP data source." }, "PaymentFrequency": { "type": "string", "enum": [ "DY", "WY", "BW", "MY", "QY", "AY" ], "title": "PaymentFrequency" }, "PersonSearchOptions": { "type": "string", "enum": [ "Order.Litigations", "Order.Bankruptcy", "Order.Liens", "Order.Scra", "Order.Ofac", "Order.Pep", "Order.TinMatching", "Order.Mla" ], "title": "PersonSearchOptions" }, "ProductType": { "type": "string", "enum": [ "BNK", "CC", "WC", "LOC", "EQF", "MCA", "PMT", "Other" ], "title": "ProductType" }, "ReasonCode": { "type": "string", "enum": [ "ADDRESS_FAILED_TO_NORMALIZE", "ENTITY_NOT_FOUND", "BUSINESS_NAME_NO_MATCH", "NO_ACTIVE_REGISTRATIONS", "DOMESTIC_REGISTRATION_INACTIVE", "SOLE_REGISTRATION_STATUS_UNKNOWN", "ENTITY_AGE_UNDER_7D", "ENTITY_AGE_UNDER_30D", "ENTITY_AGE_UNDER_90D", "ENTITY_AGE_UNDER_6M", "ENTITY_AGE_UNDER_12M", "TIN_MISMATCH", "TIN_IS_SSN", "ADDRESS_NO_MATCH", "ADDRESS_PARTIAL_MATCH", "SEARCH_ADDRESS_UNDELIVERABLE", "SEARCH_ADDRESS_PO_BOX", "SEARCH_ADDRESS_CMRA", "SEARCH_ADDRESS_RESIDENTIAL", "PRIMARY_ADDRESS_UNDELIVERABLE", "PRIMARY_ADDRESS_PO_BOX", "PRIMARY_ADDRESS_CMRA", "PRIMARY_ADDRESS_RESIDENTIAL", "NO_OFFICER_MATCH", "SUBMITTED_DOMAIN_UNDER_7D", "DISCOVERED_DOMAIN_UNDER_7D", "TAX_LIEN_ACTIVE", "TAX_LIEN_PAST", "UCC_LIEN_ACTIVE", "BANKRUPTCY_ACTIVE", "BANKRUPTCY_RECENT", "LITIGATION_ACTIVE", "LITIGATION_RECENT", "NETWORK_HIGH_VELOCITY", "NETWORK_HIGH_APPLICATION_COUNT", "ADDRESS_MISMATCH", "NETWORK_NO_HISTORY" ], "title": "ReasonCode", "description": "Every reason code Baselayer has ever issued.\n\nMembers are named exactly as their value so the code a customer sees is the\ncode a developer greps for. A member is never removed: rows that recorded it\nstill name it." }, "RecordCategory": { "type": "string", "enum": [ "arrest", "Criminal/traffic", "Warrant", "Sex Offender", "Patriot", "Registry", "unknown" ], "title": "RecordCategory", "description": "Categorization of a returned record.\n\nMaps closely to the source category, except PA sources can contain either\nPatriot or Registry records." }, "RemoveOperation": { "properties": { "op": { "type": "string", "const": "remove", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path" ], "title": "RemoveOperation", "description": "Remove operation: removes the value at the target location.", "examples": [ { "op": "remove", "path": "/servers/web2" }, { "op": "remove", "path": "/services/1" } ] }, "ReplaceOperation": { "properties": { "op": { "type": "string", "const": "replace", "title": "Op" }, "path": { "type": "string", "title": "Path", "description": "JSON Pointer path to the target location" }, "value": { "title": "Value", "description": "The replacement value" } }, "additionalProperties": false, "type": "object", "required": [ "op", "path", "value" ], "title": "ReplaceOperation", "description": "Replace operation: replaces the value at the target location.", "examples": [ { "op": "replace", "path": "/servers/web1/status", "value": "degraded" }, { "op": "replace", "path": "/config/timeout", "value": 60 } ] }, "RequestOrigin": { "type": "string", "enum": [ "api", "console", "mcp", "onboarding" ], "title": "RequestOrigin" }, "ResumableWorkflowState": { "type": "string", "enum": [ "PENDING", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "EXPIRED", "CANCELLED" ], "title": "ResumableWorkflowState", "description": "Lifecycle state of an asynchronous verification workflow, such as an\nidentity submission: PENDING, EXECUTING, or WAITING while in flight,\nthen a terminal COMPLETED, FAILED, EXPIRED, or CANCELLED." }, "SearchRequestSubjectType": { "type": "string", "enum": [ "Business", "Person", "BusinessSearch" ], "title": "SearchRequestSubjectType", "description": "Discriminator for bodies of POST /lien_searches and POST /docket_searches requests.\nNames a business record, a person record, or a business search" }, "SelectedBusinessFields": { "properties": { "registration_id": { "type": "string", "format": "uuid", "title": "Registration Id", "description": "Id of the picked suggestion: the business's registration in its home state." }, "name": { "type": "string", "title": "Name", "description": "Selected business legal name." }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "Address of the autocomplete suggestion." }, "states": { "items": { "type": "string" }, "type": "array", "title": "States", "description": "States the business is registered in." } }, "additionalProperties": false, "type": "object", "required": [ "registration_id", "name" ], "title": "SelectedBusinessFields", "description": "The business the applicant picked from the business name typeahead." }, "SelectiveDisclosure": { "type": "string", "enum": [ "always", "allowed", "never" ], "title": "SelectiveDisclosure", "description": "Whether the issuer makes a claim selectively disclosable (§5.6.4)." }, "SmtpSecurity": { "type": "string", "enum": [ "IMPLICIT_TLS", "STARTTLS" ], "title": "SmtpSecurity", "description": "How the connection is encrypted; there is no plaintext mode." }, "SocialSite": { "type": "string", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ] }, "SortMethod": { "type": "string", "enum": [ "asc", "desc" ], "title": "SortMethod" }, "SourceCategory": { "type": "string", "enum": [ "arrest", "court", "criminal registry", "DOC", "warrant", "sex offender registry", "domestic watchlist", "foreign watchlist", "healthcare registry", "healthcare sanctions", "financial registry", "financial sanctions", "other registry", "other sanctions", "PEP registry", "unknown" ], "title": "SourceCategory", "description": "Categorization of the source a record was retrieved from." }, "StateAbbreviation": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "VI", "AE", "AA", "AP", "GU", "AS" ], "title": "StateAbbreviation" }, "SubmissionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the submission" }, "name": { "type": "string", "title": "Name", "description": "The name of the submission file" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current processing state of the submission" }, "submitted_records": { "type": "integer", "title": "Submitted Records", "description": "Total number of records submitted" }, "valid_records": { "type": "integer", "title": "Valid Records", "description": "Number of valid records" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the submission was created" } }, "type": "object", "required": [ "id", "name", "state", "submitted_records", "valid_records", "created_at" ], "title": "SubmissionResponse" }, "TaskState": { "type": "string", "enum": [ "PENDING", "EXECUTING", "COMPLETED", "FAILED", "CANCELLED" ], "title": "TaskState" }, "TypeDisplay": { "properties": { "locale": { "type": "string", "title": "Locale", "default": "en-US" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" } }, "additionalProperties": false, "type": "object", "required": [ "name", "description" ], "title": "TypeDisplay" }, "TypeMetadata": { "properties": { "vct": { "type": "string", "title": "Vct" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "display": { "items": { "$ref": "#/components/schemas/TypeDisplay" }, "type": "array", "title": "Display" }, "claims": { "items": { "$ref": "#/components/schemas/ClaimMetadata" }, "type": "array", "title": "Claims" } }, "additionalProperties": false, "type": "object", "required": [ "vct", "name", "description", "display", "claims" ], "title": "TypeMetadata", "description": "A Type Metadata document (§5.2), served at its ``vct`` URL." }, "UpdatePortfolioGroupRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name", "description": "The name of the portfolio group." } }, "type": "object", "required": [ "name" ], "title": "UpdatePortfolioGroupRequest" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WatchlistSearchSource": { "type": "string", "enum": [ "OFAC", "PEP", "CSL", "FBI", "CNS", "OIG" ], "title": "WatchlistSearchSource", "description": "Watchlists that can be searched by name via the GET /watchlists route." }, "WebhookEvent": { "type": "string", "enum": [ "BusinessSearch.submitted", "BusinessSearch.completed", "BusinessSearch.failed", "BusinessSearch.cancelled", "BusinessSearch.updated", "SearchBatch.updated", "PersonSearch.submitted", "PersonSearch.completed", "PersonSearch.failed", "PersonSearch.updated", "DMFSearch.submitted", "DMFSearch.completed", "DMFSearch.failed", "LiensSearch.submitted", "LiensSearch.completed", "LiensSearch.failed", "LienFiling.created", "LienFiling.updated", "LienFiling.deleted", "LienFilingImportBatch.completed", "LienFilingImportBatch.failed", "DocketSearch.submitted", "DocketSearch.completed", "DocketSearch.failed", "DocketDetailsSearch.submitted", "DocketDetailsSearch.completed", "DocketDetailsSearch.failed", "DocketExhibitSearch.submitted", "DocketExhibitSearch.completed", "DocketExhibitSearch.failed", "APIKey.created", "APIKey.deleted", "OnboardingSession.completed", "OnboardingSession.failed", "OnboardingSession.updated", "Verification.completed", "Verification.failed", "Verification.updated", "Order.created", "EmailSender.failed", "NAICSPredictionRequest.submitted", "NAICSPredictionRequest.completed", "NAICSPredictionRequest.failed", "WebsiteAnalysisRequest.submitted", "WebsiteAnalysisRequest.completed", "WebsiteAnalysisRequest.failed", "WebPresenceRequest.submitted", "WebPresenceRequest.completed", "WebPresenceRequest.failed", "PortfolioItem.created", "PortfolioItem.updated", "PortfolioItem.deleted", "PortfolioGroup.created", "PortfolioGroup.updated", "PortfolioGroup.deleted", "TINVerification.submitted", "TINVerification.completed", "TINVerification.failed", "AdverseMediaSearch.submitted", "AdverseMediaSearch.completed", "AdverseMediaSearch.failed", "EmployeeVerificationRequest.submitted", "EmployeeVerificationRequest.completed", "EmployeeVerificationRequest.failed", "InternationalBusinessSearch.submitted", "InternationalBusinessSearch.completed", "InternationalBusinessSearch.failed" ], "title": "WebhookEvent", "description": "The canonical list of supported Webhook events.\n\nEvery Webhook event sent via the notifier must be registered here.\nAn exhaustive match is used against this enumeration to ensure that all\nevents are valid and have corresponding rendering logic.\n\n@see WebhookNotifier.render_payload" }, "WebhookMetadata": { "properties": { "type": { "$ref": "#/components/schemas/WebhookEvent" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/RequestOrigin" }, { "type": "null" } ] }, "notices": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Notices" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "application_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "application_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Type" } }, "type": "object", "required": [ "type" ], "title": "WebhookMetadata" }, "WebsiteAnalysisRequest": { "properties": { "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "description": "The URL of the website that was analyzed." } }, "type": "object", "required": [ "url" ], "title": "WebsiteAnalysisRequest" }, "v1.ApplicationType": { "enum": [ "sandbox", "production" ], "title": "ApplicationType", "type": "string" }, "v1.ConfidenceLevel": { "enum": [ "high", "medium", "low" ], "title": "ConfidenceLevel", "type": "string" }, "v1.RiskLevel": { "enum": [ "high", "medium", "low", "no_risk" ], "title": "RiskLevel", "type": "string" }, "v1.VerificationLevel": { "description": "Verification level the earned active keys attain, serialized as its\ninteger value. Derived from the keys, never asserted.", "enum": [ 1, 2, 3 ], "title": "VerificationLevel", "type": "integer" }, "v1.ActedBy": { "description": "Who acted on a record, as they were named when they acted: the one actor\nshape 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.ActedByKind": { "description": "Who acted on a record: a console user or an API key.", "enum": [ "USER", "API_KEY" ], "title": "ActedByKind", "type": "string" }, "v1.TaskState": { "enum": [ "PENDING", "EXECUTING", "COMPLETED", "FAILED", "CANCELLED" ], "title": "TaskState", "type": "string" }, "v1.AddressRDI": { "enum": [ "Residential", "Commercial" ], "title": "AddressRDI", "type": "string" }, "v1.StateAbbreviation": { "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "VI", "AE", "AA", "AP", "GU", "AS" ], "title": "StateAbbreviation", "type": "string" }, "v1.USPSDeliveryType": { "description": "Enum representing the different types of USPS delivery points.\nUsed to classify addresses based on how mail is delivered to them.", "enum": [ "FIRM", "GENERAL_DELIVERY", "HIGH_RISE", "POST_OFFICE", "RURAL_ROUTE", "STREET" ], "title": "USPSDeliveryType", "type": "string" }, "v1.AdverseMediaArticle": { "properties": { "title": { "description": "The title of the media article", "examples": [ "Alamo Drafthouse Cinemas Layoffs" ], "title": "Title", "type": "string" }, "snippet": { "description": "The snippet of the media article", "examples": [ "Alamo Drafthouse Cinemas lays off 40 workers at downtown Brooklyn location" ], "title": "Snippet", "type": "string" }, "url": { "description": "The URL of the media article", "examples": [ "https://www.example.com/alamo-drafthouse-cinemas-layoffs" ], "title": "Url", "type": "string" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The URI of the image associated with the media article", "title": "Image Url" }, "publish_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the media article was published", "examples": [ "2026-10-29T05:44:47.850386" ], "title": "Publish Date" }, "sentiment": { "$ref": "#/components/schemas/v1.NewsSentiment", "description": "The sentiment of the media article", "examples": [ "positive", "negative", "neutral" ] } }, "required": [ "title", "snippet", "url", "sentiment" ], "title": "AdverseMediaArticle (v1)", "type": "object" }, "v1.NewsSentiment": { "enum": [ "positive", "negative", "neutral" ], "title": "NewsSentiment", "type": "string" }, "v1.RequestOrigin": { "enum": [ "api", "console", "mcp", "onboarding" ], "title": "RequestOrigin", "type": "string" }, "v1.WebhookEvent": { "description": "The canonical list of supported Webhook events.\n\nEvery Webhook event sent via the notifier must be registered here.\nAn exhaustive match is used against this enumeration to ensure that all\nevents are valid and have corresponding rendering logic.\n\n@see WebhookNotifier.render_payload", "enum": [ "BusinessSearch.submitted", "BusinessSearch.completed", "BusinessSearch.failed", "BusinessSearch.cancelled", "BusinessSearch.updated", "SearchBatch.updated", "PersonSearch.submitted", "PersonSearch.completed", "PersonSearch.failed", "PersonSearch.updated", "DMFSearch.submitted", "DMFSearch.completed", "DMFSearch.failed", "LiensSearch.submitted", "LiensSearch.completed", "LiensSearch.failed", "LienFiling.created", "LienFiling.updated", "LienFiling.deleted", "LienFilingImportBatch.completed", "LienFilingImportBatch.failed", "DocketSearch.submitted", "DocketSearch.completed", "DocketSearch.failed", "DocketDetailsSearch.submitted", "DocketDetailsSearch.completed", "DocketDetailsSearch.failed", "DocketExhibitSearch.submitted", "DocketExhibitSearch.completed", "DocketExhibitSearch.failed", "APIKey.created", "APIKey.deleted", "OnboardingSession.completed", "OnboardingSession.failed", "OnboardingSession.updated", "Verification.completed", "Verification.failed", "Verification.updated", "Order.created", "EmailSender.failed", "NAICSPredictionRequest.submitted", "NAICSPredictionRequest.completed", "NAICSPredictionRequest.failed", "WebsiteAnalysisRequest.submitted", "WebsiteAnalysisRequest.completed", "WebsiteAnalysisRequest.failed", "WebPresenceRequest.submitted", "WebPresenceRequest.completed", "WebPresenceRequest.failed", "PortfolioItem.created", "PortfolioItem.updated", "PortfolioItem.deleted", "PortfolioGroup.created", "PortfolioGroup.updated", "PortfolioGroup.deleted", "TINVerification.submitted", "TINVerification.completed", "TINVerification.failed", "AdverseMediaSearch.submitted", "AdverseMediaSearch.completed", "AdverseMediaSearch.failed", "EmployeeVerificationRequest.submitted", "EmployeeVerificationRequest.completed", "EmployeeVerificationRequest.failed", "InternationalBusinessSearch.submitted", "InternationalBusinessSearch.completed", "InternationalBusinessSearch.failed" ], "title": "WebhookEvent", "type": "string" }, "v1.WebhookMetadata": { "properties": { "type": { "$ref": "#/components/schemas/v1.WebhookEvent" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/v1.RequestOrigin" }, { "type": "null" } ], "default": null }, "notices": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notices" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "application_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Application Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "External Id" }, "application_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Application Type" } }, "required": [ "type" ], "title": "WebhookMetadata", "type": "object" }, "v1.OrganizationProduct": { "description": "Enum class for the different products within an organization.\nThese values are associated with the `User` model and are determined\nduring the user onboarding process.", "enum": [ "savings", "credit", "working_capital", "equipment", "cash_advance", "payments", "other" ], "title": "OrganizationProduct", "type": "string" }, "v1.OrganizationTeam": { "description": "Enum class for the different departments within an organization.\nThese values are associated with the `User` model and are set during the\nuser onboarding flow.", "enum": [ "cSuite", "risk", "compliance", "engineering", "operations", "innovation", "other" ], "title": "OrganizationTeam", "type": "string" }, "v1.OrganizationType": { "enum": [ "neobank", "community_bank", "credit_union", "regional_bank", "national_bank", "fintech", "smb_lender", "merchant_cash_advanced", "processor", "infrastructure", "other" ], "title": "OrganizationType", "type": "string" }, "v1.AuditRevocationReason": { "description": "Why a credential was revoked.\n\nThe reason is the part of a revocation record a dispute actually reads, so\nthe vocabulary has to distinguish the paths that reach it.", "enum": [ "agent_key_compromise", "identity_superseded", "identity_withdrawn", "operator_link_revoked", "fraud_suspected", "administrative_action" ], "title": "AuditRevocationReason", "type": "string" }, "v1.BusinessOperatorLinkStatus": { "description": "Your organization's status for the link between an individual and a\nbusiness they operate.\n\nVERIFIED is earned by the full evidence recipe (TIN provided +\nIRS-matched + KYB-verified) on one of your own sessions, or decided by\nyour organization; UNDER_REVIEW is every automatic shortfall; REJECTED\nis your organization's refusal, which stands until you decide again.\nAnother organization's evidence or decision never changes it.", "enum": [ "VERIFIED", "UNDER_REVIEW", "REJECTED" ], "title": "BusinessOperatorLinkStatus", "type": "string" }, "v1.CredentialMintLevel": { "description": "The credential layer a subject mint request selects (KYA).\n\nDeliberately narrower than ``IssuedCredentialType``: the individual\nand business mint routes issue only the two subject layers.\nCounterparty credentials have their own route and request shape, so\na ``level`` of COUNTERPARTY must stay an edge-level payload refusal\n— this enum is what keeps issuance-record vocabulary growth from\nwidening the mint requests.", "enum": [ "L2", "L3" ], "title": "CredentialMintLevel", "type": "string" }, "v1.CredentialRevocationReadEvent": { "additionalProperties": false, "description": "One credential revoked by ``jti``, as the audit log recorded it.", "properties": { "schema_version": { "default": 1, "minimum": 1, "title": "Schema Version", "type": "integer" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "event_type": { "const": "credential_revocation", "title": "Event Type", "type": "string" }, "jti": { "maxLength": 255, "minLength": 1, "title": "Jti", "type": "string" }, "business_ref": { "anyOf": [ { "maxLength": 128, "minLength": 4, "type": "string" }, { "type": "null" } ], "default": null, "title": "Business Ref" }, "audience": { "anyOf": [ { "maxLength": 253, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Audience" }, "reason": { "$ref": "#/components/schemas/v1.AuditRevocationReason" }, "effective_at": { "format": "date-time", "title": "Effective At", "type": "string" }, "revoked_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who revoked the credential; null when it was not recorded." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Individual Ref" } }, "required": [ "occurred_at", "jti", "reason", "effective_at", "individual_ref", "event_type" ], "title": "CredentialRevocationReadEvent", "type": "object" }, "v1.DisclosureMode": { "description": "Per-mint selective-disclosure mode for L3 credentials.\n\nCLEARTEXT_AND_HASH (the default) discloses requested fields as\ncleartext alongside their recognition hashes; HASH_ONLY discloses only\nthe recognition hashes, giving counterparties recognition without\nplaintext.\n\nLives here rather than beside the L3 payload shapes because it is a\nstored column vocabulary as of ENG-7140\n(``issued_credentials.disclosure_mode``), and ``models.py`` cannot\nimport ``osiris.identity.l3_payloads`` (circular through\n``active_keys``).", "enum": [ "CLEARTEXT_AND_HASH", "HASH_ONLY" ], "title": "DisclosureMode", "type": "string" }, "v1.IdentityRegistrationReadEvent": { "additionalProperties": false, "description": "An identity verification yielding an ``individual_ref``, as the audit\nlog recorded it.", "properties": { "schema_version": { "default": 1, "minimum": 1, "title": "Schema Version", "type": "integer" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "event_type": { "const": "identity_registration", "title": "Event Type", "type": "string" }, "business_ref": { "anyOf": [ { "maxLength": 128, "minLength": 4, "type": "string" }, { "type": "null" } ], "default": null, "title": "Business Ref" }, "submission_id": { "maxLength": 255, "minLength": 1, "title": "Submission Id", "type": "string" }, "verdict": { "$ref": "#/components/schemas/v1.OnboardingVerdict" }, "active_keys": { "default": [], "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "verification_level": { "anyOf": [ { "maximum": 4, "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Verification Level" }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOperatorLinkStatus" }, { "type": "null" } ], "default": null }, "individual_ref": { "readOnly": true, "title": "Individual Ref", "type": "string" } }, "required": [ "occurred_at", "submission_id", "verdict", "individual_ref", "event_type" ], "title": "IdentityRegistrationReadEvent", "type": "object" }, "v1.IssuanceReadEvent": { "additionalProperties": false, "description": "A credential mint, as the audit log recorded it.", "properties": { "schema_version": { "default": 3, "minimum": 1, "title": "Schema Version", "type": "integer" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "linked_jti": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Linked Jti" }, "event_type": { "const": "issuance", "title": "Event Type", "type": "string" }, "jti": { "maxLength": 255, "minLength": 1, "title": "Jti", "type": "string" }, "business_ref": { "anyOf": [ { "maxLength": 128, "minLength": 4, "type": "string" }, { "type": "null" } ], "default": null, "title": "Business Ref" }, "audience": { "maxLength": 253, "minLength": 1, "title": "Audience", "type": "string" }, "issued_at": { "format": "date-time", "title": "Issued At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "disclosed_fields": { "default": [], "items": { "maxLength": 128, "pattern": "^[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*$", "type": "string" }, "maxItems": 256, "title": "Disclosed Fields", "type": "array" }, "disclosure_mode": { "anyOf": [ { "$ref": "#/components/schemas/v1.DisclosureMode" }, { "type": "null" } ], "default": null }, "preset": { "anyOf": [ { "maxLength": 32, "pattern": "^[a-z][a-z0-9_]*$", "type": "string" }, { "type": "null" } ], "default": null, "title": "Preset" }, "active_keys": { "default": [], "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "signing_kid": { "maxLength": 255, "minLength": 1, "title": "Signing Kid", "type": "string" }, "agent_key_thumbprint": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "title": "Agent Key Thumbprint" }, "source_environment": { "anyOf": [ { "$ref": "#/components/schemas/v1.ApplicationType" }, { "type": "null" } ], "default": null }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Individual Ref" }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "readOnly": true } }, "required": [ "occurred_at", "jti", "audience", "issued_at", "expires_at", "signing_kid", "individual_ref", "level", "event_type" ], "title": "IssuanceReadEvent", "type": "object" }, "v1.OnboardingVerdict": { "description": "Normalized onboarding verdict used across provider-specific outputs.", "enum": [ "APPROVED", "UNDER_REVIEW", "REJECTED" ], "title": "OnboardingVerdict", "type": "string" }, "v1.AutocompleteFilterRule": { "additionalProperties": false, "description": "What one route holds its narrowing filters to.", "properties": { "min_stem": { "description": "Characters the query needs, counted as ``count`` says, before any filter in ``gated`` narrows the suggestions.", "examples": [ 5 ], "title": "Min Stem", "type": "integer" }, "count": { "description": "How the query's characters are counted: ``stem`` (letters and digits, a symbol such as ``&`` counting as the word it stands for) or ``person_name`` (the spelling the people index uses, ASCII letters only). Another value may follow; one a client does not know is no reason to stop it counting its own way.", "examples": [ "stem" ], "title": "Count", "type": "string" }, "gated": { "description": "The request parameters that wait for ``min_stem``: a request carrying one of them with a shorter query is a 422 naming ``q``, unless ``short_allowed_with`` applies.", "examples": [ [ "person.name", "state" ] ], "items": { "type": "string" }, "title": "Gated", "type": "array" }, "short_allowed_with": { "description": "The parameters that let a non-empty query shorter than ``min_stem`` through. A necessary condition, not a promise: a request that carries one still runs only if the search can answer it, and may be refused.", "examples": [ [ "business.name" ] ], "items": { "type": "string" }, "title": "Short Allowed With", "type": "array" } }, "required": [ "min_stem", "count", "gated", "short_allowed_with" ], "title": "AutocompleteFilterRule", "type": "object" }, "v1.AutocompleteRelation": { "description": "A kind of row a suggestion relates to: the key of ``related.``.", "enum": [ "businesses", "people", "addresses" ], "title": "AutocompleteRelation", "type": "string" }, "v1.AutocompleteRoute": { "description": "A route of the autocomplete service a session may query: the path segment\nafter ``/autocomplete/``. A session's scope names the routes it reaches and,\nper route, the relations a request may include or filter by.", "enum": [ "businesses", "people", "addresses" ], "title": "AutocompleteRoute", "type": "string" }, "v1.AutocompleteSessionScope": { "additionalProperties": false, "description": "What a session may search: the routes it may query and, per route, the\nrelations a request may include or filter by, and the most rows a request\nmay ask for.", "properties": { "routes": { "additionalProperties": { "items": { "$ref": "#/components/schemas/v1.AutocompleteRelation" }, "type": "array" }, "description": "Each route the session may query, and the relations a request on it may include or filter by. Any other route answers 403, and so does a relation outside the list.", "examples": [ { "businesses": [ "addresses", "people" ] } ], "propertyNames": { "$ref": "#/components/schemas/v1.AutocompleteRoute" }, "title": "Routes", "type": "object" }, "max_limit": { "description": "The most suggestions a request may ask for; a larger ``limit`` answers 422.", "examples": [ 20 ], "maximum": 20, "minimum": 1, "title": "Max Limit", "type": "integer" } }, "required": [ "routes", "max_limit" ], "title": "AutocompleteSessionScope", "type": "object" }, "v1.AddressSummaryResponse": { "description": "Response model for address summary data.\n\nThis model defines the structure for address summary API responses.", "properties": { "id": { "description": "Unique identifier for the address.", "format": "uuid", "title": "Id", "type": "string" }, "street": { "description": "Street name of the address.", "examples": [ "913 Hendrix Gardens Suite 492" ], "title": "Street", "type": "string" }, "city": { "description": "City name of the address.", "examples": [ "Jasonfurt" ], "title": "City", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "State 2 letter abbreviation of the address.", "examples": [ "VA" ] }, "zip": { "description": "Zip code of the address.", "examples": [ "19773" ], "title": "Zip", "type": "string" }, "latitude": { "description": "Latitude of the address.", "examples": [ 38.03012 ], "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude of the address.", "examples": [ 78.47665 ], "title": "Longitude", "type": "number" }, "rdi": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressRDI" }, { "type": "null" } ], "default": null, "description": "Residential Delivery Indicator of the address.", "examples": [ "Commercial" ] }, "deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is deliverable.", "examples": [ false ], "title": "Deliverable" }, "cmra": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is a Commercial Mail Receiving Agency (CMRA).", "examples": [ false ], "title": "Cmra" }, "url": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The URL to the address details.", "title": "Url" }, "delivery_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.USPSDeliveryType" }, { "type": "null" } ], "default": null, "description": "The USPS delivery type.", "examples": [ "STREET", "FIRM" ] } }, "required": [ "id", "street", "city", "state", "zip", "latitude", "longitude" ], "title": "AddressSummaryResponse (v1)", "type": "object" }, "v1.AddressSummaryResponseWithSources": { "properties": { "id": { "description": "Unique identifier for the address.", "format": "uuid", "title": "Id", "type": "string" }, "street": { "description": "Street name of the address.", "examples": [ "913 Hendrix Gardens Suite 492" ], "title": "Street", "type": "string" }, "city": { "description": "City name of the address.", "examples": [ "Jasonfurt" ], "title": "City", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "State 2 letter abbreviation of the address.", "examples": [ "VA" ] }, "zip": { "description": "Zip code of the address.", "examples": [ "19773" ], "title": "Zip", "type": "string" }, "latitude": { "description": "Latitude of the address.", "examples": [ 38.03012 ], "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude of the address.", "examples": [ 78.47665 ], "title": "Longitude", "type": "number" }, "rdi": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressRDI" }, { "type": "null" } ], "default": null, "description": "Residential Delivery Indicator of the address.", "examples": [ "Commercial" ] }, "deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is deliverable.", "examples": [ false ], "title": "Deliverable" }, "cmra": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is a Commercial Mail Receiving Agency (CMRA).", "examples": [ false ], "title": "Cmra" }, "url": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The URL to the address details.", "title": "Url" }, "delivery_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.USPSDeliveryType" }, { "type": "null" } ], "default": null, "description": "The USPS delivery type.", "examples": [ "STREET", "FIRM" ] }, "sources": { "description": "The sources of the address.", "examples": [ [ "SOS", "Online" ] ], "items": { "$ref": "#/components/schemas/v1.EntitySource" }, "title": "Sources", "type": "array", "uniqueItems": true } }, "required": [ "id", "street", "city", "state", "zip", "latitude", "longitude" ], "title": "AddressSummaryResponseWithSources (v1)", "type": "object" }, "v1.BusinessOfficerResponse": { "description": "Response model for business officer data.", "properties": { "name": { "description": "The name of the officer.", "examples": [ "Philip Mcguire" ], "title": "Name", "type": "string" }, "titles": { "default": [], "description": "The titles associated with the officer.", "examples": [ [ "CEO", "Founder" ] ], "items": { "type": "string" }, "title": "Titles", "type": "array" }, "states": { "default": [], "description": "The states where the officer is registered.", "examples": [ [ "CA", "NY" ] ], "items": { "$ref": "#/components/schemas/v1.StateAbbreviation" }, "title": "States", "type": "array" }, "sources": { "description": "The sources of the officer.", "examples": [ [ "SOS", "Online" ] ], "items": { "$ref": "#/components/schemas/v1.EntitySource" }, "title": "Sources", "type": "array", "uniqueItems": true } }, "required": [ "name" ], "title": "BusinessOfficerResponse (v1)", "type": "object" }, "v1.BusinessStructure": { "enum": [ "SOLE_PROPRIETORSHIP", "GENERAL_PARTNERSHIP", "LLC", "LLP", "LLLP", "LP", "C_CORPORATION", "S_CORPORATION", "B_CORPORATION", "NONPROFIT", "COOPERATIVE", "TRUST", "PROFESSIONAL_ASSOCIATION", "PROFESSIONAL_CORPORATION", "TRADE_NAME", "BANK", "CREDIT_UNION", "INSURANCE", "OTHER" ], "title": "BusinessStructure", "type": "string" }, "v1.CorporateRegistrationAgentResponse": { "description": "Response model for corporate registration agent data.", "properties": { "name": { "description": "The name of the registered agent.", "examples": [ "Jeremy Crawford" ], "title": "Name", "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "default": null, "description": "The AddressSummaryResponse of the address associated with the registered agent", "examples": [ { "city": "Andrewton", "cmra": false, "deliverable": false, "delivery_type": null, "id": "db57f276-7234-425d-9427-5b46e2068b9b", "latitude": 34.0522, "longitude": -118.2437, "rdi": null, "state": "CA", "street": "3032 Mark Parks Andrewton, CA 27458", "url": null, "zip": "27458" } ] } }, "required": [ "name" ], "title": "CorporateRegistrationAgentResponse (v1)", "type": "object" }, "v1.CorporateRegistrationDomesticStatus": { "description": "Status of the corporate registration filing.", "enum": [ "foreign", "domestic", "unknown" ], "title": "CorporateRegistrationDomesticStatus", "type": "string" }, "v1.CorporateRegistrationStatus": { "description": "Status field indicating whether the corporate registration filing is\nactive or inactive.", "enum": [ "active", "inactive", "unknown" ], "title": "CorporateRegistrationStatus", "type": "string" }, "v1.DirectoryListingPerson": { "description": "An officer, principal, or key person listed on a directory page.", "properties": { "name": { "title": "Name", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "required": [ "name" ], "title": "DirectoryListingPerson", "type": "object" }, "v1.DirectoryListingResponse": { "description": "A business listing discovered on a directory/aggregator site (BBB, Yelp, etc.).\n\nThis is the public schema representation of directory listing data.\nShadowed from the internal transient model to keep the OpenAPI spec\nstable and decoupled from internal IPC models.", "properties": { "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Directory domain where the listing was found.", "examples": [ "bbb.org", "yelp.com", "yellowpages.com" ], "title": "Source" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the directory page that was scraped.", "examples": [ "https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234" ], "title": "Url" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business category assigned by the directory site.", "examples": [ "Plumbing Contractor", "Italian Restaurant", "Moving Company" ], "title": "Category" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business name as listed on the directory (may be a DBA).", "examples": [ "Joe's Plumbing & Heating" ], "title": "Business Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number from the directory listing.", "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address from the directory listing.", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Website URL listed on the directory page for the business.", "title": "Business Website" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Physical address from the directory listing.", "title": "Address" }, "people": { "description": "Officers, principals, or key people listed on the directory page.", "items": { "$ref": "#/components/schemas/v1.DirectoryListingPerson" }, "title": "People", "type": "array" } }, "title": "DirectoryListingResponse (v1)", "type": "object" }, "v1.DiscoveredFacebookMetadata": { "description": "Facebook-specific metadata extracted from a verified business profile.", "properties": { "is_business_page": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a Facebook business page vs personal profile", "title": "Is Business Page" }, "has_reviews": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Facebook page has customer reviews", "title": "Has Reviews" }, "check_ins_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of check-ins at this business location", "title": "Check Ins Count" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "title": "Followers Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Facebook bio/description content", "title": "Bio" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "title": "Phone Number" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "title": "Address" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "title": "Business Website" } }, "title": "DiscoveredFacebookMetadata", "type": "object" }, "v1.DiscoveredInstagramMetadata": { "description": "Instagram-specific metadata extracted from a verified business profile.", "properties": { "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Instagram account is private", "examples": [ false, true ], "title": "Is Private" }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is an Instagram business account", "examples": [ true, false ], "title": "Is Business Account" }, "has_business_address": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the business address is displayed on the Instagram profile", "examples": [ true, false ], "title": "Has Business Address" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Instagram bio/description content", "examples": [ "Professional roofing services since 2010 🏠" ], "title": "Bio" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1250, 5000 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredInstagramMetadata", "type": "object" }, "v1.DiscoveredLinkedInMetadata": { "description": "LinkedIn-specific metadata extracted from a verified business profile.", "properties": { "company_size_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company size range as displayed on LinkedIn (e.g., '11-50 employees')", "examples": [ "11-50 employees", "51-200 employees" ], "title": "Company Size Range" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry classification from LinkedIn", "examples": [ "Construction", "Financial Services" ], "title": "Industry" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 250, 1500 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "LinkedIn bio/description content", "title": "Bio" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "info@business.com" ], "title": "Email" }, "number_of_employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees (LinkedIn only)", "examples": [ 25, 150 ], "title": "Number Of Employees" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredLinkedInMetadata", "type": "object" }, "v1.DiscoveredPinterestMetadata": { "description": "Pinterest-specific metadata extracted from a verified business profile.", "properties": { "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "title": "Follower Count" }, "monthly_views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Monthly views count if displayed", "title": "Monthly Views" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinterest profile bio/description content", "title": "Bio" }, "has_business_website": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether a business website link is provided", "title": "Has Business Website" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "title": "Business Website" } }, "title": "DiscoveredPinterestMetadata", "type": "object" }, "v1.DiscoveredReview": { "properties": { "source": { "anyOf": [ { "$ref": "#/components/schemas/v1.ReviewSource" }, { "type": "null" } ], "default": null, "description": "The source of the review.", "examples": [ "yelp" ] }, "url": { "description": "The URL of the review.", "examples": [ "https://www.yelp.com/biz/certified-power-inc-mundelein" ], "title": "Url", "type": "string" }, "confidence": { "anyOf": [ { "$ref": "#/components/schemas/v1.ConfidenceLevel" }, { "type": "null" } ], "default": "high", "description": "The confidence level that this review is for the business.", "examples": [ "high" ] }, "rating": { "anyOf": [ { "maximum": 5.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "description": "The numeric rating of the review (e.g., 4.5 out of 5).", "examples": [ 4.5 ], "title": "Rating" }, "volume": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of reviews.", "examples": [ 23 ], "title": "Volume" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Overall summary of the reviews and general sentiment towards the business.", "examples": [ "5 reviews mention that the service was great and the owner was very helpful." ], "title": "Summary" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website if found in profile", "examples": [ "https://www.example.com" ], "title": "Business Website" }, "reviews": { "description": "Individual reviews for this business.", "items": { "$ref": "#/components/schemas/v1.ReviewDetail" }, "title": "Reviews", "type": "array" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/v1.GoogleReviewMetadata" }, { "type": "null" } ], "default": null, "description": "Platform-specific metadata for the review. Currently only populated for Google reviews." } }, "required": [ "url" ], "title": "DiscoveredReview", "type": "object" }, "v1.DiscoveredSocialProfile": { "properties": { "site": { "description": "The type of social profile.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "username": { "description": "The username of the social profile.", "examples": [ "certifiedpowerinc" ], "title": "Username", "type": "string" }, "confidence": { "anyOf": [ { "$ref": "#/components/schemas/v1.ConfidenceLevel" }, { "type": "null" } ], "default": null, "description": "The confidence level of the social profile.", "examples": [ "high" ] }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/v1.DiscoveredInstagramMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredLinkedInMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredFacebookMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredXMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredYouTubeMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredTikTokMetadata" }, { "$ref": "#/components/schemas/v1.DiscoveredPinterestMetadata" }, { "type": "null" } ], "default": null, "description": "The metadata of the social profile. Based on the site of the social profile.", "title": "Metadata" }, "found_on": { "description": "Location(s) where this social profile was found: InputWebsite (user-provided website), FoundWebsite (discovered website)", "examples": [ [ "FOUND_WEBSITE" ], [ "FOUND_WEBSITE", "INPUT_WEBSITE" ] ], "items": { "enum": [ "INPUT_WEBSITE", "FOUND_WEBSITE" ], "type": "string" }, "title": "Found On", "type": "array", "uniqueItems": true }, "url": { "description": "The URL of the social profile.", "examples": [ "https://www.instagram.com/certifiedpowerinc" ], "readOnly": true, "title": "Url", "type": "string" } }, "required": [ "site", "username", "url" ], "title": "DiscoveredSocialProfile", "type": "object" }, "v1.DiscoveredTikTokMetadata": { "description": "TikTok-specific metadata extracted from a verified business profile.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the TikTok account is verified", "examples": [ true, false ], "title": "Is Verified" }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a TikTok business account", "examples": [ true, false ], "title": "Is Business Account" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 5000, 25000 ], "title": "Follower Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok bio/description content", "examples": [ "Your trusted local contractor 🔨 Follow for tips!" ], "title": "Bio" }, "has_business_website": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether a business website link is provided", "examples": [ true, false ], "title": "Has Business Website" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredTikTokMetadata", "type": "object" }, "v1.DiscoveredXMetadata": { "description": "Twitter/X-specific metadata extracted from a verified business profile.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Twitter/X account is verified", "examples": [ true, false ], "title": "Is Verified" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1500, 10000 ], "title": "Follower Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Twitter/X bio/description content", "examples": [ "Leading provider of construction services in the NYC area" ], "title": "Bio" }, "joined_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the account joined Twitter/X (e.g., 'Joined February 2010')", "examples": [ "Joined February 2010", "Joined March 2015" ], "title": "Joined Date" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredXMetadata", "type": "object" }, "v1.DiscoveredYouTubeMetadata": { "description": "YouTube-specific metadata extracted from a verified business channel.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the YouTube channel is verified", "examples": [ true, false ], "title": "Is Verified" }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of subscribers if displayed", "examples": [ 1200, 15000 ], "title": "Subscriber Count" }, "channel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of channel (e.g., 'Business', 'Brand', 'Personal')", "examples": [ "Business", "Brand", "Personal" ], "title": "Channel Type" }, "has_business_email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether business contact email is provided", "examples": [ true, false ], "title": "Has Business Email" }, "channel_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel about/description content", "examples": [ "Weekly tutorials on home improvement and DIY projects" ], "title": "Channel Description" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1200, 15000 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "business@example.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredYouTubeMetadata", "type": "object" }, "v1.EntitySource": { "enum": [ "SOS", "Online" ], "title": "EntitySource", "type": "string" }, "v1.GoogleReviewMetadata": { "description": "Google Maps-specific metadata for a discovered review.", "properties": { "open_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current open/closed state from Google Maps.", "examples": [ "Open", "Closed", "Temporarily closed" ], "title": "Open State" }, "operating_hours": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Operating hours data from Google Maps.", "title": "Operating Hours" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business description from Google Maps.", "title": "Description" }, "types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Business type tags from Google Maps.", "examples": [ [ "Restaurant", "Italian restaurant" ] ], "title": "Types" }, "service_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Service options from Google Maps (e.g., dine-in, takeout).", "title": "Service Options" } }, "title": "GoogleReviewMetadata", "type": "object" }, "v1.MCC": { "description": "Represents a Merchant Category Code (MCC).", "properties": { "code": { "description": "The 4-digit MCC.", "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the MCC.", "title": "Description" }, "mastercard_risk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates if there is a risk associated with Mastercard transactions.", "title": "Mastercard Risk" }, "visa_risk_tier": { "anyOf": [ { "$ref": "#/components/schemas/v1.VisaRiskTier" }, { "type": "null" } ], "default": null, "description": "The Visa risk tier associated with this MCC." } }, "required": [ "code" ], "title": "MCC", "type": "object" }, "v1.PredictedNaicsResponse": { "properties": { "code": { "description": "The predicted NAICS code for the business.", "examples": [ "336111" ], "title": "Code", "type": "string" }, "title": { "description": "The title of the predicted NAICS code.", "examples": [ "Automobile Manufacturing" ], "title": "Title", "type": "string" }, "accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "The accuracy of the NAICS code prediction.", "examples": [ 1.0, 0.4 ], "title": "Accuracy" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Any keywords associated with the NAICS code to indicate area of business activity.", "examples": [ [ "Automobiles", "Manufacturing", "Cars", "Trucks" ] ], "title": "Keywords" }, "mcc_codes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.MCC" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of MCC codes associated with the NAICS code.", "title": "Mcc Codes" }, "sic_codes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.SICCode" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of SIC codes associated with the NAICS code.", "title": "Sic Codes" }, "risk_level": { "anyOf": [ { "$ref": "#/components/schemas/v1.RiskLevel" }, { "type": "null" } ], "default": null, "description": "The risk level associated with the NAICS code.", "examples": [ "low", "medium", "high" ] }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explanation of why this specific NAICS code was chosen for the business.", "examples": [ "Based on homepage content mentioning automobile manufacturing and assembly processes.", "Reviews and social profiles consistently reference restaurant and food service operations." ], "title": "Reasoning" } }, "required": [ "code", "title" ], "title": "PredictedNaicsResponse (v1)", "type": "object" }, "v1.RegistrationOfficerResponse": { "description": "Response model for registration officer data.", "properties": { "name": { "description": "The name of the officer.", "examples": [ "Tyler Johnson" ], "title": "Name", "type": "string" }, "titles": { "default": [], "description": "The titles associated with the officer.", "examples": [ [ "CEO", "Founder" ] ], "items": { "type": "string" }, "title": "Titles", "type": "array" } }, "required": [ "name" ], "title": "RegistrationOfficerResponse (v1)", "type": "object" }, "v1.RegistrationResponse": { "description": "Response model for corporate registration data.", "properties": { "id": { "description": "The unique identifier of the corporate registration.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name on the registration.", "examples": [ "Garcia, Hernandez and Woods" ], "title": "Name", "type": "string" }, "issue_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the registration was issued.", "examples": [ "2024-01-01" ], "title": "Issue Date" }, "inactive_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date the registration became inactive.", "examples": [ "2024-06-01" ], "title": "Inactive Date" }, "dissolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the registration was dissolved in the given state.", "examples": [ "2024-06-01" ], "title": "Dissolution Date" }, "last_annual_report_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of the registration's latest annual report. Where the state publishes the filing date it is that date; where the state publishes only a due date or the period a report covers, it is our best estimate of when the report was filed. Null when the state publishes neither, or the registration has filed none.", "examples": [ "2026-04-15" ], "title": "Last Annual Report Date" }, "file_number": { "description": "The file number of the registration.", "examples": [ "867124" ], "title": "File Number", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state in which the registration was filed.", "examples": [ "AZ" ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "default": null, "description": "The address associated with the registration." }, "registration_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.CorporateRegistrationDomesticStatus" }, { "type": "null" } ], "default": null, "description": "Whether the registration is domestic or foreign.", "examples": [ "domestic", "foreign", "unknown" ] }, "status": { "$ref": "#/components/schemas/v1.CorporateRegistrationStatus", "description": "Status field indicating whether the corporate registration filing is active or inactive.", "examples": [ "active", "inactive", "unknown" ] }, "standing": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The standing of the registration.", "examples": [ "In Good Standing", "Inactive", "Dissolved" ], "title": "Standing" }, "registered_agent": { "anyOf": [ { "$ref": "#/components/schemas/v1.CorporateRegistrationAgentResponse" }, { "type": "null" } ], "default": null, "description": "The Registered Agent listed on the Registration." }, "officers": { "default": [], "description": "The officers listed on the registration.", "items": { "$ref": "#/components/schemas/v1.RegistrationOfficerResponse" }, "title": "Officers", "type": "array" }, "metadata": { "default": [], "description": "Registration metadata from state agencies beyond the Secretary of State (e.g. the Texas Comptroller's franchise-tax standing). Empty when no agency record is linked to this registration.", "items": { "$ref": "#/components/schemas/v1.TexasComptrollerMetadataResponse" }, "title": "Metadata", "type": "array" } }, "required": [ "id", "name", "file_number", "state", "status" ], "title": "RegistrationResponse (v1)", "type": "object" }, "v1.ReviewDetail": { "properties": { "username": { "description": "The username of the reviewer.", "examples": [ "John Doe" ], "title": "Username", "type": "string" }, "text": { "description": "The text of the review.", "examples": [ "This is a great review!" ], "title": "Text", "type": "string" }, "date": { "description": "The date of the review.", "examples": [ "2024-01-01" ], "format": "date", "title": "Date", "type": "string" }, "rating": { "description": "The rating of the review.", "examples": [ 5 ], "title": "Rating", "type": "integer" } }, "required": [ "username", "text", "date", "rating" ], "title": "ReviewDetail", "type": "object" }, "v1.ReviewSource": { "enum": [ "yelp", "google", "trustpilot", "tripadvisor", "other" ], "title": "ReviewSource", "type": "string" }, "v1.SICCode": { "description": "Represents a Standard Industrial Classification (SIC) code.", "properties": { "code": { "description": "The 4-digit SIC code.", "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the SIC code.", "title": "Description" } }, "required": [ "code" ], "title": "SICCode", "type": "object" }, "v1.SecRegistrationResponse": { "description": "SEC EDGAR details for a single SEC registration linked to this business.", "properties": { "cik": { "description": "SEC Central Index Key assigned to the registrant.", "examples": [ "320193" ], "title": "Cik", "type": "string" }, "tickers": { "description": "All stock ticker symbols for this registrant.", "examples": [ [ "NTDOY" ], [ "NTDOF" ] ], "items": { "type": "string" }, "title": "Tickers", "type": "array", "uniqueItems": true }, "exchanges": { "description": "All exchanges this registrant's securities are listed on.", "examples": [ [ "OTC" ] ], "items": { "type": "string" }, "title": "Exchanges", "type": "array", "uniqueItems": true }, "sec_edgar_url": { "description": "Direct link to this registrant's SEC EDGAR page.", "format": "uri", "maxLength": 2083, "minLength": 1, "readOnly": true, "title": "Sec Edgar Url", "type": "string" } }, "required": [ "cik", "tickers", "exchanges", "sec_edgar_url" ], "title": "SecRegistrationResponse", "type": "object" }, "v1.TexasComptrollerMetadataResponse": { "description": "Franchise-tax standing at the Texas Comptroller for a TX registration.\n\nLeads SOS status by months, so it's kept as its own field on the wire\nrather than folded into ``status`` — but the KYB scoring engine does\nblend it into sos_status, at even weight (see ``scoring_engine.py``).", "properties": { "source": { "const": "texas_comptroller", "description": "The agency this registration metadata came from.", "title": "Source", "type": "string" }, "status": { "$ref": "#/components/schemas/v1.CorporateRegistrationStatus", "description": "Whether the registration is in franchise-tax standing at the Texas Comptroller. Independent of the Secretary of State status; the two disagreeing is the signal.", "examples": [ "active", "inactive" ] }, "status_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable franchise-tax standing.", "examples": [ "Franchise Tax Forfeited", "Active" ], "title": "Status Description" }, "taxpayer_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The registration's Texas taxpayer number.", "examples": [ "32081737150" ], "title": "Taxpayer Number" } }, "required": [ "source", "status" ], "title": "TexasComptrollerMetadataResponse (v1)", "type": "object" }, "v1.VisaRiskTier": { "enum": [ 1, 2, 3 ], "title": "VisaRiskTier", "type": "integer" }, "v1.WatchlistDataSource": { "enum": [ "Death Master File", "Department of Treasury, Office of Foreign Assets Control", "Politically Exposed Persons", "IRS Exempt Organizations List", "FBI Wanted List", "Department of Commerce, Consolidated Screening List", "Consolidated Canadian Autonomous Sanctions List", "HHS OIG List of Excluded Individuals/Entities", "Baselayer Fraud Consortium" ], "title": "WatchlistDataSource", "type": "string" }, "v1.WatchlistHitResponse": { "properties": { "code": { "description": "The code of the watchlist data source.", "examples": [ "DMF" ], "title": "Code" }, "name": { "$ref": "#/components/schemas/v1.WatchlistDataSource", "description": "The name of the watchlist data source.", "examples": [ "Death Master File" ] }, "count": { "description": "The number of hits found in the watchlist data source.", "examples": [ 1, 0, 5 ], "title": "Count", "type": "integer" }, "details": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "The details of the watchlist hits.", "examples": [ [ { "address": "123 Main St", "date_of_birth": "1980-01-01", "name": "John Doe" } ] ], "title": "Details" } }, "required": [ "code", "name", "count" ], "title": "WatchlistHitResponse (v1)", "type": "object" }, "v1.AddressMatchType": { "enum": [ "NO_MATCH", "CITY", "STATE", "SIMILAR", "EXACT" ], "title": "AddressMatchType", "type": "string" }, "v1.BusinessResponse": { "description": "Response model for business data.\n\nThis model defines the complete structure for business-related API responses.", "properties": { "id": { "description": "Unique identifier for the business.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the business, determined by the name found on the domestic registration.", "examples": [ "Levine-Santos" ], "title": "Name", "type": "string" }, "structure": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure" }, { "type": "null" } ], "default": null, "description": "The structure of the business.", "examples": [ "C_CORPORATION", "LLC" ] }, "addresses": { "description": "All addresses found associated with this business entity.", "items": { "$ref": "#/components/schemas/v1.AddressSummaryResponseWithSources" }, "title": "Addresses", "type": "array" }, "phone_numbers": { "description": "All phone numbers found associated with this business entity.", "examples": [ [ "251-829-8026" ] ], "items": { "type": "string" }, "title": "Phone Numbers", "type": "array" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The main email found associated with this business entity.", "examples": [ "kathleenholmes@example.com" ], "title": "Email" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The website found associated with this business entity.", "examples": [ "http://www.cruz-adkins.net/" ], "title": "Website" }, "social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of social media profiles potentially associated with this business entity that were identified by searching the web.", "examples": [ { "confidence": null, "found_on": [], "metadata": null, "site": "twitter", "url": "https://twitter.com/michelle98", "username": "michelle98" } ], "title": "Social Profiles" }, "reviews": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredReview" }, "type": "array" }, { "type": "null" } ], "description": "The list of customer reviews potentially associated with this business entity that were identified by searching the web.", "title": "Reviews" }, "directory_listings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DirectoryListingResponse" }, "type": "array" }, { "type": "null" } ], "description": "Directory listings (BBB, Yelp, etc.) discovered during website analysis, including business category, contact info, and address.", "title": "Directory Listings" }, "ein": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The EIN/TIN found associated with this business entity.", "examples": [ "871888915" ], "title": "Ein" }, "incorporation_state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation" }, { "type": "null" } ], "default": null, "description": "The state in which the business first incorporated.", "examples": [ "HI" ] }, "incorporation_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date when the business first incorporated.", "examples": [ "2011-11-27" ], "title": "Incorporation Date" }, "months_in_business": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of months elapsed since the incorporation date.", "examples": [ 256 ], "title": "Months In Business" }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "default": null, "description": "The primary address associated with the business entity." }, "alternative_names": { "default": [], "description": "A list of alternative names (e.g. DBAs) found associated with the business entity.", "examples": [ [ "Ramos, Garcia and Good" ] ], "items": { "type": "string" }, "title": "Alternative Names", "type": "array" }, "registrations": { "description": "The corporate registrations associated with the business entity.", "items": { "$ref": "#/components/schemas/v1.RegistrationResponse" }, "title": "Registrations", "type": "array" }, "business_officers": { "description": "The officers associated with the business entity.", "items": { "$ref": "#/components/schemas/v1.BusinessOfficerResponse" }, "title": "Business Officers", "type": "array" }, "predicted_naics": { "default": [], "deprecated": true, "description": "The predicted NAICS code(s) for the business entity.", "items": { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, "title": "Predicted Naics", "type": "array" }, "watchlist_hits": { "default": [], "description": "The watchlist hits associated with the business entity.", "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "title": "Watchlist Hits", "type": "array" }, "sec_registrations": { "default": [], "description": "SEC EDGAR registrations linked to this business. Empty when no SEC registration is linked.", "items": { "$ref": "#/components/schemas/v1.SecRegistrationResponse" }, "title": "Sec Registrations", "type": "array" }, "url": { "description": "The URL to the business details.", "examples": [ "https://api.baselayer.com/businesses/9083e7e2-1f6b-11ef-8f0f-1edb1b067314" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Url", "type": "string" }, "console_url": { "description": "The URL to the business details in the console.", "examples": [ "https://console.baselayer.com/business/9083e7e2-1f6b-11ef-8f0f-1edb1b067314" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Console Url", "type": "string" }, "revenue": { "default": null, "deprecated": true, "description": "Indicates that there is no recent revenue data available for the business.", "title": "No revenue data", "type": "null" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The primary phone number found associated with the business.", "examples": [ "955-714-3269" ], "title": "Phone Number" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "The primary address associated with the business entity.", "examples": [ "63788 Paige Lane Cooperfurt, MI 10037" ], "readOnly": true, "title": "Address" } }, "required": [ "id", "name", "url", "console_url", "address" ], "title": "BusinessResponse (v1)", "type": "object" }, "v1.MatchType": { "enum": [ "NO_MATCH", "SIMILAR", "EXACT" ], "title": "MatchType", "type": "string" }, "v1.ReasonCode": { "description": "Every reason code Baselayer has ever issued.\n\nMembers are named exactly as their value so the code a customer sees is the\ncode a developer greps for. A member is never removed: rows that recorded it\nstill name it.", "enum": [ "ADDRESS_FAILED_TO_NORMALIZE", "ENTITY_NOT_FOUND", "BUSINESS_NAME_NO_MATCH", "NO_ACTIVE_REGISTRATIONS", "DOMESTIC_REGISTRATION_INACTIVE", "SOLE_REGISTRATION_STATUS_UNKNOWN", "ENTITY_AGE_UNDER_7D", "ENTITY_AGE_UNDER_30D", "ENTITY_AGE_UNDER_90D", "ENTITY_AGE_UNDER_6M", "ENTITY_AGE_UNDER_12M", "TIN_MISMATCH", "TIN_IS_SSN", "ADDRESS_NO_MATCH", "ADDRESS_PARTIAL_MATCH", "SEARCH_ADDRESS_UNDELIVERABLE", "SEARCH_ADDRESS_PO_BOX", "SEARCH_ADDRESS_CMRA", "SEARCH_ADDRESS_RESIDENTIAL", "PRIMARY_ADDRESS_UNDELIVERABLE", "PRIMARY_ADDRESS_PO_BOX", "PRIMARY_ADDRESS_CMRA", "PRIMARY_ADDRESS_RESIDENTIAL", "NO_OFFICER_MATCH", "SUBMITTED_DOMAIN_UNDER_7D", "DISCOVERED_DOMAIN_UNDER_7D", "TAX_LIEN_ACTIVE", "TAX_LIEN_PAST", "UCC_LIEN_ACTIVE", "BANKRUPTCY_ACTIVE", "BANKRUPTCY_RECENT", "LITIGATION_ACTIVE", "LITIGATION_RECENT", "NETWORK_HIGH_VELOCITY", "NETWORK_HIGH_APPLICATION_COUNT", "ADDRESS_MISMATCH", "NETWORK_NO_HISTORY" ], "title": "ReasonCode", "type": "string" }, "v1.ScoreResponse": { "properties": { "type": { "$ref": "#/components/schemas/v1.ScoreType", "description": "The type of score.", "examples": [ "risk" ] }, "score": { "description": "The score value.", "examples": [ 95.0 ], "title": "Score", "type": "number" }, "rating": { "description": "The rating associated with the score.", "examples": [ "A", "B" ], "title": "Rating", "type": "string" } }, "required": [ "type", "score", "rating" ], "title": "ScoreResponse (v1)", "type": "object" }, "v1.ScoreType": { "enum": [ "fraud", "risk", "kyb" ], "title": "ScoreType", "type": "string" }, "v1.UserAttributionResponse": { "description": "Response model for user attribution operations.\n\nThis model defines the structure for user attribution API responses.", "properties": { "id": { "description": "Unique identifier for the user.", "format": "uuid", "title": "Id", "type": "string" }, "first_name": { "description": "First name of the user.", "examples": [ "Austin" ], "title": "First Name", "type": "string" }, "last_name": { "description": "Last name of the user.", "examples": [ "Taylor" ], "title": "Last Name", "type": "string" }, "email": { "description": "Email address of the user.", "examples": [ "jessicasimpson@example.com" ], "title": "Email", "type": "string" } }, "required": [ "id", "first_name", "last_name", "email" ], "title": "UserAttributionResponse (v1)", "type": "object" }, "v1.BusinessSummaryResponse": { "description": "Response model for business summary data.", "properties": { "id": { "description": "Unique identifier for the business.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the business, determined by the name found on the domestic registration.", "examples": [ "Hamilton-Olson" ], "title": "Name", "type": "string" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary address associated with the business entity.", "examples": [ "63788 Paige Lane Cooperfurt, MI 10037" ], "title": "Address" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary phone number found associated with the business.", "examples": [ "955-714-3269" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary email address found associated with the business.", "examples": [ "javier01@example.net" ], "title": "Email" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The primary website found associated with the business.", "examples": [ "https://jones.com/" ], "title": "Website" }, "url": { "description": "The URL to the business details.", "examples": [ "https://api.baselayer.com/businesses/9083e7e2-1f6b-11ef-8f0f-1edb1b067314" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Url", "type": "string" }, "console_url": { "description": "The URL to the business details in the console.", "examples": [ "https://console.baselayer.com/business/9083e7e2-1f6b-11ef-8f0f-1edb1b067314" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Console Url", "type": "string" } }, "required": [ "id", "name" ], "title": "BusinessSummaryResponse (v1)", "type": "object" }, "v1.IssuedCredentialStatus": { "description": "The credential's state on the published Token Status List.\n\nValid is the mint-time state; Revoked is terminal: the organization or\nan individual pulling this one credential, or our own compromise\nresponse. Expiry is deliberately not a status:\nverifiers already check ``exp``, and the bit must keep meaning\n\"revoked before expiry\" for the issuance log.", "enum": [ "VALID", "REVOKED" ], "title": "IssuedCredentialStatus", "type": "string" }, "v1.CredentialEventKind": { "description": "What happened to a credential, as one row of its event stream.", "enum": [ "ISSUED", "REVOKED" ], "title": "CredentialEventKind", "type": "string" }, "v1.CredentialPreset": { "description": "A named use case an L3 mint can disclose by instead of listing paths.\n\nThe paths each preset shares live in\n``osiris.identity.credential_presets``; this is the stored vocabulary\n(``issued_credentials.preset``). Retiring a preset is deleting its\nmember: every read of a stored record types the key as text.", "enum": [ "consumer_ecommerce", "age_gated", "consumer_regulated", "b2b_ecommerce", "b2b_regulated" ], "title": "CredentialPreset", "type": "string" }, "v1.IssuedCredentialLifecycleState": { "description": "A credential's effective state as an issuance-log reader sees it.\n\nDerived, never stored: ``IssuedCredentialStatus`` deliberately keeps\nexpiry out of the persisted status (verifiers check ``exp``), but the\nconsole and API consumers filter the log by what a credential *is*\nright now — still presentable, aged out, or killed.", "enum": [ "ACTIVE", "EXPIRED", "REVOKED" ], "title": "IssuedCredentialLifecycleState", "type": "string" }, "v1.BusinessCredentialMintRequest": { "additionalProperties": false, "description": "``type: BUSINESS``: mint for a verified person as the operator of the\nbusiness ``business_ref`` names.", "properties": { "format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "default": "dc+sd-jwt", "description": "Credential wire format. `dc+sd-jwt` (media type `application/dc+sd-jwt`, draft-ietf-oauth-sd-jwt-vc-19 §2.1) is the only format issued." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "default": "L3", "description": "Credential layer to mint (defaults to `L3`): `L2` (audience-scoped pairwise DID) or `L3` (selectively disclosed verified identity)." }, "ttl_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum credential validity in seconds, capped at supporting evidence expiry. Omitted or null uses the server default (3600 seconds). Must not exceed the configured maximum (86400 seconds by default). Applies to L2 and L3.", "title": "Ttl Seconds" }, "audience": { "description": "The counterparty the credential is scoped to: a bare domain (`login.example.com`), or an https authorization-server identifier (`https://login.example.com`) kept whole, which derives a different pairwise subject than the bare host. Paths, queries, fragments and non-default ports are refused.", "maxLength": 512, "minLength": 1, "title": "Audience", "type": "string" }, "disclosed_fields": { "description": "`L3` only: the dotted disclosure paths the subject credential should carry, e.g. `email` or `hashes.email`. A business mint lists business paths here and the actor credential's paths, e.g. `given_name`, in `actor_disclosed_fields`.", "items": { "type": "string" }, "maxItems": 64, "title": "Disclosed Fields", "type": "array" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "default": null, "description": "L3 only: disclose a use case's fields instead of listing `disclosed_fields`; never both. `GET /issuance/credentials/presets` lists each preset's paths. A preset always shares values in the clear, and B2B presets need a business mint." }, "disclosure_mode": { "$ref": "#/components/schemas/v1.DisclosureMode", "default": "CLEARTEXT_AND_HASH", "description": "L3 disclosure mode: CLEARTEXT_AND_HASH (default) discloses requested fields as cleartext alongside their recognition hashes; HASH_ONLY discloses only the recognition hashes." }, "agent_key": { "$ref": "#/components/schemas/v1.CredentialAgentKey", "description": "Public JWK of the agent that will present the credential; becomes the credential's cnf binding." }, "individual_ref": { "description": "Pairwise reference to the verified individual, as issued to the calling organization at verification completion.", "maxLength": 255, "minLength": 1, "title": "Individual Ref", "type": "string" }, "type": { "const": "BUSINESS", "description": "`BUSINESS`: a person acting as the operator of the business `business_ref` names.", "title": "Type", "type": "string" }, "business_ref": { "description": "Pairwise reference to the verified business whose identity the individual assumes, as issued to the calling organization.", "maxLength": 255, "minLength": 1, "title": "Business Ref", "type": "string" }, "actor_disclosed_fields": { "description": "`L3` only: the dotted paths the separate actor credential should carry, unprefixed, e.g. `given_name` or `hashes.email` — the individual vocabulary `/vct/kya/individual/v1` lists. Never with `preset`.", "items": { "type": "string" }, "maxItems": 64, "title": "Actor Disclosed Fields", "type": "array" } }, "required": [ "audience", "agent_key", "individual_ref", "type", "business_ref" ], "title": "BusinessCredentialMintRequest (v1)", "type": "object" }, "v1.CredentialAgentKey": { "additionalProperties": false, "description": "The presenting agent's public key, bound into the credential's\n``cnf`` claim (RFC 7800).\n\nThe customer is the retriever, but the credential is presentable only\nby the agent holding the matching private key. v1 pins the signature\nsuite: Ed25519 OKP keys only. ``x`` must encode a well-formed Ed25519\npublic key, so malformed key material is rejected as a payload\nvalidation error, never a mint-time surprise.", "properties": { "kty": { "const": "OKP", "default": "OKP", "description": "JWK key type; v1 accepts OKP only.", "title": "Kty", "type": "string" }, "crv": { "const": "Ed25519", "default": "Ed25519", "description": "JWK curve; v1 accepts Ed25519 only.", "title": "Crv", "type": "string" }, "x": { "description": "Base64url-encoded Ed25519 public key bytes.", "minLength": 1, "title": "X", "type": "string" }, "kid": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional key identifier.", "title": "Kid" } }, "required": [ "x" ], "title": "CredentialAgentKey (v1)", "type": "object" }, "v1.CredentialWireFormat": { "description": "The credential formats issued. The value is the SD-JWT VC media-type\nsubtype, a standard code kept verbatim. Validation accepts the stored\n``SD_JWT_VC`` member, never that string.", "enum": [ "dc+sd-jwt" ], "title": "CredentialWireFormat", "type": "string" }, "v1.IndividualCredentialMintRequest": { "additionalProperties": false, "description": "``type: INDIVIDUAL``: mint for a verified person as themselves.", "properties": { "format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "default": "dc+sd-jwt", "description": "Credential wire format. `dc+sd-jwt` (media type `application/dc+sd-jwt`, draft-ietf-oauth-sd-jwt-vc-19 §2.1) is the only format issued." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "default": "L3", "description": "Credential layer to mint (defaults to `L3`): `L2` (audience-scoped pairwise DID) or `L3` (selectively disclosed verified identity)." }, "ttl_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum credential validity in seconds, capped at supporting evidence expiry. Omitted or null uses the server default (3600 seconds). Must not exceed the configured maximum (86400 seconds by default). Applies to L2 and L3.", "title": "Ttl Seconds" }, "audience": { "description": "The counterparty the credential is scoped to: a bare domain (`login.example.com`), or an https authorization-server identifier (`https://login.example.com`) kept whole, which derives a different pairwise subject than the bare host. Paths, queries, fragments and non-default ports are refused.", "maxLength": 512, "minLength": 1, "title": "Audience", "type": "string" }, "disclosed_fields": { "description": "`L3` only: the dotted disclosure paths the subject credential should carry, e.g. `email` or `hashes.email`. A business mint lists business paths here and the actor credential's paths, e.g. `given_name`, in `actor_disclosed_fields`.", "items": { "type": "string" }, "maxItems": 64, "title": "Disclosed Fields", "type": "array" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "default": null, "description": "L3 only: disclose a use case's fields instead of listing `disclosed_fields`; never both. `GET /issuance/credentials/presets` lists each preset's paths. A preset always shares values in the clear, and B2B presets need a business mint." }, "disclosure_mode": { "$ref": "#/components/schemas/v1.DisclosureMode", "default": "CLEARTEXT_AND_HASH", "description": "L3 disclosure mode: CLEARTEXT_AND_HASH (default) discloses requested fields as cleartext alongside their recognition hashes; HASH_ONLY discloses only the recognition hashes." }, "agent_key": { "$ref": "#/components/schemas/v1.CredentialAgentKey", "description": "Public JWK of the agent that will present the credential; becomes the credential's cnf binding." }, "individual_ref": { "description": "Pairwise reference to the verified individual, as issued to the calling organization at verification completion.", "maxLength": 255, "minLength": 1, "title": "Individual Ref", "type": "string" }, "type": { "const": "INDIVIDUAL", "description": "`INDIVIDUAL`: the person as themselves.", "title": "Type", "type": "string" } }, "required": [ "audience", "agent_key", "individual_ref", "type" ], "title": "IndividualCredentialMintRequest (v1)", "type": "object" }, "v1.CredentialMintEntry": { "description": "One minted credential: the subject's, or on a business L3 mint the\nactor's beside it.\n\n``credential`` is the SD-JWT presentation without a Key Binding JWT: the\npresenting agent appends the KB-JWT at request time.", "properties": { "role": { "$ref": "#/components/schemas/v1.CredentialRole", "description": "Whether this is the subject's or the actor's." }, "credential_id": { "description": "The credential's unique id: exactly the `jti` its token carries.", "title": "Credential Id", "type": "string" }, "credential": { "description": "The SD-JWT-VC wire string.", "title": "Credential", "type": "string" }, "disclosed_fields": { "description": "The dotted disclosure paths this credential carries.", "items": { "type": "string" }, "title": "Disclosed Fields", "type": "array" }, "expires_at": { "description": "Expiry instant (the issuer JWT's exp).", "format": "date-time", "title": "Expires At", "type": "string" }, "active_keys": { "description": "Names of the verification checks that passed (e.g. `phone_possession` for an individual, `tax_id_match` for a business), from the token-exchange profile's key vocabulary; the verification level is derived from them.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" } }, "required": [ "role", "credential_id", "credential", "expires_at" ], "title": "CredentialMintEntry (v1)", "type": "object" }, "v1.CredentialRole": { "description": "What a credential in a mint or preview response is for: the subject\nit names, or the individual who acts for a business subject.", "enum": [ "subject", "actor" ], "title": "CredentialRole", "type": "string" }, "v1.BusinessCredentialPreviewRequest": { "additionalProperties": false, "description": "The business mint body, so one body previews and then mints.\n``agent_key`` is optional and unused; a preview is L3 only.", "properties": { "format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "default": "dc+sd-jwt", "description": "Credential wire format. `dc+sd-jwt` (media type `application/dc+sd-jwt`, draft-ietf-oauth-sd-jwt-vc-19 §2.1) is the only format issued." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "default": "L3", "description": "Credential layer to mint (defaults to `L3`): `L2` (audience-scoped pairwise DID) or `L3` (selectively disclosed verified identity)." }, "ttl_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum credential validity in seconds, capped at supporting evidence expiry. Omitted or null uses the server default (3600 seconds). Must not exceed the configured maximum (86400 seconds by default). Applies to L2 and L3.", "title": "Ttl Seconds" }, "audience": { "description": "The counterparty the credential is scoped to: a bare domain (`login.example.com`), or an https authorization-server identifier (`https://login.example.com`) kept whole, which derives a different pairwise subject than the bare host. Paths, queries, fragments and non-default ports are refused.", "maxLength": 512, "minLength": 1, "title": "Audience", "type": "string" }, "disclosed_fields": { "description": "`L3` only: the dotted disclosure paths the subject credential should carry, e.g. `email` or `hashes.email`. A business mint lists business paths here and the actor credential's paths, e.g. `given_name`, in `actor_disclosed_fields`.", "items": { "type": "string" }, "maxItems": 64, "title": "Disclosed Fields", "type": "array" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "default": null, "description": "L3 only: disclose a use case's fields instead of listing `disclosed_fields`; never both. `GET /issuance/credentials/presets` lists each preset's paths. A preset always shares values in the clear, and B2B presets need a business mint." }, "disclosure_mode": { "$ref": "#/components/schemas/v1.DisclosureMode", "default": "CLEARTEXT_AND_HASH", "description": "L3 disclosure mode: CLEARTEXT_AND_HASH (default) discloses requested fields as cleartext alongside their recognition hashes; HASH_ONLY discloses only the recognition hashes." }, "agent_key": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialAgentKey" }, { "type": "null" } ], "default": null, "description": "Accepted so a mint body previews unchanged; a preview binds no key." }, "individual_ref": { "description": "Pairwise reference to the verified individual, as issued to the calling organization at verification completion.", "maxLength": 255, "minLength": 1, "title": "Individual Ref", "type": "string" }, "type": { "const": "BUSINESS", "description": "`BUSINESS`: a person acting as the operator of the business `business_ref` names.", "title": "Type", "type": "string" }, "business_ref": { "description": "Pairwise reference to the verified business whose identity the individual assumes, as issued to the calling organization.", "maxLength": 255, "minLength": 1, "title": "Business Ref", "type": "string" }, "actor_disclosed_fields": { "description": "`L3` only: the dotted paths the separate actor credential should carry, unprefixed, e.g. `given_name` or `hashes.email` — the individual vocabulary `/vct/kya/individual/v1` lists. Never with `preset`.", "items": { "type": "string" }, "maxItems": 64, "title": "Actor Disclosed Fields", "type": "array" } }, "required": [ "audience", "individual_ref", "type", "business_ref" ], "title": "BusinessCredentialPreviewRequest (v1)", "type": "object" }, "v1.IndividualCredentialPreviewRequest": { "additionalProperties": false, "description": "The individual mint body, so one body previews and then mints.\n``agent_key`` is optional and unused; a preview is L3 only.", "properties": { "format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "default": "dc+sd-jwt", "description": "Credential wire format. `dc+sd-jwt` (media type `application/dc+sd-jwt`, draft-ietf-oauth-sd-jwt-vc-19 §2.1) is the only format issued." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "default": "L3", "description": "Credential layer to mint (defaults to `L3`): `L2` (audience-scoped pairwise DID) or `L3` (selectively disclosed verified identity)." }, "ttl_seconds": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Maximum credential validity in seconds, capped at supporting evidence expiry. Omitted or null uses the server default (3600 seconds). Must not exceed the configured maximum (86400 seconds by default). Applies to L2 and L3.", "title": "Ttl Seconds" }, "audience": { "description": "The counterparty the credential is scoped to: a bare domain (`login.example.com`), or an https authorization-server identifier (`https://login.example.com`) kept whole, which derives a different pairwise subject than the bare host. Paths, queries, fragments and non-default ports are refused.", "maxLength": 512, "minLength": 1, "title": "Audience", "type": "string" }, "disclosed_fields": { "description": "`L3` only: the dotted disclosure paths the subject credential should carry, e.g. `email` or `hashes.email`. A business mint lists business paths here and the actor credential's paths, e.g. `given_name`, in `actor_disclosed_fields`.", "items": { "type": "string" }, "maxItems": 64, "title": "Disclosed Fields", "type": "array" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "default": null, "description": "L3 only: disclose a use case's fields instead of listing `disclosed_fields`; never both. `GET /issuance/credentials/presets` lists each preset's paths. A preset always shares values in the clear, and B2B presets need a business mint." }, "disclosure_mode": { "$ref": "#/components/schemas/v1.DisclosureMode", "default": "CLEARTEXT_AND_HASH", "description": "L3 disclosure mode: CLEARTEXT_AND_HASH (default) discloses requested fields as cleartext alongside their recognition hashes; HASH_ONLY discloses only the recognition hashes." }, "agent_key": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialAgentKey" }, { "type": "null" } ], "default": null, "description": "Accepted so a mint body previews unchanged; a preview binds no key." }, "individual_ref": { "description": "Pairwise reference to the verified individual, as issued to the calling organization at verification completion.", "maxLength": 255, "minLength": 1, "title": "Individual Ref", "type": "string" }, "type": { "const": "INDIVIDUAL", "description": "`INDIVIDUAL`: the person as themselves.", "title": "Type", "type": "string" } }, "required": [ "audience", "individual_ref", "type" ], "title": "IndividualCredentialPreviewRequest (v1)", "type": "object" }, "v1.CredentialPreviewAuthorization": { "description": "The always-disclosed operator authorization a business credential\ncarries in its ``actor`` block.", "properties": { "status": { "$ref": "#/components/schemas/v1.L3OperatorLinkStatus", "description": "The operator link's status at mint." }, "basis": { "$ref": "#/components/schemas/v1.L3OperatorAuthorizationBasis", "description": "Why the link is verified: the evidence recipe passed, or a reviewer decided it." }, "confirmed_at": { "description": "When the link was last confirmed.", "format": "date-time", "title": "Confirmed At", "type": "string" } }, "required": [ "status", "basis", "confirmed_at" ], "title": "CredentialPreviewAuthorization (v1)", "type": "object" }, "v1.CredentialPreviewDisclosure": { "description": "One leaf an L3 mint with the same body would disclose.", "properties": { "path": { "description": "The wire-form disclosure path.", "title": "Path", "type": "string" }, "value": { "$ref": "#/components/schemas/v1.JsonValue", "description": "The exact value the credential would carry; for a recognition hash, the hash." }, "hashed": { "description": "Whether the leaf is a recognition hash.", "title": "Hashed", "type": "boolean" } }, "required": [ "path", "value", "hashed" ], "title": "CredentialPreviewDisclosure (v1)", "type": "object" }, "v1.CredentialPreviewEntry": { "description": "What one credential of a mint with the same body would carry.", "properties": { "role": { "$ref": "#/components/schemas/v1.CredentialRole", "description": "Whether this is the subject's or the actor's." }, "disclosed": { "description": "The leaves the credential would carry, in path order.", "items": { "$ref": "#/components/schemas/v1.CredentialPreviewDisclosure" }, "title": "Disclosed", "type": "array" }, "missing_paths": { "description": "Requested paths with nothing on file, which the mint would skip. Measured after HASH_ONLY collapses a family onto its hash.", "items": { "type": "string" }, "title": "Missing Paths", "type": "array" }, "expires_at": { "description": "When a mint now would expire.", "format": "date-time", "title": "Expires At", "type": "string" }, "active_keys": { "description": "Names of the verification checks that would pass (e.g. `phone_possession` for an individual, `tax_id_match` for a business), from the token-exchange profile's key vocabulary; the verification level is derived from them.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "authorization": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreviewAuthorization" }, { "type": "null" } ], "default": null, "description": "A business credential's subject entry only: the operator authorization it always carries." } }, "required": [ "role", "disclosed", "missing_paths", "expires_at", "active_keys" ], "title": "CredentialPreviewEntry (v1)", "type": "object" }, "v1.JsonValue": {}, "v1.L3OperatorAuthorizationBasis": { "description": "Why the operator link is Verified: the evidence recipe passed, or a\nreviewer at the organization decided it by hand.", "enum": [ "evidence", "reviewer" ], "title": "L3OperatorAuthorizationBasis", "type": "string" }, "v1.L3OperatorLinkStatus": { "description": "The acting person's operator link status (spec wire form). Only a\nVerified link mints, so it is the only member.", "enum": [ "verified" ], "title": "L3OperatorLinkStatus", "type": "string" }, "v1.CredentialStatusListPointer": { "description": "A credential's reference into a published Token Status List.", "properties": { "uri": { "description": "The status list's URI.", "title": "Uri", "type": "string" }, "idx": { "description": "The credential's index on that list.", "title": "Idx", "type": "integer" } }, "required": [ "uri", "idx" ], "title": "CredentialStatusListPointer (v1)", "type": "object" }, "v1.CustomerRevocationReason": { "description": "Why a customer revoked a credential by hand: ``AuditRevocationReason``\nwithout ``administrative_action``, which stays Baselayer's.", "enum": [ "agent_key_compromise", "identity_superseded", "identity_withdrawn", "operator_link_revoked", "fraud_suspected" ], "title": "CustomerRevocationReason", "type": "string" }, "v1.AgenticPaymentRail": { "description": "A payment method a directory-listed business accepts from agents.\n\nSelf-declared commerce metadata on a KYA directory entry — which rails\n(protocols or card-network agent programs) the merchant advertises for\nagentic checkout. Advisory only: nothing in the platform settles on\nthese rails, so the vocabulary is expected to grow with the ecosystem\nand OTHER absorbs rails we have not named yet.", "enum": [ "X402", "MPP", "UCP", "VISA_TAP", "VISA_INTELLIGENT_COMMERCE", "MASTERCARD_AGENT_PAY", "GOOGLE_AP2", "STRIPE_ACP", "OTHER" ], "title": "AgenticPaymentRail", "type": "string" }, "v1.DirectoryContact": { "description": "A point of contact a directory entry publishes for questions.\n\nBusiness-role contact details the merchant chose to advertise —\nnever sourced from vault or verification data. Directory entries are\nglobally readable, so whatever lands here is public: the email is\nsyntax-validated and canonicalized, and the free-text fields are\nbounded so the payload stays a contact card, not a dumping ground.", "properties": { "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "role": { "maxLength": 200, "minLength": 1, "title": "Role", "type": "string" }, "email": { "format": "email", "title": "Email", "type": "string" } }, "required": [ "name", "role", "email" ], "title": "DirectoryContact", "type": "object" }, "v1.DirectoryCounterpartyCredentialResponse": { "description": "The serving state of the credential this entry's domain hosts.\n\nPresent only when the linked business has minted one for this domain;\nread-only — minting from the directory is a follow-up.", "properties": { "status": { "$ref": "#/components/schemas/v1.DirectoryCounterpartyStatus", "description": "SERVING when a counterparty credential bound to this entry's domain is currently valid; LAPSED when every one minted for it has expired, been revoked, or lost its supporting registry state." }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the currently serving credential expires; null when LAPSED.", "title": "Expires At" } }, "required": [ "status" ], "title": "DirectoryCounterpartyCredentialResponse (v1)", "type": "object" }, "v1.DirectoryCounterpartyStatus": { "description": "Whether a directory entry's linked business serves a live\ncounterparty credential for the entry's own domain.\n\nDerived, never stored: SERVING means at least one counterparty\ncredential bound to this domain is currently valid under the business's\nregistry state; LAPSED means credentials were minted for the domain but\nnone is valid now (expired, revoked, or the business fell out of\nstanding). A domain that never minted one has no status at all — the\nfield is absent, not LAPSED.", "enum": [ "SERVING", "LAPSED" ], "title": "DirectoryCounterpartyStatus", "type": "string" }, "v1.DirectoryRegistryRecordResponse": { "description": "The public-record identity behind an entry's linked business.\n\nThe incorporation facts a reader needs to tell one \"Acme Robotics\" from\nanother: the legal name as the domicile filing spells it and the filing\nthat names it. Public-record only — the same corpus the verified badge\nreads, never an organization's private evaluation — and it carries no\nBaselayer business id, so an entry stays addressed by its own directory\nid alone.", "properties": { "legal_name": { "description": "The business's legal name as its domicile registration filing spells it, which may differ from the display name the merchant advertises under.", "title": "Legal Name", "type": "string" }, "incorporation_state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state the business is domiciled in." }, "incorporation_filing_number": { "description": "The domicile registration's filing number in that state.", "title": "Incorporation Filing Number", "type": "string" }, "incorporation_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the business incorporated; null when the registry did not publish a date.", "title": "Incorporation Date" } }, "required": [ "legal_name", "incorporation_state", "incorporation_filing_number" ], "title": "DirectoryRegistryRecordResponse (v1)", "type": "object" }, "v1.DisclosureProfile": { "description": "The counterparty's ``kya-profile.json``.", "properties": { "profile_id": { "title": "Profile Id", "type": "string" }, "domain": { "title": "Domain", "type": "string" }, "publisher": { "additionalProperties": { "type": "string" }, "title": "Publisher", "type": "object" }, "class_attestation": { "additionalProperties": { "type": "string" }, "title": "Class Attestation", "type": "object" }, "scopes": { "items": { "$ref": "#/components/schemas/v1.DisclosureScope" }, "title": "Scopes", "type": "array" } }, "required": [ "profile_id", "domain", "publisher", "class_attestation", "scopes" ], "title": "DisclosureProfile", "type": "object" }, "v1.DisclosureScope": { "description": "One published use case: the fields it may read and why.", "properties": { "name": { "title": "Name", "type": "string" }, "tier": { "title": "Tier", "type": "string" }, "purpose": { "title": "Purpose", "type": "string" }, "legal_basis": { "title": "Legal Basis", "type": "string" }, "fields": { "items": { "type": "string" }, "title": "Fields", "type": "array" }, "retention_days": { "title": "Retention Days", "type": "integer" } }, "required": [ "name", "tier", "purpose", "legal_basis", "fields", "retention_days" ], "title": "DisclosureScope", "type": "object" }, "v1.DMFCode": { "enum": [ "DMF" ], "title": "DMFCode", "type": "string" }, "v1.DMFResponseDetails": { "properties": { "dmf_id": { "description": "The DMF ID of the person of interest", "examples": [ "8237172" ], "title": "Dmf Id", "type": "string" }, "ssn": { "description": "The social security number of the person of interest", "examples": [ "917-322-9999" ], "title": "Ssn", "type": "string" }, "name": { "description": "The name of the person of interest", "examples": [ "Sandra Carlson" ], "title": "Name", "type": "string" }, "death_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of death of the person of interest", "examples": [ "2023-09-15" ], "title": "Death Date" }, "death_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/v1.DateType" }, { "type": "null" } ], "default": null, "description": "The date precision of the date of death of the person of interest. If date type is MONTH the day should be ignored", "examples": [ "DAY", "MONTH" ] }, "birth_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of birth of the person of interest", "examples": [ "1982-11-27" ], "title": "Birth Date" }, "birth_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/v1.DateType" }, { "type": "null" } ], "default": null, "description": "The date precision of the date of birth of the person of interest. If date type is MONTH the day should be ignored", "examples": [ "MONTH", "DAY" ] }, "state_of_residency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The state of residency of the person of interest", "examples": [ "California" ], "title": "State Of Residency" }, "zip_code_of_residency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The zip code of residency of the person of interest", "examples": [ "90210" ], "title": "Zip Code Of Residency" } }, "required": [ "dmf_id", "ssn", "name" ], "title": "DMFResponseDetails (v1)", "type": "object" }, "v1.DateType": { "enum": [ "DAY", "MONTH" ], "title": "DateType", "type": "string" }, "v1.BankruptcyType": { "enum": [ "Chapter 7", "Chapter 9", "Chapter 11", "Chapter 12", "Chapter 13", "Chapter 15" ], "title": "BankruptcyType", "type": "string" }, "v1.BusinessOrPersonType": { "enum": [ "Business", "Person" ], "title": "BusinessOrPersonType", "type": "string" }, "v1.CourtStateAbbreviation": { "enum": [ "US", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "CN", "VI", "AE", "AA", "AP", "MX" ], "title": "CourtStateAbbreviation", "type": "string" }, "v1.DocketAddressMatchType": { "description": "Court-venue-vs-subject-state signal for docket match_confidence.\nDistinct from `AddressMatchType` (KYB/international address comparison,\nabove) — different domain, different value set.", "enum": [ "STATE", "ADJACENT", "FEDERAL_VENUE", "NO_MATCH", "UNKNOWN" ], "title": "DocketAddressMatchType", "type": "string" }, "v1.DocketDateMatchType": { "description": "Filing-date-vs-reference-date veto signal for docket\nmatch_confidence.", "enum": [ "CONSISTENT", "INCONSISTENT", "UNKNOWN" ], "title": "DocketDateMatchType", "type": "string" }, "v1.DocketExhibit": { "description": "Represents a docket exhibit.", "properties": { "id": { "description": "ID of the litigation", "format": "uuid", "title": "Id", "type": "string" }, "title": { "description": "Exhibit title", "examples": [ "Exhibit 1A" ], "title": "Title", "type": "string" }, "is_available": { "default": false, "description": "Is the exhibit available", "title": "Is Available", "type": "boolean" }, "document_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The document_url is a string that represents Docket Exhibit's document URL.", "readOnly": true, "title": "Document Url" } }, "required": [ "id", "title", "document_url" ], "title": "DocketExhibit (v1)", "type": "object" }, "v1.DocketMatchConfidenceResponse": { "description": "How likely a docket involves the search subject: a confidence level\nplus the three signals it's built from.", "properties": { "confidence": { "$ref": "#/components/schemas/v1.ConfidenceLevel", "description": "The confidence level that this docket involves the search subject.", "examples": [ "high", "medium", "low" ] }, "name_match": { "$ref": "#/components/schemas/v1.MatchType", "description": "The degree to which the names associated with the docket match the name(s) of the search subject.", "examples": [ "NO_MATCH", "SIMILAR", "EXACT" ] }, "address_match": { "$ref": "#/components/schemas/v1.DocketAddressMatchType", "description": "The degree to which the address information of the docket matches the addresses of the search subject.", "examples": [ "STATE", "ADJACENT", "FEDERAL_VENUE", "NO_MATCH", "UNKNOWN" ] }, "date_match": { "$ref": "#/components/schemas/v1.DocketDateMatchType", "description": "The consistency between the docket's filing date and the date when the search subject was legally capable of being a party in the docket (e.g. the date of incorporation).", "examples": [ "CONSISTENT", "INCONSISTENT", "UNKNOWN" ] } }, "required": [ "confidence", "name_match", "address_match", "date_match" ], "title": "DocketMatchConfidenceResponse (v1)", "type": "object" }, "v1.DocketParty": { "description": "Represents a docket party.", "properties": { "id": { "description": "The unique identifier of the docket party.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the docket party.", "title": "Name", "type": "string" }, "party_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of party", "examples": [ "Complaintant" ], "title": "Party Type" }, "counsel": { "default": [], "description": "List of counsel representing the party", "examples": [ [ "Robin Keller" ] ], "items": { "type": "string" }, "title": "Counsel", "type": "array" } }, "required": [ "id", "name" ], "title": "DocketParty (v1)", "type": "object" }, "v1.DocketResponse": { "description": "Represents a docket response.", "properties": { "id": { "description": "ID of the docket", "format": "uuid", "title": "Id", "type": "string" }, "docket_number": { "description": "Unique identifier for the Docket in the given court system", "examples": [ "A19284" ], "title": "Docket Number", "type": "string" }, "court": { "description": "Court in which the docket was filed", "examples": [ "Supreme Court of Orange County" ], "title": "Court", "type": "string" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.CourtStateAbbreviation" }, { "type": "null" } ], "default": null, "description": "State where the court is located (US for federal courts)", "examples": [ "CA", "NY", "US" ] }, "division": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Which court division", "examples": [ "Civil Court Division" ], "title": "Division" }, "judges": { "default": [], "description": "List of judges assigned to the docket", "examples": [ [ "Honorable Paul Shaw" ] ], "items": { "type": "string" }, "title": "Judges", "type": "array" }, "title": { "description": "Title of the docket", "examples": [ "Doe v. City of New York" ], "title": "Title", "type": "string" }, "case_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of case", "examples": [ "Civil", "Criminal", "Bankruptcy" ], "title": "Case Type" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Status of the case", "examples": [ "Pending" ], "title": "Status" }, "is_bankruptcy": { "description": "Is the case a bankruptcy", "title": "Is Bankruptcy", "type": "boolean" }, "bankruptcy_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BankruptcyType" }, { "type": "null" } ], "default": null, "description": "If the docket is a bankruptcy, is it Chapter 7 or Chapter 11", "examples": [ "Chapter 7", "Chapter 11" ] }, "date_filed": { "default": "1900-01-01", "description": "Date the case was filed. In cases where the date is not provided, this will be set to 1900-01-01.", "format": "date", "title": "Date Filed", "type": "string" }, "date_closed": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date the case was closed or terminated, if known", "title": "Date Closed" }, "last_synced_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Datetime the case was last refreshed", "title": "Last Synced At" }, "parties": { "default": [], "description": "List of parties involved in the docket", "items": { "$ref": "#/components/schemas/v1.DocketParty" }, "title": "Parties", "type": "array" }, "updates": { "default": [], "description": "List of updates to the docket", "items": { "$ref": "#/components/schemas/v1.DocketUpdate" }, "title": "Updates", "type": "array" }, "match_level": { "anyOf": [ { "$ref": "#/components/schemas/v1.MatchType" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The match level of the docket to the entity's name. Deprecated in favor of match_confidence." }, "search_entity_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the entity that the docket matched to", "title": "Search Entity Name" }, "search_entity_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOrPersonType" }, { "type": "null" } ], "default": null, "description": "The type of the entity that the docket matched to" }, "match_confidence": { "anyOf": [ { "$ref": "#/components/schemas/v1.DocketMatchConfidenceResponse" }, { "type": "null" } ], "default": null, "description": "Confidence level and signals that the docket is associated with the search subject. " }, "risk_level": { "anyOf": [ { "$ref": "#/components/schemas/v1.RiskLevel" }, { "type": "null" } ], "default": null, "description": "The risk level of the docket", "examples": [ "low", "medium", "high" ] }, "normalized_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.NormalizedDocketStatus" }, { "type": "null" } ], "default": null, "description": "The normalized status of the docket", "examples": [ "open", "closed" ] } }, "required": [ "id", "docket_number", "court", "title", "is_bankruptcy" ], "title": "DocketResponse (v1)", "type": "object" }, "v1.DocketUpdate": { "description": "Represents a docket update.", "properties": { "id": { "description": "ID of the litigation", "format": "uuid", "title": "Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Update title", "examples": [ "Update 2" ], "title": "Title" }, "contents": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Update contents", "examples": [ "New details about the case." ], "title": "Contents" }, "date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Update date", "examples": [ "2024-06-01" ], "title": "Date" }, "exhibits": { "default": [], "description": "List of exhibits", "items": { "$ref": "#/components/schemas/v1.DocketExhibit" }, "title": "Exhibits", "type": "array" } }, "required": [ "id" ], "title": "DocketUpdate (v1)", "type": "object" }, "v1.NormalizedDocketStatus": { "enum": [ "open", "closed" ], "title": "NormalizedDocketStatus", "type": "string" }, "v1.AdditionalDocketSearchEntityResponse": { "properties": { "name": { "description": "The name of the entity to search for.", "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "type": { "$ref": "#/components/schemas/v1.BusinessOrPersonType", "description": "The type of the entity to search for." }, "normalized_name": { "readOnly": true, "title": "Normalized Name", "type": "string" } }, "required": [ "name", "type", "normalized_name" ], "title": "AdditionalDocketSearchEntityResponse (v1)", "type": "object" }, "v1.BusinessChecksUnavailableReason": { "description": "Why a business profile lists no checks under its outcome.", "enum": [ "EVIDENCE_UNAVAILABLE", "NO_CONFIRMED_VERIFICATION" ], "title": "BusinessChecksUnavailableReason", "type": "string" }, "v1.BusinessIncorporationResponse": { "description": "The registry facts of a verified business's incorporation.", "properties": { "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "State of incorporation." }, "filing_number": { "description": "Registry filing number in that state.", "title": "Filing Number", "type": "string" }, "incorporation_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date of incorporation, when the registry publishes it.", "title": "Incorporation Date" }, "structure": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure" }, { "type": "null" } ], "default": null, "description": "Legal structure, when known." }, "sos_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.SOSStatus" }, { "type": "null" } ], "default": null, "description": "The registry's standing for the entity, when known." }, "dissolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date of dissolution, when the entity has one.", "title": "Dissolution Date" } }, "required": [ "state", "filing_number" ], "title": "BusinessIncorporationResponse (v1)", "type": "object" }, "v1.BusinessKybCheckKey": { "description": "One line of a business's verification card.", "enum": [ "REGISTRY_RECORD_FOUND", "REGISTRATION_ACTIVE", "TAX_ID_MATCHED", "WATCHLIST_CLEAR" ], "title": "BusinessKybCheckKey", "type": "string" }, "v1.BusinessKybCheckResponse": { "description": "One line of the business verification card.", "properties": { "key": { "$ref": "#/components/schemas/v1.BusinessKybCheckKey", "description": "Which check." }, "result": { "$ref": "#/components/schemas/v1.BusinessKybCheckResult", "description": "PASSED or FAILED; NOT_RUN when the check produced no evidence either way, never a failure." } }, "required": [ "key", "result" ], "title": "BusinessKybCheckResponse (v1)", "type": "object" }, "v1.BusinessKybCheckResult": { "description": "A check's result; NOT_RUN is no evidence either way, never a failure.", "enum": [ "PASSED", "FAILED", "NOT_RUN" ], "title": "BusinessKybCheckResult", "type": "string" }, "v1.BusinessKybOutcome": { "description": "What the organization's latest confirmation concluded about a business.\n\nTwo values only: a listed business always has a KYB match behind its\nreference, so a check that never finished (stored NULL) is NOT_VERIFIED\nwith ``BusinessNotVerifiedReason.VerificationIncomplete``, not a third\noutcome.", "enum": [ "VERIFIED", "NOT_VERIFIED" ], "title": "BusinessKybOutcome", "type": "string" }, "v1.BusinessNotVerifiedReason": { "description": "Why a NOT_VERIFIED business is not verified, when it is not plain\nfailure.", "enum": [ "VERIFICATION_INCOMPLETE" ], "title": "BusinessNotVerifiedReason", "type": "string" }, "v1.BusinessOperatorLinkResponse": { "description": "One person the calling organization holds an operator link for — the\nmirror of the person profile's business links.", "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": [ { "format": "uuid", "type": "string" }, { "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" }, "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": "Display Name" } }, "required": [ "status", "created_at", "individual_ref" ], "title": "BusinessOperatorLinkResponse (v1)", "type": "object" }, "v1.CredentialSummaryResponse": { "description": "This organization's agent credentials for a business, or for a person\ncounting the business credentials they acted for, counted.", "properties": { "issued_30d": { "description": "Agent credentials issued in the last 30 days.", "title": "Issued 30D", "type": "integer" }, "active": { "description": "Agent credentials neither revoked nor expired.", "title": "Active", "type": "integer" }, "revoked_30d": { "description": "Agent credentials revoked in the last 30 days.", "title": "Revoked 30D", "type": "integer" } }, "required": [ "issued_30d", "active", "revoked_30d" ], "title": "CredentialSummaryResponse (v1)", "type": "object" }, "v1.IdentitySubmissionHistoryItemResponse": { "description": "One verification attempt in a profile's submission history, direct or\nhosted, reduced to the row a history timeline renders.", "properties": { "verification_id": { "description": "Id of the verification. 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}`.", "format": "uuid", "title": "Verification Id", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.VerificationState", "description": "Lifecycle state of the verification workflow." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/v1.OnboardingVerdict" }, { "type": "null" } ], "default": null, "description": "Resolved onboarding verdict; null until completion." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied correlation id.", "title": "Reference Id" }, "created_at": { "description": "When the submission was accepted.", "format": "date-time", "title": "Created At", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the workflow reached a terminal state.", "title": "Completed At" }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "default": null, "description": "Typed state and detail when the workflow ended in FAILED; null otherwise." }, "journey_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of this organization's journey the session ran; null for a session started through the API.", "title": "Journey Name" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who decided the session on review, as they were named when they decided; null when it was decided automatically." } }, "required": [ "verification_id", "state", "created_at" ], "title": "IdentitySubmissionHistoryItemResponse (v1)", "type": "object" }, "v1.IdentitySubmissionTerminalReasonResponse": { "description": "Typed explanation for a submission that did not complete.", "properties": { "state": { "$ref": "#/components/schemas/v1.TerminalReasonState", "description": "Terminal workflow state." }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable detail recorded by the workflow.", "title": "Message" } }, "required": [ "state" ], "title": "IdentitySubmissionTerminalReasonResponse (v1)", "type": "object" }, "v1.SOSStatus": { "enum": [ "GOOD_STANDING", "NOT_GOOD_STANDING", "SS", "FD" ], "title": "SOSStatus", "type": "string" }, "v1.TerminalReasonState": { "description": "The terminal state a ``terminal_reason`` explains: only a failure\ncarries one.", "enum": [ "FAILED" ], "title": "TerminalReasonState", "type": "string" }, "v1.VerificationState": { "description": "A verification's lifecycle as a customer reads it: the workflow's\nstates, with an internal stop reported as ``FAILED``.", "enum": [ "PENDING", "EXECUTING", "WAITING", "COMPLETED", "FAILED", "EXPIRED" ], "title": "VerificationState", "type": "string" }, "v1.BusinessOperatorLinkDecision": { "description": "An organization's manual decision on its operator link.\n\nDeliberately narrower than the status vocabulary: UnderReview is the\nabsence of a decision, so a decision can only verify or reject.", "enum": [ "VERIFIED", "REJECTED" ], "title": "BusinessOperatorLinkDecision", "type": "string" }, "v1.BusinessIdentityPayload": { "additionalProperties": false, "description": "The business a customer asserts the individual operates.\n\nExactly the ``POST /searches`` input surface — the submission backs a\nKYB BusinessSearch, so it accepts every lookup input that route does,\nwith the same names and validation. Note the operator link can only\nauto-verify when a ``tin`` is supplied and the IRS confirms it; without\none, KYB runs registry verification alone.", "properties": { "name": { "description": "The name of the business to search for.", "examples": [ "White, Floyd and Cook" ], "maxLength": 500, "minLength": 1, "title": "Name", "type": "string" }, "address": { "description": "The address of the business to search for.", "examples": [ "155 Carla Circles Jordanfurt, OK 59066" ], "maxLength": 500, "minLength": 2, "title": "Address", "type": "string" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The officer names to include in the search.", "examples": [ [ "Nathan Harrington", "Alexander Wolfe" ] ], "title": "Officer Names" }, "website": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The website to include in the search.", "examples": [ "https://www.figueroa.com/" ], "title": "Website" }, "phone_number": { "anyOf": [ { "maxLength": 24, "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number to include in the search.", "examples": [ "436-502-9710" ], "title": "Phone Number" }, "email": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "default": null, "description": "The email to include in the search.", "examples": [ "zacharymoore@example.com" ], "title": "Email" }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "default": null, "description": "The alternative names to include in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ], "title": "Alternative Names" }, "tin": { "anyOf": [ { "maxLength": 9, "minLength": 9, "type": "string" }, { "type": "null" } ], "default": null, "description": "The TIN/EIN to search for.", "examples": [ "732842774" ], "title": "Tin" } }, "required": [ "name", "address" ], "title": "BusinessIdentityPayload (v1)", "type": "object" }, "v1.BusinessVerificationRequest": { "additionalProperties": false, "description": "Verifies an individual together with the business they operate.", "properties": { "type": { "const": "BUSINESS", "description": "`BUSINESS` verifies `individual` together with `business` and the link between them.", "title": "Type", "type": "string" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied correlation id.", "title": "Reference Id" }, "individual": { "$ref": "#/components/schemas/v1.IndividualIdentityPayload", "description": "The individual who operates the business." }, "business": { "$ref": "#/components/schemas/v1.BusinessIdentityPayload", "description": "The business the individual operates." } }, "required": [ "type", "individual", "business" ], "title": "BusinessVerificationRequest (v1)", "type": "object" }, "v1.IndividualIdentityPayload": { "additionalProperties": false, "description": "The identity of an individual you collected, for verification.", "properties": { "first_name": { "description": "Legal first name.", "maxLength": 128, "minLength": 1, "title": "First Name", "type": "string" }, "middle_name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Legal middle name, if any.", "title": "Middle Name" }, "last_name": { "description": "Legal last name.", "maxLength": 128, "minLength": 1, "title": "Last Name", "type": "string" }, "dob": { "description": "Date of birth (YYYY-MM-DD).", "format": "date", "title": "Dob", "type": "string" }, "phone_number": { "description": "Phone number in E.164 format.", "pattern": "^\\+[1-9]\\d{1,14}$", "title": "Phone Number", "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address, if collected.", "title": "Email" }, "address": { "description": "Residential address as a single line; normalized server-side before verification.", "examples": [ "1640 Riverside Drive, Hill Valley, CA 95420" ], "maxLength": 500, "minLength": 2, "title": "Address", "type": "string" }, "national_id": { "description": "US national id (SSN), nine digits; separators are accepted and stripped. Required: identity continuity is anchored on it, and a submission without one could never earn a individual_ref.", "title": "National Id", "type": "string" } }, "required": [ "first_name", "last_name", "dob", "phone_number", "address", "national_id" ], "title": "IndividualIdentityPayload (v1)", "type": "object" }, "v1.IndividualVerificationRequest": { "additionalProperties": false, "description": "Verifies an individual you collected.", "properties": { "type": { "const": "INDIVIDUAL", "description": "`INDIVIDUAL` verifies the individual alone.", "title": "Type", "type": "string" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied correlation id.", "title": "Reference Id" }, "individual": { "$ref": "#/components/schemas/v1.IndividualIdentityPayload", "description": "The identity to verify." } }, "required": [ "type", "individual" ], "title": "IndividualVerificationRequest (v1)", "type": "object" }, "v1.IdentityListBusinessResponse": { "description": "One business a person in the list operates, as the row names it.", "properties": { "business_ref": { "description": "Pairwise reference to the linked business.", "title": "Business Ref", "type": "string" }, "legal_name": { "description": "The linked business's current legal name.", "title": "Legal Name", "type": "string" }, "status": { "$ref": "#/components/schemas/v1.BusinessOperatorLinkStatus", "description": "VERIFIED (linked) or UNDER_REVIEW (a link request); rejected links are never listed." } }, "required": [ "business_ref", "legal_name", "status" ], "title": "IdentityListBusinessResponse (v1)", "type": "object" }, "v1.IdentityVerificationState": { "description": "Verification state of an identity, as seen by the referencing\norganization.\n\nCURRENT: an unexpired verification exists and credentials can be\nminted. EXPIRED: the verification's validity window has lapsed —\nre-verify before minting. SUPERSEDED: no active verification record\nremains; a new submission is required.", "enum": [ "CURRENT", "EXPIRED", "SUPERSEDED" ], "title": "IdentityVerificationState", "type": "string" }, "v1.ActiveCredentialResponse": { "description": "One agent credential that is neither revoked nor expired.", "properties": { "credential_id": { "description": "The credential's unique id: exactly the `jti` its token carries.", "title": "Credential Id", "type": "string" }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "description": "The kind of agent credential issued." }, "audience": { "description": "The relying party the credential was minted for.", "title": "Audience", "type": "string" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "description": "The use case an L3 credential was minted for; null for an L2, or for an L3 whose caller listed its own disclosure fields." }, "issued_at": { "description": "When the credential was issued.", "format": "date-time", "title": "Issued At", "type": "string" }, "expires_at": { "description": "When the credential expires.", "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "credential_id", "level", "audience", "preset", "issued_at", "expires_at" ], "title": "ActiveCredentialResponse (v1)", "type": "object" }, "v1.IdentityBusinessLinkResponse": { "description": "One business the calling organization holds an operator link for.", "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": [ { "format": "uuid", "type": "string" }, { "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" }, "business_ref": { "description": "Pairwise reference to the linked business.", "title": "Business Ref", "type": "string" }, "legal_name": { "description": "The linked business's current legal name.", "title": "Legal Name", "type": "string" } }, "required": [ "status", "created_at", "business_ref", "legal_name" ], "title": "IdentityBusinessLinkResponse (v1)", "type": "object" }, "v1.IdentityVerificationHistoryItemResponse": { "description": "One superseded verification in a profile's lineage.\n\nDates only: a superseded snapshot's identity fields are history the\ndirectory never re-discloses — the row exists so the profile can show\nwhen the person was verified before and when each verification was\nreplaced.", "properties": { "verified_at": { "description": "When this verification was recorded.", "format": "date-time", "title": "Verified At", "type": "string" }, "superseded_at": { "description": "When a newer verification replaced this one.", "format": "date-time", "title": "Superseded At", "type": "string" }, "expires_at": { "description": "When this verification would have expired.", "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "verified_at", "superseded_at", "expires_at" ], "title": "IdentityVerificationHistoryItemResponse (v1)", "type": "object" }, "v1.BusinessOperatorLinkShortfall": { "description": "Which leg of the operator-link evidence recipe a covering evaluation\nfailed.\n\nReviewer-facing: a session whose evaluation reports any shortfall records\nan UNDER_REVIEW link, and these name what a reviewer would be overriding\nby verifying it anyway. An evaluation that reports none earns VERIFIED on\nits own.", "enum": [ "TIN_NOT_PROVIDED", "TIN_NOT_MATCHED", "KYB_NOT_VERIFIED" ], "title": "BusinessOperatorLinkShortfall", "type": "string" }, "v1.OperatorLinkEvidenceResponse": { "description": "The evaluation a credential minted for the pair now would assert and\nbe dated by.", "properties": { "tin_provided": { "description": "Whether a tax ID was collected.", "title": "Tin Provided", "type": "boolean" }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the IRS matched the tax ID to the business; null when it gave no answer.", "title": "Tin Matched" }, "kyb_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the registry verified the business; null when the check gave no answer.", "title": "Kyb Verified" }, "officer_match": { "$ref": "#/components/schemas/v1.OperatorLinkOfficerMatch", "description": "How the individual's name compared to the registry's officers. Supporting evidence, never a reason on its own: some states don't list officers (`NOT_EVALUATED`)." }, "matched_officer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The registry officer who matched.", "title": "Matched Officer Name" }, "matched_officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "That officer's registered title.", "title": "Matched Officer Title" }, "evaluated_at": { "description": "When the evaluation's last check finished.", "format": "date-time", "title": "Evaluated At", "type": "string" } }, "required": [ "tin_provided", "officer_match", "evaluated_at" ], "title": "OperatorLinkEvidenceResponse (v1)", "type": "object" }, "v1.OperatorLinkOfficerMatch": { "description": "How the person's name compared to the registry's officers, as a\nreviewer reads it. ``NOT_EVALUATED`` covers a registry that lists no\nofficers, which many states don't.", "enum": [ "EXACT", "PARTIAL", "NONE", "NOT_EVALUATED" ], "title": "OperatorLinkOfficerMatch", "type": "string" }, "v1.InternationalAddressMatchType": { "enum": [ "NO_MATCH", "REGION", "CITY", "COUNTRY", "EXACT" ], "title": "InternationalAddressMatchType", "type": "string" }, "v1.InternationalAddressSummaryResponse": { "properties": { "premise": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Alphanumeric code for the location (e.g., building number).", "examples": [ "221B" ], "title": "Premise" }, "thoroughfare": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Complete street name.", "examples": [ "Baker Street" ], "title": "Thoroughfare" }, "dependent_thoroughfare": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Secondary street name or cross street.", "examples": [ "Marylebone Road" ], "title": "Dependent Thoroughfare" }, "locality": { "description": "Most common population center (e.g., city name).", "examples": [ "London" ], "title": "Locality", "type": "string" }, "dependent_locality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Additional locality information (e.g., neighborhood, district).", "examples": [ "Westminster" ], "title": "Dependent Locality" }, "administrative_area": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Most common administrative division (e.g., province, state, region).", "examples": [ "England" ], "title": "Administrative Area" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Complete postal code.", "examples": [ "NW1 6XE" ], "title": "Postal Code" }, "country_iso_3": { "description": "ISO 3166-1 alpha-3 country code (e.g., 'CAN', 'GBR', 'AUS').", "examples": [ "GBR" ], "maxLength": 3, "minLength": 3, "title": "Country Iso 3", "type": "string" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Latitude coordinate of the address.", "examples": [ 51.5237 ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Longitude coordinate of the address.", "examples": [ -0.1585 ], "title": "Longitude" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-provided address type, e.g. Registered Office, Principal Place of Business, or SAIL.", "examples": [ "Registered Office" ], "title": "Type" }, "full_address": { "description": "Return the complete formatted address for display.", "readOnly": true, "title": "Full Address", "type": "string" } }, "required": [ "locality", "country_iso_3", "full_address" ], "title": "InternationalAddressSummaryResponse (v1)", "type": "object" }, "v1.InternationalBeneficialOwner": { "description": "An ultimate beneficial owner of an international business (enhanced profile).", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name.", "title": "Name" }, "entity_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOrPersonType" }, { "type": "null" } ], "default": null, "description": "Whether this party is a business or a person. Null when the registry does not classify the party as either." }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month.", "title": "Date Of Birth" }, "nationality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Nationality of the party when the party is a person.", "title": "Nationality" }, "place_of_residence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of residence of the party when the party is a person, as a single formatted address string.", "title": "Place Of Residence" }, "place_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of birth of the party when the party is a person, as a single formatted address string.", "title": "Place Of Birth" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correspondence or registered address of the party, as a single formatted address string.", "title": "Address" }, "id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry).", "title": "Id Number" }, "registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company registration number of the party when the party is itself a corporation. Null for individual parties.", "title": "Registration Number" }, "nature_of_control": { "description": "How the owner exercises control over the business, as described by the registry (e.g. ownership-of-shares or voting-rights statements).", "items": { "type": "string" }, "title": "Nature Of Control", "type": "array" }, "notified_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date the registry was notified of the beneficial ownership.", "title": "Notified Date" }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The registry's classification of the beneficial owner (e.g. its person-with-significant-control kind).", "title": "Kind" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date the beneficial ownership began.", "title": "Start Date" } }, "title": "InternationalBeneficialOwner", "type": "object" }, "v1.InternationalBusinessActivity": { "description": "A classified business activity (e.g. SIC / NACE) for an international business.", "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Classification code for the activity (e.g. a SIC or NACE code). Null when the registry files the activity as a free-text declaration rather than a coded classification.", "title": "Code" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable description of the business activity.", "title": "Description" } }, "title": "InternationalBusinessActivity", "type": "object" }, "v1.InternationalBusinessResponse": { "properties": { "name": { "description": "The name of the international business.", "examples": [ "Acme Corporation" ], "title": "Name", "type": "string" }, "file_number": { "description": "The file number of the registration.", "examples": [ "867124" ], "title": "File Number", "type": "string" }, "status": { "$ref": "#/components/schemas/v1.CorporateRegistrationStatus", "description": "Status field indicating whether the corporate registration filing is active or inactive.", "examples": [ "active", "inactive", "unknown" ] }, "standing": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The registry's own status wording behind the coarse `status` (e.g. 'Registered', 'In Liquidation').", "examples": [ "Registered" ], "title": "Standing" }, "legal_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The registry's legal form / legal structure for the business (e.g. 'ltd', 'gmbh').", "examples": [ "ltd" ], "title": "Legal Form" }, "country": { "$ref": "#/components/schemas/v1.InternationalSearchISO2CountryCode", "description": "The country of the international business.", "examples": [ "GB" ] }, "issue_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the registration was issued.", "examples": [ "2024-01-01" ], "title": "Issue Date" }, "incorporation_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the international business was incorporated. Often the same as the issue date.", "examples": [ "2024-01-01" ], "title": "Incorporation Date" }, "last_annual_account_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of the business's most recent annual account filing (a data-freshness signal).", "examples": [ "2024-01-01" ], "title": "Last Annual Account Date" }, "dissolution_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the business was dissolved, when the registry provides it. Populated only when the enhanced profile add-on was ordered.", "examples": [ "2024-01-01" ], "title": "Dissolution Date" }, "dissolved": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the registry data indicates the business is dissolved.", "examples": [ false ], "title": "Dissolved" }, "registration_authority": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry authority name, e.g. Companies House, United Kingdom.", "examples": [ "Companies House, United Kingdom" ], "title": "Registration Authority" }, "registration_authority_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry authority code where provided, e.g. CA-ON or CA-FE.", "examples": [ "CA-ON" ], "title": "Registration Authority Code" }, "registration_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-provided registration type, e.g. Federal, Extra-Provincial, or Registered society.", "examples": [ "Federal" ], "title": "Registration Type" }, "registry_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-provided entity or registry type where distinct from legal form.", "examples": [ "Registered society" ], "title": "Registry Type" }, "addresses": { "default": [], "description": "The addresses of the international business.", "examples": [ { "administrative_area": "CA", "country_iso_3": "USA", "dependent_locality": null, "dependent_thoroughfare": null, "full_address": "123, Main St, Anytown, CA, 12345, USA", "latitude": 37.7749, "locality": "Anytown", "longitude": -122.4194, "postal_code": "12345", "premise": "123", "thoroughfare": "Main St", "type": null } ], "items": { "$ref": "#/components/schemas/v1.InternationalAddressSummaryResponse" }, "title": "Addresses", "type": "array" }, "alternative_names": { "description": "A list of alternative names (e.g. DBAs, trading names, and former registered names) found associated with the business entity.", "examples": [ [ "Ramos, Garcia and Good" ] ], "items": { "type": "string" }, "title": "Alternative Names", "type": "array" }, "officers": { "description": "Directors and officers of the business. Populated only when the enhanced profile add-on was ordered.", "items": { "$ref": "#/components/schemas/v1.InternationalOfficer" }, "title": "Officers", "type": "array" }, "beneficial_owners": { "description": "Ultimate beneficial owners of the business from structured UBO filings, plus registry role-based ownership signals such as Australian Ultimate Holding Company representatives. Populated only when the enhanced profile add-on was ordered.", "items": { "$ref": "#/components/schemas/v1.InternationalBeneficialOwner" }, "title": "Beneficial Owners", "type": "array" }, "shareholders": { "description": "Shareholders of the business. Populated only when the enhanced profile add-on was ordered.", "items": { "$ref": "#/components/schemas/v1.InternationalShareholder" }, "title": "Shareholders", "type": "array" }, "share_capital": { "description": "Share capital structure of the business. Populated only when the enhanced profile add-on was ordered.", "items": { "$ref": "#/components/schemas/v1.InternationalShareCapital" }, "title": "Share Capital", "type": "array" }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalCompanyContact" }, { "type": "null" } ], "default": null, "description": "Contact details for the business. Populated only when the enhanced profile add-on was ordered." }, "identifiers": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalCompanyIdentifiers" }, { "type": "null" } ], "default": null, "description": "Additional registry and tax identifiers beyond the top-level file number. Fully populated only when the enhanced profile add-on was ordered." }, "activities": { "description": "Classified business activities (e.g. SIC / NACE codes) for the business. Fully populated only when the enhanced profile add-on was ordered.", "items": { "$ref": "#/components/schemas/v1.InternationalBusinessActivity" }, "title": "Activities", "type": "array" }, "registered_agent": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalRegisteredAgent" }, { "type": "null" } ], "default": null, "description": "The registered agent listed for the business. Populated only when the enhanced profile add-on was ordered." } }, "required": [ "name", "file_number", "status", "country" ], "title": "InternationalBusinessResponse (v1)", "type": "object" }, "v1.InternationalCompanyContact": { "description": "Contact details for an international business (enhanced profile).", "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact email address on file for the business.", "title": "Email" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Contact telephone number on file for the business.", "title": "Phone" }, "fax": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Fax number on file for the business.", "title": "Fax" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Website on file for the business.", "title": "Website" } }, "title": "InternationalCompanyContact", "type": "object" }, "v1.InternationalCompanyIdentifiers": { "description": "Extra registry and tax identifiers for an international business.\n\nThe primary registration number is the top-level ``file_number``; these are\nthe *additional* identifiers (tax id, secondary registration number, and any\nother registry-specific identifiers), enriched by the enhanced profile add-on.", "properties": { "tax_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tax identifier registered for the business (e.g. VAT or other national tax number), where the registry provides one.", "title": "Tax Id" }, "secondary_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "An additional registration number distinct from the primary file number, where the registry provides one.", "title": "Secondary Registration Number" }, "other_identifiers": { "description": "Any further registry-specific identifiers associated with the business.", "items": { "type": "string" }, "title": "Other Identifiers", "type": "array" } }, "title": "InternationalCompanyIdentifiers", "type": "object" }, "v1.InternationalOfficer": { "description": "A director or officer of an international business (enhanced profile).", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name.", "title": "Name" }, "entity_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOrPersonType" }, { "type": "null" } ], "default": null, "description": "Whether this party is a business or a person. Null when the registry does not classify the party as either." }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month.", "title": "Date Of Birth" }, "nationality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Nationality of the party when the party is a person.", "title": "Nationality" }, "place_of_residence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of residence of the party when the party is a person, as a single formatted address string.", "title": "Place Of Residence" }, "place_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of birth of the party when the party is a person, as a single formatted address string.", "title": "Place Of Birth" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correspondence or registered address of the party, as a single formatted address string.", "title": "Address" }, "id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry).", "title": "Id Number" }, "registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company registration number of the party when the party is itself a corporation. Null for individual parties.", "title": "Registration Number" }, "titles": { "description": "The officer's role titles at this business (e.g. \"Director\", \"Secretary\").", "items": { "type": "string" }, "title": "Titles", "type": "array" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the officer's appointment is currently active.", "title": "Is Active" }, "powers": { "description": "Powers or authorities granted to the officer, as described by the registry (e.g. authority to represent the company).", "items": { "type": "string" }, "title": "Powers", "type": "array" }, "start_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date the officer's appointment began.", "title": "Start Date" }, "end_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date the officer's appointment ended, if it is no longer active.", "title": "End Date" }, "directorships": { "description": "Other companies at which this officer holds or held a role, when the registry discloses them.", "items": { "$ref": "#/components/schemas/v1.InternationalOfficerDirectorship" }, "title": "Directorships", "type": "array" } }, "title": "InternationalOfficer", "type": "object" }, "v1.InternationalOfficerDirectorship": { "description": "Another company at which an officer holds (or held) a role (enhanced profile).", "properties": { "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the other company at which the officer holds or held a role.", "title": "Company Name" }, "company_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registration number of that other company in its home registry.", "title": "Company Number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The officer's role at that other company (e.g. \"Director\").", "title": "Title" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the officer's role at that other company is currently active.", "title": "Is Active" } }, "title": "InternationalOfficerDirectorship", "type": "object" }, "v1.InternationalRegisteredAgent": { "description": "The registered agent listed for an international business (enhanced profile).", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the registered agent listed for the business.", "title": "Name" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Address of the registered agent, as a single formatted address string.", "title": "Address" } }, "title": "InternationalRegisteredAgent", "type": "object" }, "v1.InternationalSearchISO2CountryCode": { "description": "Enumeration of ISO 3166-1 alpha-2 country codes supported for international searches.\n\nThis is a subset of ISO2CountryCode that includes only jurisdictions where\ninternational search capabilities are available.", "enum": [ "AR", "AU", "AT", "BH", "BE", "BA", "BR", "BN", "KH", "CA", "CN", "CO", "HR", "CW", "CY", "CZ", "DK", "DO", "EE", "FI", "FR", "GF", "PF", "GE", "DE", "GI", "GR", "GP", "GG", "HK", "IS", "IN", "IE", "IM", "IL", "IT", "JP", "KE", "LV", "LI", "LT", "LU", "MY", "MH", "MQ", "YT", "MX", "ME", "NL", "NC", "NZ", "NG", "NO", "OM", "PK", "PA", "PE", "PL", "PT", "QA", "RE", "RO", "RU", "BL", "PM", "WS", "SA", "SG", "SK", "SI", "SB", "ES", "SE", "CH", "TW", "TT", "TR", "UG", "UA", "GB", "UY", "VI", "VU", "WF" ], "title": "InternationalSearchISO2CountryCode", "type": "string" }, "v1.InternationalShareCapital": { "description": "A class of share capital of an international business (enhanced profile).", "properties": { "class_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry code identifying the share class.", "title": "Class Code" }, "class_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable description of the share class (e.g. \"Ordinary\").", "title": "Class Description" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Number of shares issued in this class.", "title": "Quantity" }, "unit_nominal_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Nominal (face) value of a single share in this class.", "title": "Unit Nominal Value" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Currency in which the share values for this class are denominated.", "title": "Currency" }, "total_nominal_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Total nominal (face) value of all shares issued in this class.", "title": "Total Nominal Value" }, "voting_rights": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Voting rights attached to shares in this class, as described by the registry.", "title": "Voting Rights" } }, "title": "InternationalShareCapital", "type": "object" }, "v1.InternationalShareholder": { "description": "A shareholder of an international business (enhanced profile).", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name.", "title": "Name" }, "entity_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOrPersonType" }, { "type": "null" } ], "default": null, "description": "Whether this party is a business or a person. Null when the registry does not classify the party as either." }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month.", "title": "Date Of Birth" }, "nationality": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Nationality of the party when the party is a person.", "title": "Nationality" }, "place_of_residence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of residence of the party when the party is a person, as a single formatted address string.", "title": "Place Of Residence" }, "place_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Place of birth of the party when the party is a person, as a single formatted address string.", "title": "Place Of Birth" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Correspondence or registered address of the party, as a single formatted address string.", "title": "Address" }, "id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry).", "title": "Id Number" }, "registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company registration number of the party when the party is itself a corporation. Null for individual parties.", "title": "Registration Number" }, "percentage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Percentage of the share class held, as a string exactly as provided by the registry (e.g. \"50.0\").", "title": "Percentage" }, "share_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Number of shares held by the shareholder.", "title": "Share Count" }, "total_nominal_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Total nominal (face) value of the shares held by the shareholder.", "title": "Total Nominal Value" }, "share_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the class of shares held (e.g. \"Ordinary\").", "title": "Share Class" }, "beneficially_held": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the shares are held beneficially (for the shareholder's own benefit) rather than on behalf of another party.", "title": "Beneficially Held" } }, "title": "InternationalShareholder", "type": "object" }, "v1.LienAmendmentResponse": { "description": "Represents a change or update to a lien filing, such as a continuation,\ntermination, or assignment that affects the lien's validity or terms.", "properties": { "filing_number": { "description": "The document filing number.", "examples": [ "H76162" ], "title": "Filing Number", "type": "string" }, "filing_type": { "description": "The document filing type.", "examples": [ "Notarized Letter" ], "title": "Filing Type", "type": "string" }, "filing_date": { "description": "The date of the lien filing.", "examples": [ "2023-11-27" ], "format": "date", "title": "Filing Date", "type": "string" }, "number_of_pages": { "description": "Number of image pages in the library for this filing number.", "examples": [ 4 ], "title": "Number Of Pages", "type": "integer" } }, "required": [ "filing_number", "filing_type", "filing_date", "number_of_pages" ], "title": "LienAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingAlternativeNameDesignation": { "enum": [ "AGLIEN", "BAILEE_BAILOR", "CONSIGNEE_CONSIGNOR", "LESSEE_LESSOR", "NON_UCC_FILING", "SELLER_BUYER", "LICENSEE", "DEBTOR_SECURED_PARTY" ], "title": "LienFilingAlternativeNameDesignation", "type": "string" }, "v1.LienFilingAlternativeType": { "enum": [ "TRANSMITTING_UTILITY", "MANUFACTURED_HOME", "PUBLIC_FINANCE", "NOT_APPLICABLE" ], "title": "LienFilingAlternativeType", "type": "string" }, "v1.LienFilingAssignedBusinessDebtorPartyResponse": { "description": "Represents the response structure for an assigned business debtor party in a lien filing.\n\nThis model includes details about the business entity acting as a debtor,\nsuch as its unique identifier, organizational information, and mailing address.\nIt also incorporates additional response-specific fields like the party's ID.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "organization_name": { "anyOf": [ { "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ], "maxLength": 128, "title": "Organization Name", "type": "string" }, { "description": "No organization name is provided for the party.", "title": "No Organization Name", "type": "null" } ], "default": null, "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure", "description": "The type of organization involved in the lien filing, if applicable.", "title": "Organization Type" }, { "description": "No organization type is provided for the party.", "title": "No Organization Type", "type": "null" } ], "default": null, "title": "Organization Type" }, "type": { "const": "ORGANIZATION", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.", "title": "Organization Party Type", "type": "string" }, "capacity": { "$ref": "#/components/schemas/v1.LienPartyDebtorCapacity", "default": "NONE_OF_THE_ABOVE", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "title": "Lien Debtor Capacity" }, "business_id": { "description": "A unique identifier assigned to the business entity (debtor) involved in the lien filing process.", "format": "uuid", "title": "Business ID", "type": "string" }, "role": { "const": "Debtor", "default": "Debtor", "description": "Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien.", "title": "Debtor Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingAssignedBusinessDebtorPartyResponse (v1)", "type": "object" }, "v1.LienFilingAssignedPersonDebtorPartyResponse": { "description": "Represents the response structure for an assigned person debtor party in a lien filing.\n\nThis model includes details about the person acting as a debtor,\nsuch as its unique identifier, organizational information, and mailing address.\nIt also incorporates additional response-specific fields like the party's ID.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "suffix": { "anyOf": [ { "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ], "maxLength": 16, "title": "Individual Suffix", "type": "string" }, { "description": "No suffix is provided for the individual.", "title": "No Suffix", "type": "null" } ], "default": null, "title": "Suffix" }, "last_name": { "anyOf": [ { "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ], "maxLength": 16, "title": "Individual Last Name", "type": "string" }, { "description": "No last name is provided for the individual.", "title": "No Last Name", "type": "null" } ], "default": null, "title": "Last Name" }, "first_name": { "anyOf": [ { "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ], "maxLength": 16, "title": "Individual First Name", "type": "string" }, { "description": "No first name is provided for the individual.", "title": "No First Name", "type": "null" } ], "default": null, "title": "First Name" }, "middle_name": { "anyOf": [ { "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ], "maxLength": 16, "title": "Individual Middle Name", "type": "string" }, { "description": "No middle name is provided for the individual.", "title": "No Middle Name", "type": "null" } ], "default": null, "title": "Middle Name" }, "type": { "const": "INDIVIDUAL", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity.", "title": "Individual Party Type", "type": "string" }, "capacity": { "$ref": "#/components/schemas/v1.LienPartyDebtorCapacity", "default": "NONE_OF_THE_ABOVE", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "title": "Lien Debtor Capacity" }, "person_id": { "description": "A unique identifier assigned to the individual (debtor) involved in the lien filing process.", "format": "uuid", "title": "Person ID", "type": "string" }, "role": { "const": "Debtor", "default": "Debtor", "description": "Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien.", "title": "Debtor Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingAssignedPersonDebtorPartyResponse (v1)", "type": "object" }, "v1.LienFilingAttachment": { "description": "Part of the lien filing submission response and /attachments management endpoints.\nThis is included in the response when filing a lien with attachments or managing attachment files.", "properties": { "id": { "description": "The unique identifier of the lien filing attachment.", "format": "uuid", "title": "Attachment ID", "type": "string" }, "document_filename": { "description": "The filename of the document associated with this lien filing attachment.", "examples": [ "lien_document.pdf", "attachment_001.pdf", "contract_agreement.pdf" ], "maxLength": 256, "title": "Attachment Filename", "type": "string" } }, "required": [ "id", "document_filename" ], "title": "LienFilingAttachment (v1)", "type": "object" }, "v1.LienFilingCollateralAmendmentType": { "description": "Enum representing the types of amendments that can be made to collateral in a lien filing.\n\nThis enum defines the possible actions that can be taken when amending\ninformation about collateral in a lien filing.", "enum": [ "ADD", "RESTATE", "DELETE" ], "title": "LienFilingCollateralAmendmentType", "type": "string" }, "v1.LienFilingCollateralStatementAttachmentsResponse": { "description": "This model represents a collateral statement for a lien filing that includes\none or more attachments (PDF documents), to provide additional details\nor evidence related to the collateral. Each attachment is identified by a unique\nID and has an associated filename.", "properties": { "collateral_statement_designation": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementDesignation", "description": "The designation of the collateral statement, indicating the nature of the collateral as either having no special designation, being managed within a trust arrangement, or administered by the personal representative of a deceased individual.", "title": "Collateral Statement Designation" }, { "description": "When updating the field with `null`, it will respect the existing server value for the `collateral_statement_designation` field of the filing document, causing no changes to this field.", "title": "Collateral Statement Designation Omitted", "type": "null" } ], "default": null, "title": "Collateral Statement Designation" }, "attachments": { "default": [], "description": "A list of PDF filenames as attachments.", "examples": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "864751ff-dd5e-466a-a615-2c49f152e0e4" } ], "items": { "$ref": "#/components/schemas/v1.LienFilingAttachment" }, "title": "Attachments", "type": "array" }, "type": { "const": "ATTACHMENTS", "description": "When using this type this structure represents a collateral statement for a lien filing that includes one or more attachments (PDF documents), to provide additional details or evidence related to the collateral. Each attachment is identified by a unique ID and has an associated filename.", "title": "Type of Collateral Statement", "type": "string" } }, "required": [ "type" ], "title": "LienFilingCollateralStatementAttachmentsResponse (v1)", "type": "object" }, "v1.LienFilingCollateralStatementDesignation": { "description": "Enumeration of possible designations for a lien collateral statement.", "enum": [ "NONE", "TRUST", "PERSONAL_REPRESENTATIVE" ], "title": "LienFilingCollateralStatementDesignation", "type": "string" }, "v1.LienFilingCollateralStatementText": { "description": "This structure represents the schema for a collateral statement in the form of text\nprovided for a lien filing submission.", "properties": { "collateral_statement_designation": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementDesignation", "description": "The designation of the collateral statement, indicating the nature of the collateral as either having no special designation, being managed within a trust arrangement, or administered by the personal representative of a deceased individual.", "title": "Collateral Statement Designation" }, { "description": "When updating the field with `null`, it will respect the existing server value for the `collateral_statement_designation` field of the filing document, causing no changes to this field.", "title": "Collateral Statement Designation Omitted", "type": "null" } ], "default": null, "title": "Collateral Statement Designation" }, "text": { "anyOf": [ { "description": "A plain text description of the collateral.", "examples": [ "Commercial real estate located at 123 Business Blvd, Tech City, TX", "Inventory of electronics including laptops, smartphones, and tablets", "Fleet of delivery vehicles comprising 5 trucks and 10 vans", "Patents and intellectual property rights related to cybersecurity software" ], "title": "Collateral Description Text", "type": "string" }, { "description": "When updating the field with `null`, it will respect the existing server value for the `text` field of the filing document, causing no changes to this field.", "title": "Collateral Description Text Omitted", "type": "null" } ], "default": null, "title": "Text" }, "type": { "const": "TEXT", "description": "When using this type, the structure represents the schema for a collateral statement in the form of text provided for a lien filing submission. Setting the `\"type\":\"TEXT\"` will remove all previously uploaded attachments for this lien filing submission.", "title": "Type of Collateral Statement", "type": "string" } }, "required": [ "type" ], "title": "LienFilingCollateralStatementText (v1)", "type": "object" }, "v1.LienFilingCreatedWebhook_LienFilingSubmissionImportedResponse": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.created", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "filing_type": { "const": "UCC1", "default": "UCC1", "description": "Initial financing statement, which is the filing an imported lien is identified by.", "title": "Filing Type", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the jurisdiction the lien is filed in.", "examples": [ "IL" ], "title": "Jurisdiction State" }, "status": { "$ref": "#/components/schemas/v1.LienFilingStatus", "description": "The lien's standing in the public record, derived from its amendment history and lapse date (UCC §9-515).", "examples": [ "Active" ], "title": "Lien Status" }, "imported_unverified": { "default": false, "description": "Whether this filing is held from the details the caller supplied rather than verified against the public record. Its status, dates and parties are the caller's own claim, estimated under UCC §9-515 where the public record would otherwise answer.", "examples": [ false ], "title": "Unverified Import", "type": "boolean" }, "debtors": { "description": "The debtors recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "title": "Debtors", "type": "array" }, "secured_parties": { "description": "The secured parties recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "title": "Secured Parties", "type": "array" }, "amendments": { "description": "The continuations, terminations, assignments and other amendments recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienAmendmentResponse" }, "title": "Amendments", "type": "array" } }, "required": [ "type" ], "title": "LienFilingCreatedWebhook_LienFilingSubmissionImportedResponse (v1)", "type": "object" }, "v1.LienFilingCreatedWebhook_LienFilingSubmissionUCC1Response": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.created", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "filing_type": { "const": "UCC1", "default": "UCC1", "description": "Initial financing statement, which is the first filing of a lien.", "title": "Filing Type", "type": "string" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation for the jurisdiction where the lien is to be filed.", "title": "Jurisdiction State" }, { "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state.", "title": "No Jurisdiction State provided.", "type": "null" } ], "default": null, "title": "State" }, "jurisdiction_county": { "anyOf": [ { "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located.", "maxLength": 128, "title": "Jurisdiction County", "type": "string" }, { "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required.", "title": "No Jurisdiction County provided.", "type": "null" } ], "default": null, "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "description": "An enumeration of debtors implicated in the lien filing process, excluding the assigned debtor on anchored filings. Standalone filings return every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "id": "c0315e18-d05e-4f8d-9b48-5e4816d93d93", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" } ] }, "title": "Debtors", "type": "array" }, { "description": "No debtors are provided for the lien filing.", "title": "No Debtors Provided", "type": "null" } ], "default": null, "title": "Debtors" }, "secured_parties": { "anyOf": [ { "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "id": "5e964550-843b-45de-a8c2-9d048d5bd9a3", "is_assignor": null, "mailing_address": "123 Main St", "masked": null, "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Secured Party", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" }, { "description": "No secured parties are provided for the lien filing.", "title": "No Secured Parties Provided", "type": "null" } ], "default": null, "title": "Secured Parties" }, "collateral_statements": { "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.", "discriminator": { "mapping": { "ATTACHMENTS": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse", "TEXT": "#/components/schemas/v1.LienFilingCollateralStatementText" }, "propertyName": "type" }, "examples": [ { "collateral_statement_designation": null, "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "attachments": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "fb29f6ea-5d1d-41ad-8836-c89825964887" }, { "document_filename": "collateral_statement_details.pdf", "id": "a4150ff3-7365-4de2-a962-97d4b0160a3f" } ], "collateral_statement_designation": null, "type": "ATTACHMENTS" } ], "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse" } ], "title": "Collateral Statements" }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeNameDesignation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally.", "title": "Alternative Name Designation" }, { "description": "No alternative name designation is provided for the lien filing.", "title": "No Alternative Name Designation", "type": "null" } ], "default": null, "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeType", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable.", "title": "Alternative Filing Type" }, { "description": "No alternative filing type is provided for the lien filing.", "title": "No Alternative Filing Type", "type": "null" } ], "default": null, "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "description": "The principal indebted amount in the lien filing submission.", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Principal Indebted Amount", "type": "string" }, { "description": "No principal indebted amount has been provided for the lien filing submission.", "title": "No Principal Indebted Amount provided.", "type": "null" } ], "default": null, "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp.", "title": "Documentary Tax Stamp Required", "type": "boolean" }, { "description": "No documentary tax stamp is provided for the lien filing submission.", "title": "No Documentary Tax Stamp Provided", "type": "null" } ], "default": null, "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingTaxExemptReason", "description": "The tax exempt reason for the lien filing submission.", "title": "Tax Exempt Reason" }, { "description": "No tax exempt reason has been provided for the lien filing submission.", "title": "No Tax Exempt Reason provided.", "type": "null" } ], "default": null, "title": "Tax Exempt Reason" }, "assigned_business_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The debtor associated with the business against which the lien is filed. This debtor information is pre-filled based on the business details and cannot be modified (hence not appearing in POST and PUT requests).", "examples": [ { "business_id": "191aa2c2-5908-462a-9f06-7bd84dc87c1a", "capacity": "ESTATE", "city": "Springfield", "id": "8545693b-a50f-4865-9687-1a8d37e5d07c", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "LLC", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ], "title": "Assigned Business Debtor" }, "assigned_debtor": { "anyOf": [ { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" } ] }, { "type": "null" } ], "description": "The debtor associated with the business or person against which an anchored lien is filed. Standalone filings have no assigned debtor.", "title": "Assigned Debtor" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingStatus", "description": "The lien's standing once it has been filed, derived under UCC §9-515 rather than read off a stored column — a filed lien whose lapse date has passed reports `Lapsed` here without anything having had to age it. Reads the same way as an imported filing's `status`. For a filing made THROUGH Baselayer the standing is derived from the filing's own row, which is kept current from that filing's Filed UCC-3 amendments: a Filed termination pins `Terminated`, and a Filed continuation renews the lapse date. `Terminated` is final; otherwise a lapse date that has passed reads `Lapsed`, and anything else reads `Active`.", "examples": [ "Active" ], "title": "Lien Status" }, { "description": "The submission has not been filed with the jurisdiction, so the lien it will create has no standing yet.", "title": "No Standing to Report", "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "filing_type" ], "title": "LienFilingCreatedWebhook_LienFilingSubmissionUCC1Response (v1)", "type": "object" }, "v1.LienFilingCreatedWebhook_LienFilingSubmissionUCC3Response": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.created", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "filing_type": { "const": "UCC3", "default": "UCC3", "description": "Amendment or continuation of a previously filed financing statement.", "title": "Filing Type", "type": "string" }, "amendment_action": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3TerminationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3ContinuationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AssignmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DebtorAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3CollateralAmendmentActionResponse" }, { "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field.", "title": "Amendment Action Omitted", "type": "null" } ], "default": null, "description": "The action to be taken for the UCC-3 filing.", "title": "Amendment Action" }, "authorizing_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" }, { "description": "When `null`, the authorizing party has not been set yet.", "title": "Authorizing Party Not Set Yet", "type": "null" } ], "default": null, "description": "The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party.", "title": "Authorizing Party" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation for the jurisdiction where the amendment is to be filed. It is the jurisdiction of the filing being amended, copied when the amendment is created through `POST /lien_submissions/{filing_id}/amend`, and is not recomputed afterwards.", "title": "Jurisdiction State" }, { "description": "The filing being amended carried no jurisdiction state, so the amendment has none either.", "title": "No Jurisdiction State provided.", "type": "null" } ], "default": null, "title": "State" }, "amending_filing": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response", "description": "The filing that is being amended.", "title": "Amending Filing" } }, "required": [ "filing_type" ], "title": "LienFilingCreatedWebhook_LienFilingSubmissionUCC3Response (v1)", "type": "object" }, "v1.LienFilingIndividualDebtorPartyResponse": { "description": "Represents the response structure for an individual debtor party in a lien filing.\n\nThis model encapsulates detailed information about an individual acting as a debtor,\nincluding their identification, contact details, and specific attributes\nrelevant to their role in the lien. It is designed to provide a comprehensive\nview of the individual debtor's information as returned by the API in response to\nlien-related queries or operations.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "capacity": { "$ref": "#/components/schemas/v1.LienPartyDebtorCapacity", "default": "NONE_OF_THE_ABOVE", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "title": "Lien Debtor Capacity" }, "suffix": { "anyOf": [ { "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ], "maxLength": 16, "title": "Individual Suffix", "type": "string" }, { "description": "No suffix is provided for the individual.", "title": "No Suffix", "type": "null" } ], "default": null, "title": "Suffix" }, "last_name": { "anyOf": [ { "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ], "maxLength": 16, "title": "Individual Last Name", "type": "string" }, { "description": "No last name is provided for the individual.", "title": "No Last Name", "type": "null" } ], "default": null, "title": "Last Name" }, "first_name": { "anyOf": [ { "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ], "maxLength": 16, "title": "Individual First Name", "type": "string" }, { "description": "No first name is provided for the individual.", "title": "No First Name", "type": "null" } ], "default": null, "title": "First Name" }, "middle_name": { "anyOf": [ { "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ], "maxLength": 16, "title": "Individual Middle Name", "type": "string" }, { "description": "No middle name is provided for the individual.", "title": "No Middle Name", "type": "null" } ], "default": null, "title": "Middle Name" }, "type": { "const": "INDIVIDUAL", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity.", "title": "Individual Party Type", "type": "string" }, "role": { "const": "Debtor", "default": "Debtor", "description": "Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien.", "title": "Debtor Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingIndividualDebtorPartyResponse (v1)", "type": "object" }, "v1.LienFilingIndividualRecordOwnerParty": { "description": "Represents an individual record owner party involved in a lien filing.", "properties": { "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "suffix": { "anyOf": [ { "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ], "maxLength": 16, "title": "Individual Suffix", "type": "string" }, { "description": "No suffix is provided for the individual.", "title": "No Suffix", "type": "null" } ], "default": null, "title": "Suffix" }, "last_name": { "anyOf": [ { "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ], "maxLength": 16, "title": "Individual Last Name", "type": "string" }, { "description": "No last name is provided for the individual.", "title": "No Last Name", "type": "null" } ], "default": null, "title": "Last Name" }, "first_name": { "anyOf": [ { "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ], "maxLength": 16, "title": "Individual First Name", "type": "string" }, { "description": "No first name is provided for the individual.", "title": "No First Name", "type": "null" } ], "default": null, "title": "First Name" }, "middle_name": { "anyOf": [ { "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ], "maxLength": 16, "title": "Individual Middle Name", "type": "string" }, { "description": "No middle name is provided for the individual.", "title": "No Middle Name", "type": "null" } ], "default": null, "title": "Middle Name" }, "type": { "const": "INDIVIDUAL", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity.", "title": "Individual Party Type", "type": "string" } }, "required": [ "type" ], "title": "LienFilingIndividualRecordOwnerParty (v1)", "type": "object" }, "v1.LienFilingIndividualSecuredPartyResponse": { "description": "Represents the response structure for an individual secured party in a lien filing.\n\nThis model encapsulates detailed information about an individual acting as a secured party,\nincluding their identification, contact details, and specific attributes\nrelevant to their role in the lien. It is designed to provide a comprehensive\nview of the individual secured party's information as returned by the API in response to\nlien-related queries or operations.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "masked": { "anyOf": [ { "description": "When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492).", "title": "Masked", "type": "boolean" }, { "description": "The secured party is not masked when filing a lien.", "title": "Not Masked", "type": "null" } ], "default": null, "title": "Masked" }, "is_assignor": { "anyOf": [ { "description": "Whether the secured party is the assignor of the lien.", "title": "Is Assignor", "type": "boolean" }, { "description": "The assignor status of the secured party is not specified.", "title": "Assignor Not Specified", "type": "null" } ], "default": null, "title": "Is Assignor" }, "suffix": { "anyOf": [ { "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ], "maxLength": 16, "title": "Individual Suffix", "type": "string" }, { "description": "No suffix is provided for the individual.", "title": "No Suffix", "type": "null" } ], "default": null, "title": "Suffix" }, "last_name": { "anyOf": [ { "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ], "maxLength": 16, "title": "Individual Last Name", "type": "string" }, { "description": "No last name is provided for the individual.", "title": "No Last Name", "type": "null" } ], "default": null, "title": "Last Name" }, "first_name": { "anyOf": [ { "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ], "maxLength": 16, "title": "Individual First Name", "type": "string" }, { "description": "No first name is provided for the individual.", "title": "No First Name", "type": "null" } ], "default": null, "title": "First Name" }, "middle_name": { "anyOf": [ { "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ], "maxLength": 16, "title": "Individual Middle Name", "type": "string" }, { "description": "No middle name is provided for the individual.", "title": "No Middle Name", "type": "null" } ], "default": null, "title": "Middle Name" }, "type": { "const": "INDIVIDUAL", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity.", "title": "Individual Party Type", "type": "string" }, "role": { "const": "Secured Party", "default": "Secured Party", "description": "Indicates the role of the party as 'Secured', signifying their interest is protected by the lien.", "title": "Secured Party Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingIndividualSecuredPartyResponse (v1)", "type": "object" }, "v1.LienFilingNoRealEstateInfo": { "description": "This model represents the absence of real estate information associated with a lien filing.", "properties": { "type": { "const": "NO_REAL_ESTATE_INFO", "default": "NO_REAL_ESTATE_INFO", "description": "Indicates that no real estate information is associated with the lien filing.", "title": "Do not file in real estate records", "type": "string" } }, "required": [ "type" ], "title": "LienFilingNoRealEstateInfo (v1)", "type": "object" }, "v1.LienFilingOrganizationDebtorPartyResponse": { "description": "Represents the response structure for an organization acting as a debtor in a lien filing.\n\nThis model encapsulates detailed information about an organizational debtor,\nincluding its identification, contact details, and specific attributes\nrelevant to its role in the lien. It is designed to provide a comprehensive\nview of the debtor's information as returned by the API in response to\nlien-related queries or operations.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "capacity": { "$ref": "#/components/schemas/v1.LienPartyDebtorCapacity", "default": "NONE_OF_THE_ABOVE", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "title": "Lien Debtor Capacity" }, "organization_name": { "anyOf": [ { "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ], "maxLength": 128, "title": "Organization Name", "type": "string" }, { "description": "No organization name is provided for the party.", "title": "No Organization Name", "type": "null" } ], "default": null, "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure", "description": "The type of organization involved in the lien filing, if applicable.", "title": "Organization Type" }, { "description": "No organization type is provided for the party.", "title": "No Organization Type", "type": "null" } ], "default": null, "title": "Organization Type" }, "type": { "const": "ORGANIZATION", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.", "title": "Organization Party Type", "type": "string" }, "role": { "const": "Debtor", "default": "Debtor", "description": "Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien.", "title": "Debtor Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingOrganizationDebtorPartyResponse (v1)", "type": "object" }, "v1.LienFilingOrganizationRecordOwnerParty": { "description": "Represents an organization record owner party involved in a lien filing.", "properties": { "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "organization_name": { "anyOf": [ { "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ], "maxLength": 128, "title": "Organization Name", "type": "string" }, { "description": "No organization name is provided for the party.", "title": "No Organization Name", "type": "null" } ], "default": null, "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure", "description": "The type of organization involved in the lien filing, if applicable.", "title": "Organization Type" }, { "description": "No organization type is provided for the party.", "title": "No Organization Type", "type": "null" } ], "default": null, "title": "Organization Type" }, "type": { "const": "ORGANIZATION", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.", "title": "Organization Party Type", "type": "string" } }, "required": [ "type" ], "title": "LienFilingOrganizationRecordOwnerParty (v1)", "type": "object" }, "v1.LienFilingOrganizationSecuredPartyResponse": { "description": "Represents the response structure for an organization acting as a secured party in a lien filing.\n\nThis model encapsulates detailed information about an organizational secured party,\nincluding their identification, contact details, and specific attributes\nrelevant to their role in the lien. It is designed to provide a comprehensive\nview of the secured party's information as returned by the API in response to\nlien-related queries or operations.", "properties": { "id": { "description": "The unique identifier assigned to the lien filing party.", "format": "uuid", "title": "ID of the party", "type": "string" }, "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "masked": { "anyOf": [ { "description": "When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492).", "title": "Masked", "type": "boolean" }, { "description": "The secured party is not masked when filing a lien.", "title": "Not Masked", "type": "null" } ], "default": null, "title": "Masked" }, "is_assignor": { "anyOf": [ { "description": "Whether the secured party is the assignor of the lien.", "title": "Is Assignor", "type": "boolean" }, { "description": "The assignor status of the secured party is not specified.", "title": "Assignor Not Specified", "type": "null" } ], "default": null, "title": "Is Assignor" }, "organization_name": { "anyOf": [ { "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ], "maxLength": 128, "title": "Organization Name", "type": "string" }, { "description": "No organization name is provided for the party.", "title": "No Organization Name", "type": "null" } ], "default": null, "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure", "description": "The type of organization involved in the lien filing, if applicable.", "title": "Organization Type" }, { "description": "No organization type is provided for the party.", "title": "No Organization Type", "type": "null" } ], "default": null, "title": "Organization Type" }, "type": { "const": "ORGANIZATION", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.", "title": "Organization Party Type", "type": "string" }, "role": { "const": "Secured Party", "default": "Secured Party", "description": "Indicates the role of the party as 'Secured', signifying their interest is protected by the lien.", "title": "Secured Party Role", "type": "string" } }, "required": [ "type", "role" ], "title": "LienFilingOrganizationSecuredPartyResponse (v1)", "type": "object" }, "v1.LienFilingOrigin": { "enum": [ "filed_via_baselayer", "imported" ], "title": "LienFilingOrigin", "type": "string" }, "v1.LienFilingRealEstateInfo": { "description": "This model represents the real estate record in a lien filing submission.", "properties": { "type": { "const": "FILE_IN_REAL_ESTATE_RECORDS", "default": "FILE_IN_REAL_ESTATE_RECORDS", "description": "Indicates that this FINANCING STATEMENT is to be filed [for record] (or recorded) in the REAL ESTATE RECORDS.", "title": "File In Real Estate Records", "type": "string" }, "covers_timber": { "anyOf": [ { "description": "Whether the financing statement filed in the lien filing submission covers timber.", "title": "Financing Statement Covers Timber", "type": "boolean" }, { "description": "Skipping the Timber flag of the financing statement.", "title": "Financing Statement Covers Timber Skipped", "type": "null" } ], "default": null, "title": "Covers Timber" }, "covers_as_extracted_collateral": { "anyOf": [ { "description": "Whether the financing statement filed in the lien filing submission covers as-extracted collateral.", "title": "Financing Statement Covers As Extracted Collateral", "type": "boolean" }, { "description": "Skipping the As Extracted Collateral flag of the financing statement.", "title": "Financing Statement Covers As Extracted Collateral Skipped", "type": "null" } ], "default": null, "title": "Covers As Extracted Collateral" }, "filed_as_fixture": { "anyOf": [ { "description": "Whether the financing statement filed in the lien filing submission is filed as a fixture.", "title": "Financing Statement Filed As Fixture", "type": "boolean" }, { "description": "Skipping the Fixture flag of the financing statement.", "title": "Financing Statement Filed As Fixture Skipped", "type": "null" } ], "default": null, "title": "Filed As Fixture" }, "real_estate_record_owner": { "anyOf": [ { "description": "The owner of the real estate record of the lien filing.", "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualRecordOwnerParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationRecordOwnerParty" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationRecordOwnerParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualRecordOwnerParty" } ], "title": "Real Estate Record Owner" }, { "description": "Skipping the Real Estate Record Owner field.", "title": "Real Estate Record Owner Skipped", "type": "null" } ], "title": "Real Estate Record Owner" }, "real_estate_description": { "anyOf": [ { "description": "A description of the real estate.", "maxLength": 1024, "title": "Real Estate Description", "type": "string" }, { "description": "Skipping the Real Estate Description field.", "title": "Real Estate Description Skipped", "type": "null" } ], "default": null, "title": "Real Estate Description" } }, "required": [ "type" ], "title": "LienFilingRealEstateInfo (v1)", "type": "object" }, "v1.LienFilingStatus": { "description": "Enumeration of possible statuses for a lien filing. A lien filing's status\nindicates its current state within its lifecycle and legal enforceability.", "enum": [ "Active", "Inactive", "Lapsed", "Released", "Satisfied", "Expired", "Pending", "Contested", "Disputed", "Perfected", "Unperfected", "Void", "Invalid", "Enforcement", "Foreclosure", "Subordinated", "Avoided", "Terminated", "Draft", "InPreperation", "Unknown" ], "title": "LienFilingStatus", "type": "string" }, "v1.LienFilingSubmissionStatus": { "description": "Enum class delineating the various stages of a lien filing submission's lifecycle.", "enum": [ "Draft", "Requested", "InReview", "NeedsAttention", "Submitted", "Filed", "Cancelled" ], "title": "LienFilingSubmissionStatus", "type": "string" }, "v1.LienFilingSubmissionUCC1Response": { "additionalProperties": false, "description": "Represents the response structure for a lien filing submission. This model\nincludes all the details provided during the creation of a lien filing submission\nalong with additional system-generated information such as the unique identifier,\nthe current status of the submission, and the filing number if the lien has been\nrecorded.", "properties": { "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "filing_type": { "const": "UCC1", "default": "UCC1", "description": "Initial financing statement, which is the first filing of a lien.", "title": "Filing Type", "type": "string" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation for the jurisdiction where the lien is to be filed.", "title": "Jurisdiction State" }, { "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state.", "title": "No Jurisdiction State provided.", "type": "null" } ], "default": null, "title": "State" }, "jurisdiction_county": { "anyOf": [ { "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located.", "maxLength": 128, "title": "Jurisdiction County", "type": "string" }, { "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required.", "title": "No Jurisdiction County provided.", "type": "null" } ], "default": null, "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "description": "An enumeration of debtors implicated in the lien filing process, excluding the assigned debtor on anchored filings. Standalone filings return every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "id": "c0315e18-d05e-4f8d-9b48-5e4816d93d93", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" } ] }, "title": "Debtors", "type": "array" }, { "description": "No debtors are provided for the lien filing.", "title": "No Debtors Provided", "type": "null" } ], "default": null, "title": "Debtors" }, "secured_parties": { "anyOf": [ { "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "id": "5e964550-843b-45de-a8c2-9d048d5bd9a3", "is_assignor": null, "mailing_address": "123 Main St", "masked": null, "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Secured Party", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" }, { "description": "No secured parties are provided for the lien filing.", "title": "No Secured Parties Provided", "type": "null" } ], "default": null, "title": "Secured Parties" }, "collateral_statements": { "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.", "discriminator": { "mapping": { "ATTACHMENTS": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse", "TEXT": "#/components/schemas/v1.LienFilingCollateralStatementText" }, "propertyName": "type" }, "examples": [ { "collateral_statement_designation": null, "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "attachments": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "fb29f6ea-5d1d-41ad-8836-c89825964887" }, { "document_filename": "collateral_statement_details.pdf", "id": "a4150ff3-7365-4de2-a962-97d4b0160a3f" } ], "collateral_statement_designation": null, "type": "ATTACHMENTS" } ], "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse" } ], "title": "Collateral Statements" }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeNameDesignation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally.", "title": "Alternative Name Designation" }, { "description": "No alternative name designation is provided for the lien filing.", "title": "No Alternative Name Designation", "type": "null" } ], "default": null, "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeType", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable.", "title": "Alternative Filing Type" }, { "description": "No alternative filing type is provided for the lien filing.", "title": "No Alternative Filing Type", "type": "null" } ], "default": null, "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "description": "The principal indebted amount in the lien filing submission.", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Principal Indebted Amount", "type": "string" }, { "description": "No principal indebted amount has been provided for the lien filing submission.", "title": "No Principal Indebted Amount provided.", "type": "null" } ], "default": null, "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp.", "title": "Documentary Tax Stamp Required", "type": "boolean" }, { "description": "No documentary tax stamp is provided for the lien filing submission.", "title": "No Documentary Tax Stamp Provided", "type": "null" } ], "default": null, "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingTaxExemptReason", "description": "The tax exempt reason for the lien filing submission.", "title": "Tax Exempt Reason" }, { "description": "No tax exempt reason has been provided for the lien filing submission.", "title": "No Tax Exempt Reason provided.", "type": "null" } ], "default": null, "title": "Tax Exempt Reason" }, "assigned_business_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The debtor associated with the business against which the lien is filed. This debtor information is pre-filled based on the business details and cannot be modified (hence not appearing in POST and PUT requests).", "examples": [ { "business_id": "191aa2c2-5908-462a-9f06-7bd84dc87c1a", "capacity": "ESTATE", "city": "Springfield", "id": "8545693b-a50f-4865-9687-1a8d37e5d07c", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "LLC", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ], "title": "Assigned Business Debtor" }, "assigned_debtor": { "anyOf": [ { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" } ] }, { "type": "null" } ], "description": "The debtor associated with the business or person against which an anchored lien is filed. Standalone filings have no assigned debtor.", "title": "Assigned Debtor" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingStatus", "description": "The lien's standing once it has been filed, derived under UCC §9-515 rather than read off a stored column — a filed lien whose lapse date has passed reports `Lapsed` here without anything having had to age it. Reads the same way as an imported filing's `status`. For a filing made THROUGH Baselayer the standing is derived from the filing's own row, which is kept current from that filing's Filed UCC-3 amendments: a Filed termination pins `Terminated`, and a Filed continuation renews the lapse date. `Terminated` is final; otherwise a lapse date that has passed reads `Lapsed`, and anything else reads `Active`.", "examples": [ "Active" ], "title": "Lien Status" }, { "description": "The submission has not been filed with the jurisdiction, so the lien it will create has no standing yet.", "title": "No Standing to Report", "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "filing_type" ], "title": "LienFilingSubmissionUCC1Response (v1)", "type": "object" }, "v1.LienFilingTaxExemptReason": { "description": "Enum for the tax exempt reason for a lien filing.", "enum": [ "DEBTOR_COOPERATIVE_MARKETING_ASSOCIATION", "DEBTOR_CREDIT_UNION", "DEBTOR_TELEPHONE_COOPERATIVE", "GOVERNMENT_AGENCY", "JUDGEMENT_LIEN", "MUNICIPALITY", "REORGANIZATION", "SECURITIES", "STATE_AGENCY", "NOT_EXEMPT" ], "title": "LienFilingTaxExemptReason", "type": "string" }, "v1.LienFilingUCC3AddDebtorAmendmentResponse": { "description": "Represents an amendment to add a debtor in a UCC-3 filing.\n\nThis model is used to add a new debtor to an existing financing statement.\nIt includes details about the debtor being added to the UCC-3 amendment.", "properties": { "type": { "const": "ADD", "default": "ADD", "description": "Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement.", "title": "Add Debtor", "type": "string" }, "debtors": { "description": "An enumeration of debtors implicated in the lien filing process. It is imperative to omit the debtor correlated with the business profile against which the lien is being filed. ", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "id": "8441f989-28df-49a9-aff4-6dbbd5c3c94e", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" } ] }, "title": "Debtors", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUCC3AddDebtorAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3AddSecuredPartyAmendmentResponse": { "properties": { "type": { "const": "ADD", "default": "ADD", "description": "Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement.", "title": "Add Debtor", "type": "string" }, "secured_parties": { "description": "An enumeration of secured parties implicated in the lien filing process.", "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUCC3AddSecuredPartyAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3AmendingDebtorResponse": { "description": "Represents a debtor being amended in a UCC-3 filing.\n\nSpecifies the details of a debtor being modified in a UCC-3 filing.\nThis encompasses the original debtor's identifier and the updated\ninformation. UCC-3 filings serve to amend previously submitted\nUniform Commercial Code financing statements.", "properties": { "amending_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" } ], "description": "The debtor information to be amended. This can be either an organization or an individual debtor.", "title": "Amending Debtor" }, "new_debtor": { "description": "The new debtor information. This can be either an organization or an individual debtor.", "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" } ], "title": "New Debtor" } }, "required": [ "amending_debtor", "new_debtor" ], "title": "LienFilingUCC3AmendingDebtorResponse (v1)", "type": "object" }, "v1.LienFilingUCC3AmendingSecuredPartyResponse": { "description": "Defines a response model for a secured party undergoing amendment in a UCC-3 filing.\n\nThis class encapsulates the information for a secured party being modified\nin a UCC-3 (Uniform Commercial Code - Amendment) filing. It contains the\nidentifier of the secured party from the original filing, along with the\nnew or updated secured party details.", "properties": { "amending_secured_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ], "description": "The ID of the secured party to be amended.", "title": "Amending Secured Party ID" }, "new_secured_party": { "description": "The new secured party information. This can be either an organization or an individual secured party.", "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ], "title": "New Secured Party" } }, "required": [ "amending_secured_party", "new_secured_party" ], "title": "LienFilingUCC3AmendingSecuredPartyResponse (v1)", "type": "object" }, "v1.LienFilingUCC3AssignmentActionResponse": { "properties": { "type": { "const": "ASSIGNMENT", "default": "ASSIGNMENT", "description": "Indicates that this is an assignment action for a UCC-3 filing. An assignment is used to transfer some or all of the secured party's rights under the financing statement to another party.", "title": "Assignment", "type": "string" }, "assignment": { "description": "Specifies the details of the assignment action. This can be either a partial assignment, where only some rights are transferred, or a full assignment, where all rights are transferred to the new secured party.", "discriminator": { "mapping": { "FULL": "#/components/schemas/v1.LienFilingUCC3FullAssignmentResponse", "PARTIAL": "#/components/schemas/v1.LienFilingUCC3PartialAssignmentResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3PartialAssignmentResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3FullAssignmentResponse" } ], "title": "Assigment" } }, "required": [ "type" ], "title": "LienFilingUCC3AssignmentActionResponse (v1)", "type": "object" }, "v1.LienFilingUCC3CollateralAmendmentActionResponse": { "description": "Represents the response structure for a UCC-3 collateral amendment action.\n\nThis model includes details about the collateral amendment, such as the type of amendment\nand the updated collateral statements. It provides a comprehensive view of the changes\nmade to the collateral information in a UCC-3 filing.", "properties": { "type": { "const": "COLLATERAL_AMENDMENT", "default": "COLLATERAL_AMENDMENT", "description": "Indicates that this is a collateral amendment action for a UCC-3 filing. A collateral amendment is used to add, delete, or modify information about the collateral described in the financing statement.", "title": "Collateral Amendment", "type": "string" }, "collateral_amendment_type": { "$ref": "#/components/schemas/v1.LienFilingCollateralAmendmentType", "description": "The type of amendment to be performed.", "title": "Amendment Type" }, "collateral_statements": { "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.", "discriminator": { "mapping": { "ATTACHMENTS": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse", "TEXT": "#/components/schemas/v1.LienFilingCollateralStatementText" }, "propertyName": "type" }, "examples": [ { "collateral_statement_designation": null, "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "attachments": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "fd8e2a58-272c-462a-91f0-b05d118126c3" }, { "document_filename": "collateral_statement_details.pdf", "id": "a2f13fbd-8a13-46a9-8333-8dc2dafe19ca" } ], "collateral_statement_designation": null, "type": "ATTACHMENTS" } ], "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse" } ], "title": "Collateral Statements" } }, "required": [ "type" ], "title": "LienFilingUCC3CollateralAmendmentActionResponse (v1)", "type": "object" }, "v1.LienFilingUCC3ContinuationAction": { "description": "Represents a UCC-3 continuation filing.\n\nThis model defines the structure for a continuation action in a UCC-3 filing.\nIt is used to extend the effectiveness of a previously filed UCC-1 financing statement.\n\n> **NOTE:** A Continuation may be filed within 6 months of a filing's lapse date.", "properties": { "type": { "const": "CONTINUATION", "default": "CONTINUATION", "description": "Indicates that this is a continuation action for a UCC-3 filing. A continuation statement is used to extend the effectiveness of the financing statement for an additional period of time.\n> **NOTE:** A Continuation may be filed within 6 months of a filing's lapse date.", "title": "Continuation", "type": "string" } }, "required": [ "type" ], "title": "LienFilingUCC3ContinuationAction (v1)", "type": "object" }, "v1.LienFilingUCC3DebtorAmendmentActionResponse": { "properties": { "type": { "const": "DEBTOR_AMENDMENT", "default": "DEBTOR_AMENDMENT", "description": "Indicates that this is a debtor amendment action for a UCC-3 filing. A debtor amendment is used to add, delete, or modify information about a debtor in the financing statement.", "title": "Debtor Amendment", "type": "string" }, "amendment": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AddDebtorAmendmentResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3EditDebtorAmendmentResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DeleteDebtorAmendmentResponse" }, { "description": "The debtor amendment action is not set yet.", "title": "Debtor Amendment Action Not Set", "type": "null" } ], "default": null, "description": "Specifies the type of debtor amendment action to be performed. This can be adding a new debtor, editing an existing debtor's information, or deleting a debtor from the financing statement.", "title": "Debtor Amendment Action" } }, "required": [ "type" ], "title": "LienFilingUCC3DebtorAmendmentActionResponse (v1)", "type": "object" }, "v1.LienFilingUCC3DeleteDebtorAmendmentResponse": { "properties": { "type": { "const": "DELETE", "default": "DELETE", "description": "Indicates that this is a delete debtor action for a UCC-3 filing. A delete debtor action is used to delete an existing debtor in the financing statement.", "title": "Delete Debtor", "type": "string" }, "deleted_debtors": { "description": "A list of the debtors to be deleted in the UCC-3 filing.", "items": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" } ] }, "title": "Deleted Debtor", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUCC3DeleteDebtorAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3DeleteSecuredPartyAmendmentResponse": { "properties": { "type": { "const": "DELETE", "default": "DELETE", "description": "Indicates that this is a delete secured party action for a UCC-3 filing. A delete secured party action is used to delete an existing secured party in the financing statement.", "title": "Delete Secured Party", "type": "string" }, "deleted_secured_parties": { "description": "A list of the secured parties to be deleted in the UCC-3 filing.", "items": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Deleted Secured Parties", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUCC3DeleteSecuredPartyAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3EditDebtorAmendmentResponse": { "properties": { "type": { "const": "EDIT", "default": "EDIT", "description": "Indicates that this is an edit debtor action for a UCC-3 filing. An edit debtor action is used to edit an existing debtor in the financing statement.", "title": "Edit Debtor", "type": "string" }, "amending_debtors": { "description": "A list of debtors to be amended in the UCC-3 filing. Each entry contains the position of the debtor in the original filing and the new debtor information.", "items": { "$ref": "#/components/schemas/v1.LienFilingUCC3AmendingDebtorResponse" }, "title": "Amending Debtors", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUCC3EditDebtorAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3EditSecuredPartyAmendmentResponse": { "properties": { "type": { "const": "EDIT", "default": "EDIT", "description": "Indicates that this is an edit secured party action for a UCC-3 filing. An edit secured party action is used to edit an existing secured party in the financing statement.", "title": "Edit Secured Party", "type": "string" }, "amending_secured_parties": { "anyOf": [ { "description": "A list of secured parties to be amended in the UCC-3 filing. Each entry contains the position of the secured party in the original filing and the new secured party information.", "items": { "$ref": "#/components/schemas/v1.LienFilingUCC3AmendingSecuredPartyResponse" }, "title": "Amending Secured Parties", "type": "array" }, { "description": "The amending secured parties are not set yet.", "title": "Amending Secured Parties Not Set", "type": "null" } ], "default": null, "title": "Amending Secured Parties" } }, "required": [ "type" ], "title": "LienFilingUCC3EditSecuredPartyAmendmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3FullAssignmentResponse": { "properties": { "type": { "const": "FULL", "description": "Indicates a full assignment of the lien filing.\n\nIn a full assignment:\n- The entire interest in the collateral is transferred to a new secured party. \n- The original secured party relinquishes all rights to the collateral. \n- All future actions related to the financing statement will be handled by the new secured party.", "title": "Partial Assignment", "type": "string" }, "secured_parties": { "anyOf": [ { "description": "An enumeration of secured parties implicated in the lien filing process.", "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" }, { "description": "Secured parties are not set yet for this assignment.", "title": "Secured Parties Not Set", "type": "null" } ], "default": null, "title": "Secured Parties" } }, "required": [ "type" ], "title": "LienFilingUCC3FullAssignmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3PartialAssignmentResponse": { "properties": { "type": { "const": "PARTIAL", "description": "Indicates a partial assignment of the lien filing.\n\nIn a partial assignment:\n- Only a portion of the interest in the collateral is transferred to a new secured party. \n- The original secured party retains some rights to the collateral. \n- Both the original and new secured parties may have rights to take actions related to the financing statement, but only for their respective portions of the collateral.", "title": "Partial Assignment", "type": "string" }, "secured_parties": { "anyOf": [ { "description": "An enumeration of secured parties implicated in the lien filing process.", "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" }, { "description": "Secured parties are not set yet for this assignment.", "title": "Secured Parties Not Set", "type": "null" } ], "default": null, "title": "Secured Parties" }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse" }, { "description": "When updating the record with `nul`, it will respect the existing server value for the `collateral_statements` field of the filing document, causing no changes to this field.", "title": "Collateral Statements Omitted", "type": "null" } ], "default": null, "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.\n\n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "examples": [ { "collateral_statement_designation": null, "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "attachments": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "6196f03e-88d2-4775-81ee-8e153a9dd734" }, { "document_filename": "collateral_statement_details.pdf", "id": "8eabca66-9523-41e1-9b52-e07678f00e9f" } ], "collateral_statement_designation": null, "type": "ATTACHMENTS" } ], "title": "Collateral Statements" } }, "required": [ "type" ], "title": "LienFilingUCC3PartialAssignmentResponse (v1)", "type": "object" }, "v1.LienFilingUCC3SecuredPartyAmendmentActionResponse": { "description": "Represents a response model for a UCC-3 secured party amendment filing.\n\nThis schema defines the structure for a secured party amendment action in a UCC-3 filing.\nIt is used to add, delete, or modify information about a secured party\nin a previously filed financing statement.", "properties": { "type": { "const": "SECURED_PARTY_AMENDMENT", "default": "SECURED_PARTY_AMENDMENT", "description": "Indicates that this is a secured party amendment action for a UCC-3 filing. A secured party amendment is used to add, delete, or modify information about a secured party in the financing statement.", "title": "Secured Party Amendment", "type": "string" }, "amendment": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AddSecuredPartyAmendmentResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3EditSecuredPartyAmendmentResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DeleteSecuredPartyAmendmentResponse" }, { "description": "The secured party amendment action is not set yet.", "title": "Secured Party Amendment Action Omitted", "type": "null" } ], "default": null, "description": "Specifies the type of secured party amendment action to be performed. This can be adding a new secured party, editing an existing secured party's information, or deleting a secured party from the financing statement.", "title": "Secured Party Amendment Action" } }, "required": [ "type" ], "title": "LienFilingUCC3SecuredPartyAmendmentActionResponse (v1)", "type": "object" }, "v1.LienFilingUCC3TerminationAction": { "description": "Represents a UCC-3 termination filing.\n\nThis model defines the structure for a termination action in a UCC-3 filing.\nIt is used to indicate the termination of a previously filed UCC-1 financing statement,\nsignifying that the secured party no longer claims a security interest under that statement.", "properties": { "type": { "const": "TERMINATION", "default": "TERMINATION", "description": "Indicates that this is a termination action for a UCC-3 filing. A termination statement is used to indicate that the secured party no longer claims a security interest under the financing statement.", "title": "Termination", "type": "string" } }, "required": [ "type" ], "title": "LienFilingUCC3TerminationAction (v1)", "type": "object" }, "v1.LienPartyDebtorCapacity": { "description": "Defines the various capacities a debtor may assume in the context of\na lien, aiding in the comprehension of their legal standing and\nobligations concerning the lien.", "enum": [ "ESTATE", "TRUST", "TRUSTEE", "NONE_OF_THE_ABOVE" ], "title": "LienPartyDebtorCapacity", "type": "string" }, "v1.LienPartyResponse": { "description": "Represents an entity involved in a lien as either a debtor or a secured party.\nThis model captures common attributes and relationships of these parties.", "properties": { "id": { "description": "The identifier of this lien filing record.", "format": "uuid", "title": "Id", "type": "string" }, "role": { "$ref": "#/components/schemas/v1.LienPartyRole", "description": "Categorizes the party as either a debtor owing the debt or a secured party holding the collateral interest.", "examples": [ "Debtor" ] }, "name": { "description": "Legal name of the party; crucial for due diligence and legal proceedings related to the lien.", "examples": [ "Louis Schneider" ], "title": "Name", "type": "string" }, "address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "Address of the party; provides the physical location for legal notices or contact purposes." }, "mailing_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Street of the party's address as written on the filing itself, when known. It may accompany `address` rather than replace it: `address` is the verified address record behind the party when there is one, and these components are what the filing says — the only address a party with no verified record has.", "examples": [ "1 Market Street" ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "City of the party's address as recorded on the filing itself; see `mailing_address`.", "examples": [ "San Francisco" ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation" }, { "type": "null" } ], "default": null, "description": "State of the party's address as recorded on the filing itself; see `mailing_address`.", "examples": [ "CA" ] }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Postal code of the party's address as recorded on the filing itself; see `mailing_address`.", "examples": [ "94105" ], "title": "Postal Code" }, "type": { "description": "The type of lien party, indicating whether the party is an individual or an organization.\nA computed property that returns the role of the lien party. \nNote: This `type` property is planned to be deprecated in favor of the `role` field in future versions.", "examples": [ "individual", "organization" ], "title": "Type", "type": "string" } }, "required": [ "id", "role", "name", "address", "type" ], "title": "LienPartyResponse (v1)", "type": "object" }, "v1.LienPartyRole": { "description": "Enum class delineating the role of parties in a lien transaction as\ndefined by the UCC.", "enum": [ "Debtor", "Secured Party", "Record Owner" ], "title": "LienPartyRole", "type": "string" }, "v1.LienFilingUpdatedWebhook_LienFilingSubmissionImportedResponse": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.updated", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "filing_type": { "const": "UCC1", "default": "UCC1", "description": "Initial financing statement, which is the filing an imported lien is identified by.", "title": "Filing Type", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the jurisdiction the lien is filed in.", "examples": [ "IL" ], "title": "Jurisdiction State" }, "status": { "$ref": "#/components/schemas/v1.LienFilingStatus", "description": "The lien's standing in the public record, derived from its amendment history and lapse date (UCC §9-515).", "examples": [ "Active" ], "title": "Lien Status" }, "imported_unverified": { "default": false, "description": "Whether this filing is held from the details the caller supplied rather than verified against the public record. Its status, dates and parties are the caller's own claim, estimated under UCC §9-515 where the public record would otherwise answer.", "examples": [ false ], "title": "Unverified Import", "type": "boolean" }, "debtors": { "description": "The debtors recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "title": "Debtors", "type": "array" }, "secured_parties": { "description": "The secured parties recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "title": "Secured Parties", "type": "array" }, "amendments": { "description": "The continuations, terminations, assignments and other amendments recorded against the lien in the public record.", "items": { "$ref": "#/components/schemas/v1.LienAmendmentResponse" }, "title": "Amendments", "type": "array" } }, "required": [ "type" ], "title": "LienFilingUpdatedWebhook_LienFilingSubmissionImportedResponse (v1)", "type": "object" }, "v1.LienFilingUpdatedWebhook_LienFilingSubmissionUCC1Response": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.updated", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "filing_type": { "const": "UCC1", "default": "UCC1", "description": "Initial financing statement, which is the first filing of a lien.", "title": "Filing Type", "type": "string" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation for the jurisdiction where the lien is to be filed.", "title": "Jurisdiction State" }, { "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state.", "title": "No Jurisdiction State provided.", "type": "null" } ], "default": null, "title": "State" }, "jurisdiction_county": { "anyOf": [ { "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located.", "maxLength": 128, "title": "Jurisdiction County", "type": "string" }, { "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required.", "title": "No Jurisdiction County provided.", "type": "null" } ], "default": null, "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "description": "An enumeration of debtors implicated in the lien filing process, excluding the assigned debtor on anchored filings. Standalone filings return every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "id": "c0315e18-d05e-4f8d-9b48-5e4816d93d93", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" } ] }, "title": "Debtors", "type": "array" }, { "description": "No debtors are provided for the lien filing.", "title": "No Debtors Provided", "type": "null" } ], "default": null, "title": "Debtors" }, "secured_parties": { "anyOf": [ { "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "id": "5e964550-843b-45de-a8c2-9d048d5bd9a3", "is_assignor": null, "mailing_address": "123 Main St", "masked": null, "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "role": "Secured Party", "state": "IL", "type": "ORGANIZATION" } ] ], "items": { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" } ] }, "title": "Secured Parties", "type": "array" }, { "description": "No secured parties are provided for the lien filing.", "title": "No Secured Parties Provided", "type": "null" } ], "default": null, "title": "Secured Parties" }, "collateral_statements": { "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.", "discriminator": { "mapping": { "ATTACHMENTS": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse", "TEXT": "#/components/schemas/v1.LienFilingCollateralStatementText" }, "propertyName": "type" }, "examples": [ { "collateral_statement_designation": null, "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "attachments": [ { "document_filename": "Ford Mustang 1967 Convertible.pdf", "id": "fb29f6ea-5d1d-41ad-8836-c89825964887" }, { "document_filename": "collateral_statement_details.pdf", "id": "a4150ff3-7365-4de2-a962-97d4b0160a3f" } ], "collateral_statement_designation": null, "type": "ATTACHMENTS" } ], "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse" } ], "title": "Collateral Statements" }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeNameDesignation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally.", "title": "Alternative Name Designation" }, { "description": "No alternative name designation is provided for the lien filing.", "title": "No Alternative Name Designation", "type": "null" } ], "default": null, "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAlternativeType", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable.", "title": "Alternative Filing Type" }, { "description": "No alternative filing type is provided for the lien filing.", "title": "No Alternative Filing Type", "type": "null" } ], "default": null, "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "description": "The principal indebted amount in the lien filing submission.", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "title": "Principal Indebted Amount", "type": "string" }, { "description": "No principal indebted amount has been provided for the lien filing submission.", "title": "No Principal Indebted Amount provided.", "type": "null" } ], "default": null, "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp.", "title": "Documentary Tax Stamp Required", "type": "boolean" }, { "description": "No documentary tax stamp is provided for the lien filing submission.", "title": "No Documentary Tax Stamp Provided", "type": "null" } ], "default": null, "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingTaxExemptReason", "description": "The tax exempt reason for the lien filing submission.", "title": "Tax Exempt Reason" }, { "description": "No tax exempt reason has been provided for the lien filing submission.", "title": "No Tax Exempt Reason provided.", "type": "null" } ], "default": null, "title": "Tax Exempt Reason" }, "assigned_business_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The debtor associated with the business against which the lien is filed. This debtor information is pre-filled based on the business details and cannot be modified (hence not appearing in POST and PUT requests).", "examples": [ { "business_id": "191aa2c2-5908-462a-9f06-7bd84dc87c1a", "capacity": "ESTATE", "city": "Springfield", "id": "8545693b-a50f-4865-9687-1a8d37e5d07c", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "LLC", "postal_code": "62701", "role": "Debtor", "state": "IL", "type": "ORGANIZATION" } ], "title": "Assigned Business Debtor" }, "assigned_debtor": { "anyOf": [ { "discriminator": { "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse", "ORGANIZATION": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" } ] }, { "type": "null" } ], "description": "The debtor associated with the business or person against which an anchored lien is filed. Standalone filings have no assigned debtor.", "title": "Assigned Debtor" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingStatus", "description": "The lien's standing once it has been filed, derived under UCC §9-515 rather than read off a stored column — a filed lien whose lapse date has passed reports `Lapsed` here without anything having had to age it. Reads the same way as an imported filing's `status`. For a filing made THROUGH Baselayer the standing is derived from the filing's own row, which is kept current from that filing's Filed UCC-3 amendments: a Filed termination pins `Terminated`, and a Filed continuation renews the lapse date. `Terminated` is final; otherwise a lapse date that has passed reads `Lapsed`, and anything else reads `Active`.", "examples": [ "Active" ], "title": "Lien Status" }, { "description": "The submission has not been filed with the jurisdiction, so the lien it will create has no standing yet.", "title": "No Standing to Report", "type": "null" } ], "default": null, "title": "Status" } }, "required": [ "filing_type" ], "title": "LienFilingUpdatedWebhook_LienFilingSubmissionUCC1Response (v1)", "type": "object" }, "v1.LienFilingUpdatedWebhook_LienFilingSubmissionUCC3Response": { "additionalProperties": false, "properties": { "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "LienFiling.updated", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } }, "reference_data": { "anyOf": [ { "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ], "maxLength": 128, "title": "Reference Data", "type": "string" }, { "description": "No reference data is provided for the lien filing.", "title": "No Reference Data", "type": "null" } ], "default": null, "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ], "maxLength": 128, "title": "Filing Name", "type": "string" }, { "description": "The filing name will be automatically generated based on the debtor's name and the type of filing.", "title": "No Filing Name provided.", "type": "null" } ], "default": null, "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "Search to Reflect", "type": "boolean" }, { "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office.", "title": "No Search to Reflect", "type": "null" } ], "default": null, "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "description": "This email will receive all correspondence concerning this lien filing.", "maxLength": 256, "title": "Lien Filing Email Contact", "type": "string" }, { "description": "No email contact has been provided for the lien filing submission.", "title": "No Email Contact provided.", "type": "null" } ], "default": null, "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "description": "The real estate information will not be updated.", "title": "Real Estate Information Omitted", "type": "null" } ], "default": null, "description": "The real estate information associated with the lien filing submission.", "title": "Real Estate Information" }, "miscellaneous_info": { "anyOf": [ { "description": "Miscellaneous information associated with the lien filing submission.", "maxLength": 256, "title": "Miscellaneous Information", "type": "string" }, { "description": "No miscellaneous information has been provided for the lien filing submission.", "title": "No Miscellaneous Information provided.", "type": "null" } ], "default": null, "title": "Miscellaneous Info" }, "filing_type": { "const": "UCC3", "default": "UCC3", "description": "Amendment or continuation of a previously filed financing statement.", "title": "Filing Type", "type": "string" }, "amendment_action": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3TerminationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3ContinuationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AssignmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DebtorAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3CollateralAmendmentActionResponse" }, { "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field.", "title": "Amendment Action Omitted", "type": "null" } ], "default": null, "description": "The action to be taken for the UCC-3 filing.", "title": "Amendment Action" }, "authorizing_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" }, { "description": "When `null`, the authorizing party has not been set yet.", "title": "Authorizing Party Not Set Yet", "type": "null" } ], "default": null, "description": "The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party.", "title": "Authorizing Party" }, "id": { "description": "The unique identifier for the lien filing submission.", "format": "uuid", "title": "Lien Filing Submission ID", "type": "string" }, "filing_status": { "$ref": "#/components/schemas/v1.LienFilingSubmissionStatus", "description": "The current state of the lien filing submission.", "title": "Lien Filing Submission Status" }, "filing_number": { "anyOf": [ { "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ], "maxLength": 128, "title": "Lien Filing Number", "type": "string" }, { "description": "This field is set to `null` until the lien filing has been officially recorded.", "title": "No Filing Number assigned yet.", "type": "null" } ], "default": null, "title": "Filing Number" }, "filing_date": { "anyOf": [ { "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ], "format": "date", "title": "Filing Date", "type": "string" }, { "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Filing Date assigned yet.", "type": "null" } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ], "format": "date", "title": "Lapse Date", "type": "string" }, { "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet.", "title": "No Lapse Date assigned yet.", "type": "null" } ], "title": "Lapse Date" }, "has_submission_document": { "default": false, "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "title": "Has Submission Document", "type": "boolean" }, "has_downloadable_document": { "default": false, "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "title": "Has Downloadable Document", "type": "boolean" }, "origin": { "$ref": "#/components/schemas/v1.LienFilingOrigin", "default": "filed_via_baselayer", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "title": "Lien Filing Origin" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation for the jurisdiction where the amendment is to be filed. It is the jurisdiction of the filing being amended, copied when the amendment is created through `POST /lien_submissions/{filing_id}/amend`, and is not recomputed afterwards.", "title": "Jurisdiction State" }, { "description": "The filing being amended carried no jurisdiction state, so the amendment has none either.", "title": "No Jurisdiction State provided.", "type": "null" } ], "default": null, "title": "State" }, "amending_filing": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response", "description": "The filing that is being amended.", "title": "Amending Filing" } }, "required": [ "filing_type" ], "title": "LienFilingUpdatedWebhook_LienFilingSubmissionUCC3Response (v1)", "type": "object" }, "v1.CollateralType": { "description": "Classifies the collateral grant on a lien filing.", "enum": [ "blanket", "all_receivables", "named_receivables", "all_equipment", "named_equipment", "all_inventory", "named_inventory", "real_property", "agricultural", "other", "not_applicable" ], "title": "CollateralType", "type": "string" }, "v1.LienCollateralStatementResponse": { "description": "Represents the text descriptions of collateral pledged against a lien as\nrecorded in a UCC filing. Each statement details the specific assets\nsecured by the lien and is sorted by a 'sort_order' to maintain\nthe intended sequence of claims.", "properties": { "text": { "description": "A detailed description of the collateral that is subject to the lien.", "examples": [ "2022 Blue Honda Civic" ], "title": "Text", "type": "string" }, "sort_order": { "description": "An integer representing the display or priority order of the collateral statements.", "title": "Sort Order", "type": "integer" } }, "required": [ "text", "sort_order" ], "title": "LienCollateralStatementResponse (v1)", "type": "object" }, "v1.LienFilingResponse": { "description": "Contains detailed information about a lien filing, including the filing\nnumber, type, date, status, and associated business and search request.\nThe model also links to any amendments and the involved parties.", "properties": { "id": { "description": "The identifier of this lien filing record.", "format": "uuid", "title": "Id", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "State abbreviation code where the lien is filed.", "examples": [ "CA" ] }, "filing_number": { "description": "Sequential identifier assigned by the filing office.", "examples": [ "P98172" ], "title": "Filing Number", "type": "string" }, "filing_type": { "description": "Describes the nature of the filing.", "examples": [ "Lien for Loan Default" ], "title": "Filing Type", "type": "string" }, "filing_date": { "description": "Official date when the lien was recorded.", "examples": [ "2023-09-18" ], "format": "date", "title": "Filing Date", "type": "string" }, "lapse_date": { "description": "The expiry date for the lien's claim on collateral.", "examples": [ "2023-04-15" ], "format": "date", "title": "Lapse Date", "type": "string" }, "status": { "description": "Reflects the current legal status of the lien.", "examples": [ "Under Appeal" ], "title": "Status", "type": "string" }, "number_of_pages": { "description": "Reflects the volume of documentation for the lien filing.", "examples": [ 14 ], "title": "Number Of Pages", "type": "integer" }, "document_filename": { "anyOf": [ { "description": "When present, it indicates that a document is available for download; Use get_lien_filing_documents or get_lien_filing_documents_for_business_id to download the documents.", "examples": [ "docket_47182.pdf" ], "title": "The downloadable liens document filename.", "type": "string" }, { "description": "No downloadable documents are available for this lien filing.", "title": "The downloadable document is not available.", "type": "null" } ], "default": null, "title": "Document Filename" }, "parties": { "default": [], "description": "A list of parties associated with this lien filing, encompassing both debtors and secured parties. This relationship is critical for identifying all entities with a vested interest in the lien's terms and outcome.", "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "title": "Parties", "type": "array" }, "amendments": { "default": [], "description": "A chronological list of amendments to this lien filing, detailing any continuations, terminations, or modifications. This historical record is fundamental for tracking the evolution and current standing of the lien.", "items": { "$ref": "#/components/schemas/v1.LienAmendmentResponse" }, "title": "Amendments", "type": "array" }, "collateral_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.CollateralType" }, { "type": "null" } ], "default": null, "description": "The classified type of collateral secured by this lien filing (e.g. blanket, all_receivables, real_property). Null when the collateral type has not been determined." }, "collateral_statements": { "default": [], "description": "A sequence of collateral statements associated with this lien filing, enumerating the specific assets secured by the lien. The order of these statements can denote the priority of claims against the assets.", "items": { "$ref": "#/components/schemas/v1.LienCollateralStatementResponse" }, "title": "Collateral Statements", "type": "array" }, "lien_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The total monetary amount owed for a tax lien filing. Null for non-tax filings. Serialized as a JSON number.", "examples": [ 15432.5 ], "title": "Lien Amount" }, "last_updated_at": { "description": "The date the lien filing record was last updated.", "format": "date", "title": "Last Updated At", "type": "string" }, "match_level": { "anyOf": [ { "$ref": "#/components/schemas/v1.MatchType" }, { "type": "null" } ], "default": null, "description": "The match level of the lien filing to the business name" }, "search_entity_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the entity that the lien filing matched to.", "title": "Search Entity Name" }, "search_entity_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOrPersonType" }, { "type": "null" } ], "default": null, "description": "The type of the entity that the lien filing matched to." } }, "required": [ "id", "state", "filing_number", "filing_type", "filing_date", "lapse_date", "status", "number_of_pages", "last_updated_at" ], "title": "LienFilingResponse (v1)", "type": "object" }, "v1.AdditionalLiensSearchEntityResponse": { "properties": { "name": { "description": "The name of the entity to search for.", "maxLength": 256, "minLength": 1, "title": "Name", "type": "string" }, "type": { "$ref": "#/components/schemas/v1.BusinessOrPersonType", "description": "The type of the entity to search for." }, "search_states": { "description": "The states to search for liens in.", "items": { "$ref": "#/components/schemas/v1.StateAbbreviation" }, "minItems": 1, "title": "Search States", "type": "array" }, "normalized_name": { "readOnly": true, "title": "Normalized Name", "type": "string" } }, "required": [ "name", "type", "search_states", "normalized_name" ], "title": "AdditionalLiensSearchEntityResponse (v1)", "type": "object" }, "v1.VerificationType": { "description": "What a verification verifies: an ``INDIVIDUAL`` alone, or an\nindividual together with the ``BUSINESS`` they operate.", "enum": [ "INDIVIDUAL", "BUSINESS" ], "title": "VerificationType", "type": "string" }, "v1.AccountSettingsResponse": { "description": "The account's active settings.", "properties": { "watchlist_settings": { "$ref": "#/components/schemas/v1.WatchlistSettingsResponse", "description": "Settings for watchlist screening in US and international business searches." }, "lien_settings": { "$ref": "#/components/schemas/v1.LienSettingsResponse", "description": "Settings related to lien searches." }, "business_search_settings": { "$ref": "#/components/schemas/v1.BusinessSearchSettingsResponse", "description": "Settings related to business searches." } }, "required": [ "watchlist_settings", "lien_settings", "business_search_settings" ], "title": "AccountSettingsResponse (v1)", "type": "object" }, "v1.AccountSettingsSource": { "enum": [ "organization", "federation", "system" ], "title": "AccountSettingsSource", "type": "string" }, "v1.BusinessSearchSettingsResponse": { "properties": { "unknown_registration_status_treatment": { "$ref": "#/components/schemas/v1.UnknownRegistrationStatusTreatment", "description": "How the KYB score treats a business whose US Secretary of State registrations all have an unknown status. 'missing_information' leaves the status check out of the score; 'not_active' scores it the same as an inactive registration. International business searches are not affected." } }, "required": [ "unknown_registration_status_treatment" ], "title": "BusinessSearchSettingsResponse (v1)", "type": "object" }, "v1.ContactResponse": { "description": "Represents a contact response.", "properties": { "id": { "description": "The unique identifier of the contact.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the contact.", "title": "Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email of the contact.", "title": "Email" } }, "required": [ "id" ], "title": "ContactResponse (v1)", "type": "object" }, "v1.LienSettingsResponse": { "properties": { "alternative_name_matching_enabled": { "description": "Whether to include liens that match with the searched entity's alternative names, if applicable.", "title": "Alternative Name Matching Enabled", "type": "boolean" }, "suffix_mismatch_matching_enabled": { "description": "Whether to include liens with a suffix mismatch. This will allow matches that are exact in base name but differ in corporate suffix. e.g., 'Acme Holdings Inc' and 'Acme Holdings LLC'.", "title": "Suffix Mismatch Matching Enabled", "type": "boolean" }, "fuzzy_matching_enabled": { "description": "Whether to include liens that match with typos or small spelling variations. e.g., 'Acme Holdngs LLC' and 'Acme Holdings LLC'.", "title": "Fuzzy Matching Enabled", "type": "boolean" }, "collapsed_initialism_matching_enabled": { "description": "Whether to include liens that match with collapsed initialisms. e.g., 'F B I Headquarters' and 'FBI Headquarters'.", "title": "Collapsed Initialism Matching Enabled", "type": "boolean" } }, "required": [ "alternative_name_matching_enabled", "suffix_mismatch_matching_enabled", "fuzzy_matching_enabled", "collapsed_initialism_matching_enabled" ], "title": "LienSettingsResponse (v1)", "type": "object" }, "v1.UnknownRegistrationStatusTreatment": { "description": "How the KYB score treats a business whose US Secretary of State\nregistrations all have an unknown status.", "enum": [ "missing_information", "not_active" ], "title": "UnknownRegistrationStatusTreatment", "type": "string" }, "v1.WatchlistSettingResponse": { "properties": { "enabled": { "description": "Whether US and international business searches screen this watchlist, and whether business search and business responses report its hits. Portfolio monitoring screens the lists its monitoring policy selects instead; person searches and standalone watchlist searches are not affected.", "title": "Enabled", "type": "boolean" }, "similarity_threshold": { "description": "How closely the searched name must match to be reported as a hit in US and international business searches. Portfolio monitoring and person searches use the system default; standalone watchlist searches and OFAC batches take a threshold in the request.", "title": "Similarity Threshold", "type": "number" } }, "required": [ "enabled", "similarity_threshold" ], "title": "WatchlistSettingResponse (v1)", "type": "object" }, "v1.WatchlistSettingsResponse": { "properties": { "ofac": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Office of Foreign Assets Control (OFAC) sanction list" }, "pep": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Politically Exposed Persons (PEP) list" }, "csl": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Consolidated Screening List (CSL) list" }, "fbi": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Federal Bureau of Investigation (FBI) wanted list" }, "cns": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Canadian National Security (CNS) list" }, "oig": { "$ref": "#/components/schemas/v1.WatchlistSettingResponse", "description": "Settings for the Office of Inspector General (OIG) list" } }, "required": [ "ofac", "pep", "csl", "fbi", "cns", "oig" ], "title": "WatchlistSettingsResponse (v1)", "type": "object" }, "v1.ApplicationResponse": { "description": "Represents an application response.", "properties": { "id": { "description": "The unique identifier of the application.", "format": "uuid", "title": "Application Identifier", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the application.", "examples": [ "The Avengers" ], "title": "Application Name" }, "type": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The type of Application.", "examples": [ "sandbox", "production" ], "title": "Application Type" }, "enabled": { "description": "Whether or not the application is enabled for access via the API and Console.", "examples": [ true, false ], "title": "Application Enabled", "type": "boolean" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "An identifier for referencing the application in an external namespace.", "title": "External Identifier" } }, "required": [ "id", "type", "enabled" ], "title": "ApplicationResponse (v1)", "type": "object" }, "v1.FederationResponse": { "description": "Represents a Federation response.", "properties": { "id": { "description": "The unique identifier of the federation.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the federation.", "title": "Name" }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/v1.ContactResponse" }, { "type": "null" } ], "default": null, "description": "The contact for the federation." } }, "required": [ "id" ], "title": "FederationResponse (v1)", "type": "object" }, "v1.LienFilingCollateralStatementTemplate": { "description": "Represents a template for a collateral statement in a UCC-3 filing.", "properties": { "title": { "description": "The title of the collateral statement option.", "title": "Collateral Statement Title", "type": "string" }, "text": { "description": "The text of the collateral statement option.", "title": "Collateral Statement Text", "type": "string" } }, "required": [ "title", "text" ], "title": "LienFilingCollateralStatementTemplate", "type": "object" }, "v1.LienFilingDecisionPolicy": { "description": "One organization's filing rules.", "properties": { "max_liens": { "default": 2, "description": "How many counting liens a business may already have and still be filed against. Above this the row is `no_lien_priority`.", "minimum": 0, "title": "Max Liens", "type": "integer" }, "min_loan_amount": { "anyOf": [ { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, { "type": "null" } ], "default": null, "description": "Rows below this loan amount are excluded before any search runs (`insufficient_amount`). None means no floor.", "title": "Min Loan Amount" }, "state_min_loan_amounts": { "additionalProperties": { "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", "type": "string" }, "description": "Per-state loan floors, keyed by two-letter state, that OVERRIDE `min_loan_amount` for rows filing in that state. A state absent from the map falls back to the global floor; the global floor being None means no floor at all. The console has always offered this control — it was collected and silently discarded, so a lender could set a $75k Texas floor, watch it vanish on reload, and have their $20k Texas rows file anyway.", "title": "State Min Loan Amounts", "type": "object" }, "counting_types": { "description": "Collateral types that count toward `max_liens`, in the vocabulary of `osiris.enums.CollateralType` plus the two values derived from filing_type (`tax`, `judicial`). Order is preserved because it drives the reason-string label.", "items": { "type": "string" }, "title": "Counting Types", "type": "array" }, "disabled_states": { "description": "Two-letter states the customer has switched OFF. Sparse on purpose: a state Baselayer adds coverage for is on by default, rather than silently off because it did not exist when this was saved. States Baselayer cannot search are excluded regardless.", "items": { "type": "string" }, "title": "Disabled States", "type": "array" } }, "title": "LienFilingDecisionPolicy", "type": "object" }, "v1.LienFilingOrganizationSecuredPartyPreference": { "description": "An organization's stored default secured party for lien filings.\n\nThis is the template applied to newly created drafts — not a persisted\nlien party row — so unlike the submission list item it carries no\nparty id.", "properties": { "mailing_address": { "anyOf": [ { "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ], "maxLength": 128, "title": "Mailing Address", "type": "string" }, { "description": "No mailing address is provided for the party.", "title": "No Mailing Address", "type": "null" } ], "default": null, "title": "Mailing Address" }, "city": { "anyOf": [ { "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ], "maxLength": 128, "title": "City", "type": "string" }, { "description": "No city is provided for the party.", "title": "No City", "type": "null" } ], "default": null, "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ], "title": "State" }, { "description": "No state is provided for the party.", "title": "No State", "type": "null" } ], "default": null, "title": "State" }, "postal_code": { "anyOf": [ { "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ], "maxLength": 16, "title": "Postal Code", "type": "string" }, { "description": "No postal code is provided for the party.", "title": "No Postal Code", "type": "null" } ], "default": null, "title": "Postal Code" }, "masked": { "anyOf": [ { "description": "When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492).", "title": "Masked", "type": "boolean" }, { "description": "The secured party is not masked when filing a lien.", "title": "Not Masked", "type": "null" } ], "default": null, "title": "Masked" }, "is_assignor": { "anyOf": [ { "description": "Whether the secured party is the assignor of the lien.", "title": "Is Assignor", "type": "boolean" }, { "description": "The assignor status of the secured party is not specified.", "title": "Assignor Not Specified", "type": "null" } ], "default": null, "title": "Is Assignor" }, "organization_name": { "anyOf": [ { "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ], "maxLength": 128, "title": "Organization Name", "type": "string" }, { "description": "No organization name is provided for the party.", "title": "No Organization Name", "type": "null" } ], "default": null, "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessStructure", "description": "The type of organization involved in the lien filing, if applicable.", "title": "Organization Type" }, { "description": "No organization type is provided for the party.", "title": "No Organization Type", "type": "null" } ], "default": null, "title": "Organization Type" }, "type": { "const": "ORGANIZATION", "default": "ORGANIZATION", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person.", "title": "Organization Party Type", "type": "string" } }, "required": [ "type" ], "title": "LienFilingOrganizationSecuredPartyPreference (v1)", "type": "object" }, "v1.WebhooksVersion": { "enum": [ "0.8", "1.0", "2.0", "2.0" ], "title": "WebhooksVersion", "type": "string" }, "v1.Gender": { "enum": [ "M", "F" ], "title": "Gender", "type": "string" }, "v1.MaritalStatus": { "enum": [ "married", "single", "divorced", "widowed", "separated", "domestic_partner", "civil_union", "other" ], "title": "MaritalStatus", "type": "string" }, "v1.PersonResponse": { "properties": { "id": { "description": "The unique identifier of the person", "examples": [ "5148c819-a580-4df9-b656-b1c5bcbaba25" ], "format": "uuid", "title": "Id", "type": "string" }, "first_name": { "description": "The first name of the person", "examples": [ "John", "Jane" ], "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the person", "examples": [ "Doe", "Smith" ], "title": "Last Name", "type": "string" }, "ssn": { "description": "The social security number of the person", "examples": [ "XXXXX1234" ], "title": "Ssn", "type": "string" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person", "examples": [ "Michael", "James", "T" ], "title": "Middle Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number of the person in E164 format", "examples": [ "+17075489914", "+442071838750" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email address of the person", "examples": [ "johndoe@example.com", "janesmith@example.com" ], "title": "Email" }, "date_of_birth": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of birth of the person", "examples": [ "1990-01-15" ], "title": "Date Of Birth" }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/v1.Gender" }, { "type": "null" } ], "default": null, "description": "The gender of the person", "examples": [ "M", "F" ] }, "marital_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.MaritalStatus" }, { "type": "null" } ], "default": null, "description": "The marital status of the person", "examples": [ "married", "single" ] }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The suffix of the person", "examples": [ "Jr.", "Sr." ], "title": "Suffix" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The title of the person", "examples": [ "Mr.", "Mrs." ], "title": "Title" }, "created_at": { "description": "When the person record was created", "examples": [ "2025-01-15T12:00:00Z" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the person record was last updated", "examples": [ "2025-01-15T12:00:00Z" ], "title": "Updated At" }, "dockets": { "default": [], "description": "The dockets associated with the person", "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "title": "Dockets", "type": "array" }, "liens": { "default": [], "description": "The liens associated with the person", "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "title": "Liens", "type": "array" }, "watchlist_hits": { "default": [], "description": "The watchlist hits associated with the person.", "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "title": "Watchlist Hits", "type": "array" } }, "required": [ "id", "first_name", "last_name", "ssn", "created_at" ], "title": "PersonResponse (v1)", "type": "object" }, "v1.LienMonitoringScope": { "description": "The scope of states that will be monitored for liens.\n\nWhen the scope is \"domestic\", the policy will monitor liens for the state\n of the domestic registration.\nWhen the scope is \"registered\", the policy will monitor liens for the states\n of all registrations.", "enum": [ "domestic", "registered" ], "title": "LienMonitoringScope", "type": "string" }, "v1.MonitorableAttributes": { "description": "The attributes that can be monitored.", "enum": [ "sos", "liens", "litigations", "bankruptcies", "website_analysis", "pep", "ofac", "identity_network" ], "title": "MonitorableAttributes", "type": "string" }, "v1.MonitoringCadence": { "description": "The cadence of monitoring.", "enum": [ "daily", "weekly", "biweekly", "monthly", "quarterly", "biannually", "annually" ], "title": "MonitoringCadence", "type": "string" }, "v1.NotifiableAttributes": { "enum": [ "registration_health", "new_registrations", "addresses", "officers", "alternative_names", "kyb_score", "risk_score", "identity_network", "pep", "ofac", "liens", "litigations", "bankruptcies", "website_analysis" ], "type": "string" }, "v1.NotificationPolicyType": { "description": "The type of notification policy.", "enum": [ "email" ], "title": "NotificationPolicyType", "type": "string" }, "v1.PolicyScope": { "description": "The scope of a portfolio monitoring policy.", "enum": [ "portfolio", "group", "item" ], "title": "PolicyScope", "type": "string" }, "v1.InheritedFrom": { "enum": [ "portfolio", "group" ], "title": "InheritedFrom", "type": "string" }, "v1.AttachmentResponseModel": { "description": "Represents an attachment response.", "properties": { "id": { "description": "The UUID of the attachment.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the attachment.", "examples": [ "attachment.pdf" ], "title": "Name", "type": "string" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null, "description": "The user who uploaded the attachment." }, "item_id": { "description": "The UUID of the portfolio item that the attachment is associated with.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Item Id", "type": "string" }, "created_at": { "description": "The timestamp of when the attachment was uploaded.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "title": "Created At", "type": "string" }, "redirect_url": { "readOnly": true, "title": "Redirect Url", "type": "string" } }, "required": [ "id", "name", "item_id", "created_at", "redirect_url" ], "title": "AttachmentResponseModel (v1)", "type": "object" }, "v1.BusinessPortfolioItemResponse": { "description": "Represents a business portfolio item", "properties": { "id": { "description": "The unique identifier of the portfolio item.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "search_id": { "description": "The unique identifier of the search that the portfolio item is based on.", "examples": [ "c623e29e-1f57-11ef-938f-1edb1b067314" ], "format": "uuid", "title": "Search Id", "type": "string" }, "name": { "description": "The name of the portfolio item.", "title": "Name", "type": "string" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The UUID of the portfolio group that the item belongs to.", "title": "Group Id" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null, "description": "The user who created the portfolio item." }, "comments": { "default": [], "items": { "$ref": "#/components/schemas/v1.PortfolioItemCommentResponse" }, "title": "Comments", "type": "array" }, "attachments": { "default": [], "items": { "$ref": "#/components/schemas/v1.AttachmentResponseModel" }, "title": "Attachments", "type": "array" }, "scores": { "default": [], "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "title": "Scores", "type": "array" }, "created_at": { "description": "The timestamp of when the portfolio item was created.", "format": "date-time", "title": "Created At", "type": "string" }, "last_monitored_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The timestamp of when the portfolio item was last monitored.", "title": "Last Monitored At" }, "type": { "const": "Business", "description": "The type of the portfolio item.", "title": "Type", "type": "string" }, "business": { "$ref": "#/components/schemas/v1.BusinessSummaryResponse", "description": "The business associated with the portfolio item." } }, "required": [ "id", "search_id", "name", "created_at", "type", "business" ], "title": "BusinessPortfolioItemResponse (v1)", "type": "object" }, "v1.PersonPortfolioItemResponse": { "description": "Represents a person portfolio item", "properties": { "id": { "description": "The unique identifier of the portfolio item.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "search_id": { "description": "The unique identifier of the search that the portfolio item is based on.", "examples": [ "c623e29e-1f57-11ef-938f-1edb1b067314" ], "format": "uuid", "title": "Search Id", "type": "string" }, "name": { "description": "The name of the portfolio item.", "title": "Name", "type": "string" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The UUID of the portfolio group that the item belongs to.", "title": "Group Id" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null, "description": "The user who created the portfolio item." }, "comments": { "default": [], "items": { "$ref": "#/components/schemas/v1.PortfolioItemCommentResponse" }, "title": "Comments", "type": "array" }, "attachments": { "default": [], "items": { "$ref": "#/components/schemas/v1.AttachmentResponseModel" }, "title": "Attachments", "type": "array" }, "scores": { "default": [], "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "title": "Scores", "type": "array" }, "created_at": { "description": "The timestamp of when the portfolio item was created.", "format": "date-time", "title": "Created At", "type": "string" }, "last_monitored_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The timestamp of when the portfolio item was last monitored.", "title": "Last Monitored At" }, "type": { "const": "Person", "description": "The type of the portfolio item.", "title": "Type", "type": "string" }, "person": { "$ref": "#/components/schemas/v1.PersonSummaryResponse", "description": "The person associated with the portfolio item." } }, "required": [ "id", "search_id", "name", "created_at", "type", "person" ], "title": "PersonPortfolioItemResponse (v1)", "type": "object" }, "v1.PersonSummaryResponse": { "properties": { "id": { "description": "The unique identifier of the person", "examples": [ "689b0b55-2e93-4251-bdc6-36a735556ac6" ], "format": "uuid", "title": "Id", "type": "string" }, "first_name": { "description": "The first name of the person", "examples": [ "John", "Jane" ], "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the person", "examples": [ "Doe", "Smith" ], "title": "Last Name", "type": "string" }, "ssn": { "description": "The social security number of the person", "examples": [ "XXXXX1234" ], "title": "Ssn", "type": "string" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person", "examples": [ "Michael", "James", "T" ], "title": "Middle Name" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The suffix of the person", "examples": [ "Jr.", "Sr." ], "title": "Suffix" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The title of the person", "examples": [ "Mr.", "Mrs." ], "title": "Title" }, "created_at": { "description": "When the person record was created", "examples": [ "2025-01-15T12:00:00Z" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the person record was last updated", "examples": [ "2025-01-15T12:00:00Z" ], "title": "Updated At" } }, "required": [ "id", "first_name", "last_name", "ssn", "created_at" ], "title": "PersonSummaryResponse (v1)", "type": "object" }, "v1.PortfolioItemCommentResponse": { "description": "Represents a comment on a portfolio item.", "properties": { "id": { "description": "The UUID of the comment.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "text": { "description": "The text of the comment.", "title": "Text", "type": "string" }, "user": { "$ref": "#/components/schemas/v1.UserAttributionResponse", "description": "The user who made the comment." }, "item_id": { "description": "The UUID of the portfolio item that the comment is associated with.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Item Id", "type": "string" }, "created_at": { "description": "The timestamp of when the comment was made.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "title": "Created At", "type": "string" } }, "required": [ "id", "text", "user", "item_id", "created_at" ], "title": "PortfolioItemCommentResponse (v1)", "type": "object" }, "v1.ApplicationDetailCombinationsResponse": { "description": "Represents an application detail combinations response.", "properties": { "created_at": { "description": "The date and time when the search was created.", "examples": [ "2026-10-29T05:44:47.853784" ], "format": "date-time", "title": "Created At", "type": "string" }, "name": { "description": "The name inputted on the search.", "examples": [ "Clark PLC" ], "title": "Name", "type": "string" }, "address": { "description": "The address inputted on the search.", "examples": [ "63788 Paige Lane Cooperfurt, MI 10037" ], "title": "Address", "type": "string" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The TIN inputted on the search.", "examples": [ "123456789" ], "title": "Tin" }, "officer_names": { "default": [], "description": "The officer names inputted on the search.", "examples": [ [ "Louis Schneider" ] ], "items": { "type": "string" }, "title": "Officer Names", "type": "array" } }, "required": [ "created_at", "name", "address" ], "title": "ApplicationDetailCombinationsResponse (v1)", "type": "object" }, "v1.ApplicationVelocityResponse": { "description": "Represents an application velocity response.", "properties": { "created_at": { "description": "The date and time when the application was submitted.", "examples": [ "2026-10-22T05:44:47.853294" ], "format": "date-time", "title": "Created At", "type": "string" }, "type": { "$ref": "#/components/schemas/v1.OrganizationType", "description": "The type of organization that submitted the application.", "examples": [ "community_bank", "credit_union" ] }, "team": { "anyOf": [ { "$ref": "#/components/schemas/v1.OrganizationTeam" }, { "type": "null" } ], "default": null, "description": "The team within the organization that submitted the application.", "examples": [ "compliance", "risk" ] }, "product": { "anyOf": [ { "$ref": "#/components/schemas/v1.OrganizationProduct" }, { "type": "null" } ], "default": null, "description": "The financial product type for which the application was submitted.", "examples": [ "credit", "working_capital" ] } }, "required": [ "created_at", "type" ], "title": "ApplicationVelocityResponse (v1)", "type": "object" }, "v1.BusinessPortfolioItemSnapshotData": { "description": "Represents the data of a business portfolio item snapshot.", "properties": { "type": { "const": "Business", "description": "The type of the portfolio item snapshot data.", "title": "Type", "type": "string" }, "business": { "$ref": "#/components/schemas/v1.BusinessResponse", "description": "The business associated with the snapshot. Fields derived from the capture date rather than from the business, such as months_in_business, are not stored; derive them from incorporation_date and the snapshot's created_at." }, "scores": { "description": "The scores associated with the business in the snapshot.", "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "title": "Scores", "type": "array" }, "liens": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "type": "array" }, { "type": "null" } ], "description": "The liens associated with the business in the snapshot.", "title": "Liens" }, "dockets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array" }, { "type": "null" } ], "description": "The dockets associated with the business in the snapshot.", "title": "Dockets" }, "bankruptcies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array" }, { "type": "null" } ], "description": "The bankruptcies associated with the business in the snapshot.", "title": "Bankruptcies" }, "business_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The website analysis associated with the business in the snapshot. The WHOIS record's domain_age_months is not stored." }, "item_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The website analysis associated with the portfolio item in the snapshot. The WHOIS record's domain_age_months is not stored." }, "search_combinations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ApplicationDetailCombinationsResponse" }, "type": "array" }, { "type": "null" } ], "description": "The search combinations associated with the business in the snapshot.", "title": "Search Combinations" }, "search_history": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ApplicationVelocityResponse" }, "type": "array" }, { "type": "null" } ], "description": "The search history associated with the business in the snapshot.", "title": "Search History" } }, "required": [ "business", "scores", "liens", "dockets", "bankruptcies", "business_website_analysis", "item_website_analysis", "search_combinations", "search_history", "type" ], "title": "BusinessPortfolioItemSnapshotData (v1)", "type": "object" }, "v1.PersonPortfolioItemSnapshotData": { "description": "Represents the data of a person portfolio item snapshot.", "properties": { "type": { "const": "Person", "description": "The type of the portfolio item snapshot data.", "title": "Type", "type": "string" }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person associated with the snapshot." }, "liens": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "type": "array" }, { "type": "null" } ], "description": "The liens associated with the person in the snapshot.", "title": "Liens" }, "dockets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array" }, { "type": "null" } ], "description": "The dockets associated with the person in the snapshot.", "title": "Dockets" }, "bankruptcies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array" }, { "type": "null" } ], "description": "The bankruptcies associated with the person in the snapshot.", "title": "Bankruptcies" } }, "required": [ "person", "liens", "dockets", "bankruptcies", "type" ], "title": "PersonPortfolioItemSnapshotData (v1)", "type": "object" }, "v1.SSLCertificateType": { "description": "Type of SSL certificate based on validation level.\n\nDV (Domain Validation): Only domain ownership verified - easiest to obtain\nOV (Organization Validation): Organization identity verified\nEV (Extended Validation): Extensive organization verification - highest trust", "enum": [ "DV", "OV", "EV", "Unknown" ], "title": "SSLCertificateType", "type": "string" }, "v1.SSLInvalidReason": { "description": "Reasons why an SSL certificate check failed or could not be determined.\n\nUsed when is_valid is False (certificate invalid) or None (indeterminate).", "enum": [ "CERTIFICATE_EXPIRED", "HOSTNAME_MISMATCH", "SELF_SIGNED", "REVOKED", "UNTRUSTED_AUTHORITY", "VERIFICATION_FAILED", "NOT_HTTPS", "CONNECTION_TIMED_OUT", "UNABLE_TO_CONNECT", "SERVER_DISCONNECTED", "SERVER_ERROR", "CONNECTION_ERROR" ], "title": "SSLInvalidReason", "type": "string" }, "v1.SSLValidityInfo": { "description": "SSL certificate information with fraud-relevant signals.\n\nis_valid semantics:\n True: Certificate is valid and trusted\n False: Certificate is definitively invalid (expired, untrusted, revoked, etc.)\n None: Cannot determine (connection failed, timeout, non-HTTPS)", "properties": { "is_valid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SSL certificate is valid (True=valid, False=invalid, None=indeterminate)", "title": "Is Valid" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.SSLInvalidReason" }, { "type": "null" } ], "default": null, "description": "Reason if SSL certificate is invalid or indeterminate", "examples": [ "CERTIFICATE_EXPIRED", "HOSTNAME_MISMATCH", "SELF_SIGNED", "UNABLE_TO_CONNECT" ] }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Certificate issuer (CA) common name", "examples": [ "DigiCert Global Root CA", "R3" ], "title": "Issuer" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Certificate subject common name", "examples": [ "www.example.com", "*.example.com" ], "title": "Subject" }, "issued_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the certificate was issued", "title": "Issued Date" }, "expiry_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the certificate expires", "title": "Expiry Date" }, "days_until_expiry": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days until certificate expires (negative if expired)", "examples": [ 365, 30, -5 ], "title": "Days Until Expiry" }, "cert_age_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days since certificate was issued", "examples": [ 180, 30, 5 ], "title": "Cert Age Days" }, "certificate_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.SSLCertificateType" }, { "type": "null" } ], "default": null, "description": "Certificate validation level (DV=Domain only, OV=Organization verified, EV=Extended validation)", "examples": [ "DV", "EV" ] }, "is_wildcard": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a wildcard certificate (*.example.com)", "title": "Is Wildcard" }, "key_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Public key size in bits", "examples": [ 2048, 4096, 256 ], "title": "Key Size" }, "tls_version": { "anyOf": [ { "$ref": "#/components/schemas/v1.TLSVersion" }, { "type": "null" } ], "default": null, "description": "TLS protocol version used", "examples": [ "TLSv1.2", "TLSv1.3" ] }, "is_self_signed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the certificate is self-signed (not trusted by a CA)", "title": "Is Self Signed" }, "is_revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the certificate has been revoked (via OCSP check)", "title": "Is Revoked" } }, "title": "SSLValidityInfo", "type": "object" }, "v1.SocialProfile": { "properties": { "site": { "description": "The type of social profile.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "username": { "description": "The username of the social profile.", "examples": [ "certifiedpowerinc" ], "title": "Username", "type": "string" }, "url": { "description": "The URL of the social profile.", "examples": [ "https://www.instagram.com/certifiedpowerinc" ], "readOnly": true, "title": "Url", "type": "string" } }, "required": [ "site", "username", "url" ], "title": "SocialProfile", "type": "object" }, "v1.TLSVersion": { "description": "TLS protocol version used for SSL connections.", "enum": [ "TLSv1.0", "TLSv1.1", "TLSv1.2", "TLSv1.3", "SSLv3", "Unknown" ], "title": "TLSVersion", "type": "string" }, "v1.WebsiteAnalysisDetails": { "properties": { "id": { "description": "The ID of the Website Analysis request", "format": "uuid", "title": "Id", "type": "string" }, "url": { "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.warner.com/" ], "format": "uri", "minLength": 1, "title": "Url", "type": "string" }, "redirects": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteRedirectInfo" }, { "type": "null" } ], "default": null, "description": "Redirect information for this website, if a cross-domain redirect was detected.", "examples": [ { "is_redirect_url": true, "redirects_to": "baselayer.com" } ] }, "parked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "A boolean indicating if the website is suspected of being a parked domain.", "examples": [ true, false ], "title": "Parked" }, "email_deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "A boolean indicating if the website is able to send and receive emails.", "examples": [ true, false ], "title": "Email Deliverable" }, "phone_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of phone numbers that were identified on the analyzed website.", "examples": [ [ "362-345-4551", "(872) 628-1402" ] ], "title": "Phone Numbers" }, "emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of email addresses that were identified on the analyzed website.", "examples": [ [ "bennettamber@example.org", "goldenshawn@example.com" ] ], "title": "Emails" }, "social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.SocialProfile" }, "type": "array" }, { "type": "null" } ], "description": "The list of social media profiles that were identified on the analyzed website.", "examples": [ [ { "site": "twitter", "url": "https://twitter.com/michelle98", "username": "michelle98" } ] ], "title": "Social Profiles" }, "addresses": { "default": [], "description": "The list of mailing addresses that were identified on the analyzed website.", "items": { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, "title": "Addresses", "type": "array" }, "people": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebsiteAnalysisPerson" }, "type": "array" }, { "type": "null" } ], "description": "The list of people identified on the analyzed website.", "examples": [ [ { "name": "Jane Smith", "titles": [ "Co-Founder", "CEO" ] }, { "name": "John Doe", "titles": [ "CTO" ] } ] ], "title": "People" }, "website_build_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteBuildStatus" }, { "type": "null" } ], "default": null, "description": "The build status of the website." }, "website_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A summary of the business based on the analyzed website content.", "examples": [ "Howard Concrete Pumping Co., Inc. is a concrete pumping contractor serving the construction industry. The company specializes in concrete placement services for residential and commercial construction projects. They operate throughout the greater metropolitan area and have been providing reliable concrete pumping solutions for over 20 years." ], "title": "Website Summary" }, "console_url": { "description": "The URL to the Website Analysis details in the console.", "examples": [ "https://console.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Console Url", "type": "string" }, "screenshot_url": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The URL to download the homepage screenshot of the analyzed website.", "examples": [ "https://api.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis/screenshot" ], "title": "Screenshot Url" }, "whois_record": { "anyOf": [ { "$ref": "#/components/schemas/v1.WhoIsRecordResponse" }, { "type": "null" } ], "default": null, "description": "The WHOIS record information for the analyzed website." }, "ssl_validity": { "anyOf": [ { "$ref": "#/components/schemas/v1.SSLValidityInfo" }, { "type": "null" } ], "default": null, "description": "The SSL certificate validity information for the analyzed website, including fraud-relevant signals.", "examples": [ { "cert_age_days": 185, "certificate_type": "EV", "days_until_expiry": 180, "expiry_date": "2025-01-15T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-01-15T00:00:00", "issuer": "DigiCert Global Root CA", "key_size": 2048, "reason": null, "subject": "www.example.com", "tls_version": "TLSv1.3" }, { "cert_age_days": 395, "certificate_type": "DV", "days_until_expiry": -30, "expiry_date": "2024-01-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": false, "is_wildcard": false, "issued_date": "2023-01-01T00:00:00", "issuer": "R3", "key_size": 256, "reason": "CERTIFICATE_EXPIRED", "subject": "expired.example.com", "tls_version": "TLSv1.2" } ] }, "website_structure_metrics": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteStructureMetrics" }, { "type": "null" } ], "default": null, "description": "Website structure metrics including depth and breadth discovered during scraping.", "examples": [ { "breadth": "15+", "depth": "2+" }, { "breadth": "5", "depth": "1" }, { "breadth": "1", "depth": "0" } ] } }, "required": [ "id", "url", "parked", "emails", "social_profiles", "console_url" ], "title": "WebsiteAnalysisDetails (v1)", "type": "object" }, "v1.WebsiteAnalysisPerson": { "properties": { "name": { "title": "Name", "type": "string" }, "titles": { "items": { "type": "string" }, "title": "Titles", "type": "array", "uniqueItems": true } }, "required": [ "name", "titles" ], "title": "WebsiteAnalysisPerson", "type": "object" }, "v1.WebsiteBuildStatus": { "enum": [ "coming_soon", "inactive", "active" ], "title": "WebsiteBuildStatus", "type": "string" }, "v1.WebsiteRedirectInfo": { "properties": { "is_redirect_url": { "description": "Indicates that this website performs a cross-domain redirect.", "examples": [ true ], "title": "Is Redirect Url", "type": "boolean" }, "redirects_to": { "description": "The domain this website redirects to.", "examples": [ "baselayer.com" ], "title": "Redirects To", "type": "string" } }, "required": [ "is_redirect_url", "redirects_to" ], "title": "WebsiteRedirectInfo (v1)", "type": "object" }, "v1.WebsiteStructureMetrics": { "description": "Website structure metrics discovered during scraping.\n\nFormatted as strings for display:\n- depth: \"0\", \"1\", or \"2+\"\n- breadth: actual count as string or \"15+\"", "properties": { "depth": { "description": "Maximum depth reached: '0' (homepage only), '1' (one level), or '2+' (structured site)", "examples": [ "0", "1", "2+" ], "title": "Depth", "type": "string" }, "breadth": { "description": "Total unique pages discovered: actual count or '15+' for substantial sites", "examples": [ "5", "12", "15+" ], "title": "Breadth", "type": "string" } }, "required": [ "depth", "breadth" ], "title": "WebsiteStructureMetrics", "type": "object" }, "v1.WhoIsRecordResponse": { "properties": { "domain_created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain was first registered.", "examples": [ "2020-05-15T10:30:00Z" ], "title": "Domain Created At" }, "domain_age_months": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The age of the domain since its creation in months.", "examples": [ 15 ], "title": "Domain Age Months" }, "domain_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain registration was last updated.", "examples": [ "2023-06-01T14:45:00Z" ], "title": "Domain Updated At" }, "domain_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain registration is set to expire.", "examples": [ "2025-05-15T10:30:00Z" ], "title": "Domain Expires At" }, "registrar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the domain registrar.", "examples": [ "Example Registrar Inc." ], "title": "Registrar" } }, "required": [ "domain_created_at", "domain_updated_at", "domain_expires_at", "registrar" ], "title": "WhoIsRecordResponse (v1)", "type": "object" }, "v1.BusinessPortfolioItemSummaryResponse": { "description": "Represents a summary of a business portfolio item.", "properties": { "id": { "description": "The unique identifier of the portfolio item.", "format": "uuid", "title": "Id", "type": "string" }, "search_id": { "description": "The unique identifier of the search that the portfolio item is based on.", "examples": [ "c623e29e-1f57-11ef-938f-1edb1b067314" ], "format": "uuid", "title": "Search Id", "type": "string" }, "name": { "description": "The name of the portfolio item.", "title": "Name", "type": "string" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The unique identifier of the portfolio group.", "title": "Group Id" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null, "description": "The user who created the portfolio item." }, "created_at": { "description": "The timestamp of when the portfolio item was created.", "format": "date-time", "title": "Created At", "type": "string" }, "type": { "const": "Business", "description": "The type of the portfolio item.", "title": "Type", "type": "string" }, "business_id": { "description": "The UUID of the business associated with the portfolio item.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Business Id", "type": "string" }, "business_url": { "description": "The URL to the business details.", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Business Url", "type": "string" }, "item_url": { "readOnly": true, "title": "Item Url", "type": "string" }, "group_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Group Url" }, "console_url": { "readOnly": true, "title": "Console Url", "type": "string" } }, "required": [ "id", "search_id", "name", "created_at", "type", "business_id", "business_url", "item_url", "group_url", "console_url" ], "title": "BusinessPortfolioItemSummaryResponse (v1)", "type": "object" }, "v1.PersonPortfolioItemSummaryResponse": { "description": "Represents a summary of a person portfolio item.", "properties": { "id": { "description": "The unique identifier of the portfolio item.", "format": "uuid", "title": "Id", "type": "string" }, "search_id": { "description": "The unique identifier of the search that the portfolio item is based on.", "examples": [ "c623e29e-1f57-11ef-938f-1edb1b067314" ], "format": "uuid", "title": "Search Id", "type": "string" }, "name": { "description": "The name of the portfolio item.", "title": "Name", "type": "string" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The unique identifier of the portfolio group.", "title": "Group Id" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null, "description": "The user who created the portfolio item." }, "created_at": { "description": "The timestamp of when the portfolio item was created.", "format": "date-time", "title": "Created At", "type": "string" }, "type": { "const": "Person", "description": "The type of the portfolio item.", "title": "Type", "type": "string" }, "person_id": { "description": "The UUID of the person associated with the portfolio item.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Person Id", "type": "string" }, "person_url": { "description": "The URL to the person details.", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Person Url", "type": "string" }, "item_url": { "readOnly": true, "title": "Item Url", "type": "string" }, "group_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Group Url" }, "console_url": { "readOnly": true, "title": "Console Url", "type": "string" } }, "required": [ "id", "search_id", "name", "created_at", "type", "person_id", "person_url", "item_url", "group_url", "console_url" ], "title": "PersonPortfolioItemSummaryResponse (v1)", "type": "object" }, "v1.PortfolioItemNotificationSummary": { "properties": { "attribute": { "enum": [ "registration_health", "new_registrations", "addresses", "officers", "alternative_names", "kyb_score", "risk_score", "identity_network", "pep", "ofac", "liens", "litigations", "bankruptcies", "website_analysis" ], "type": "string" }, "count": { "title": "Count", "type": "integer" } }, "required": [ "attribute", "count" ], "title": "PortfolioItemNotificationSummary", "type": "object" }, "v1.PortfolioItemSummaryResponse": { "description": "Portfolio item summary response - either Business or Person based on the item type.\n\nThis is a discriminated union that selects the appropriate response type\nbased on the `type` field.", "discriminator": { "mapping": { "Business": "#/components/schemas/v1.BusinessPortfolioItemSummaryResponse", "Person": "#/components/schemas/v1.PersonPortfolioItemSummaryResponse" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessPortfolioItemSummaryResponse" }, { "$ref": "#/components/schemas/v1.PersonPortfolioItemSummaryResponse" } ], "title": "PortfolioItemSummaryResponse" }, "v1.PortfolioMonitoringNotificationResponse": { "description": "Represents a notification for a portfolio item.", "properties": { "message": { "$ref": "#/components/schemas/v1.StructuredText", "description": "The message of the notification." }, "notifiable_attribute": { "$ref": "#/components/schemas/v1.NotifiableAttributes", "description": "The attribute that triggered the notification." } }, "required": [ "message", "notifiable_attribute" ], "title": "PortfolioMonitoringNotificationResponse (v1)", "type": "object" }, "v1.SemanticType": { "description": "SemanticType is an enumeration of the different types of semantic segments\nthat a text can have. It is used to structure and annotate text in a way\nthat can be helpful for stylized rendering in a UI, without forcing a\nparticular style.", "enum": [ "regular", "subject", "value", "label", "actor" ], "title": "SemanticType", "type": "string" }, "v1.StructuredText": { "description": "This class represents a structured text in the application.\n\nStructuredText is used to annotate individual parts of the text with semantic types.\nThis is helpful to the UI for stylized rendering. It provides a way to structure\nthe text in a way that can be easily understood and manipulated by the UI.", "properties": { "components": { "description": "The structured text annotates individual parts of the text with semantic types, which is helpful to the UI for stylized rendering.", "items": { "$ref": "#/components/schemas/v1.TextComponent" }, "title": "An array of components that form the structured text", "type": "array" }, "text": { "description": "The same content as found in the components, but without any styling.", "readOnly": true, "title": "A plain text representation of the content", "type": "string" } }, "required": [ "components", "text" ], "title": "StructuredText (v1)", "type": "object" }, "v1.TextComponent": { "description": "A TextComponent is a segment of text with a semantic type and optional hyperlink.\n\nIt is used to structure and annotate text in a way that can be helpful for\nstylized rendering in a UI without forcing a particular style.\n\nEach TextComponent has a type (subject, value, state, etc.),\nthe actual text content, and an optional URL that points to the entity the text describes.", "properties": { "type": { "$ref": "#/components/schemas/v1.SemanticType", "description": "The text component can describe subjects, values, states and more.", "title": "The semantic type of the text component" }, "text": { "description": "This is the text part that composes the whole sentence within the StructuredText.", "title": "The actual string content of the text component", "type": "string" }, "for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The entity that the text describes. When present, it points to the entity that the text describes.", "title": "The entity that the text describes." }, "url": { "anyOf": [ { "description": "When present, it points to the entity that the text describes.", "format": "uri", "minLength": 1, "title": "Hyperlink to the entity", "type": "string" }, { "description": "When not present, the text is presented in regular format.", "title": "No hyperlink provided.", "type": "null" } ], "default": null, "title": "Url" } }, "required": [ "type", "text" ], "title": "TextComponent (v1)", "type": "object" }, "v1.ReasonCodeCategory": { "description": "The business domain a reason code belongs to — display and grouping.", "enum": [ "identity", "address", "officers", "web_presence", "industry", "credit", "network", "adverse", "reviews" ], "title": "ReasonCodeCategory", "type": "string" }, "v1.ReasonCodeSeverity": { "description": "Baselayer's recommended response tier. Guidance, not contract.", "enum": [ "high", "medium", "low" ], "title": "ReasonCodeSeverity", "type": "string" }, "v1.MLAResponseEligibility": { "properties": { "covered": { "description": "This indicates if the person was on active duty on the active duty status date", "title": "Covered", "type": "boolean" }, "transaction_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DMDC TransactionID / CertificateID", "title": "Transaction Id" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Base64 content of DMDC Certificate", "title": "Content" }, "certificate_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The type of certificate returned by DMDC", "title": "Certificate Type" } }, "required": [ "covered" ], "title": "MLAResponseEligibility", "type": "object" }, "v1.MLAResponsePerson": { "properties": { "pn_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Either a social security number (SSN) or an individual taxpayer identification number (ITIN)", "title": "Pn Id" }, "pn_id_confirmation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Pn Id Confirmation" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first name of the person of interest as provided in the request", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The last name of the person of interest as provided in the request", "title": "Last Name" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person of interest as provided in the request", "title": "Middle Name" }, "date_of_birth": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of birth of the person of interest as provided in the request", "title": "Date Of Birth" }, "pn_id_type_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.PnIdTypeCode" }, { "type": "null" } ], "default": null, "description": "The person identifier type code is a single alphanumeric character. It is either an “S” for social security number or an “I” for individual taxpayer identification number" } }, "title": "MLAResponsePerson", "type": "object" }, "v1.MLAResponseResult": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DMDC TransactionID", "title": "Id" }, "person_request": { "$ref": "#/components/schemas/v1.MLAResponsePerson" }, "eligibility": { "$ref": "#/components/schemas/v1.MLAResponseEligibility" } }, "required": [ "person_request", "eligibility" ], "title": "MLAResponseResult", "type": "object" }, "v1.PnIdTypeCode": { "enum": [ "S", "I" ], "title": "PnIdTypeCode", "type": "string" }, "v1.IncludeSuffix": { "enum": [ "None", "OriginalOnly", "All" ], "title": "IncludeSuffix", "type": "string" }, "v1.MiddleNameParse": { "enum": [ "None", "Share", "ShareMerge", "AppendMiddleInitial", "AppendMiddleInitialAll" ], "title": "MiddleNameParse", "type": "string" }, "v1.ParseModel": { "enum": [ "NameSegmentParse", "None" ], "title": "ParseModel", "type": "string" }, "v1.ParsePermutateOptions": { "properties": { "keep_original": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Allows original name to be searched even in case of name containing known words along with any name variations generated", "title": "Keep Original" }, "first_name_remove_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "CSV list of string values to remove from first name", "title": "First Name Remove List" }, "last_name_remove_list": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "CSV list of string values to remove from last name", "title": "Last Name Remove List" }, "middle_name_parse": { "anyOf": [ { "$ref": "#/components/schemas/v1.MiddleNameParse" }, { "type": "null" } ], "default": null }, "force_hyphen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Generates additional name variations only on two part last names delimited by a spaces replacing the space with a hyphen", "title": "Force Hyphen" }, "include_suffix": { "anyOf": [ { "$ref": "#/components/schemas/v1.IncludeSuffix" }, { "type": "null" } ], "default": null }, "parse_prefix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Attempts to locate and remove Prefix out of the first name", "title": "Parse Prefix" }, "parse_suffix": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Attempts to locate and remove Suffix out of the last name", "title": "Parse Suffix" }, "max_permutation_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 50, "description": "Sets maximum amount of permutations. Default is 50", "title": "Max Permutation Count" }, "merge_name_parts": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Merges compound name parts into a single name. Merging occurs on any number of name parts provided", "title": "Merge Name Parts" }, "mixed_case_split": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Mixed Case Split" }, "suppress_hyphen_parse": { "anyOf": [ { "$ref": "#/components/schemas/v1.SuppressHyphenParse" }, { "type": "null" } ], "default": null }, "toggle_middle_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Ability to generate name variations with/without middle name", "title": "Toggle Middle Name" }, "toggle_primary_name": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Ability to generate name variations with/without first name", "title": "Toggle Primary Name" }, "transpose": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Transposes name parts to generate all unique variations. Transposing occurs on any number of name parts provided", "title": "Transpose" }, "validate_permutation_count": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Validate Permutation Count" }, "remove_nobiliary_participle": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Remove Nobiliary Participle" }, "parse_model": { "anyOf": [ { "$ref": "#/components/schemas/v1.ParseModel" }, { "type": "null" } ], "default": null } }, "title": "ParsePermutateOptions", "type": "object" }, "v1.SuppressHyphenParse": { "enum": [ "Never", "MultipleOnly", "Always" ], "title": "SuppressHyphenParse", "type": "string" }, "v1.DepartmentOfDefensePositionCode": { "enum": [ "AG", "AJ", "AR", "AV", "AZ", "CJ", "CR", "CV", "CZ", "FG", "FJ", "FR", "FV", "HR", "MR", "MV", "MZ", "NJ", "NR", "NV", "OR", "SR", "SV", "ZZ" ], "title": "DepartmentOfDefensePositionCode", "type": "string" }, "v1.SCRAResponseEligibility": { "properties": { "covered": { "description": "This indicates if the person was on active duty on the active duty status date", "title": "Covered", "type": "boolean" }, "transaction_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DMDC TransactionID / CertificateID", "title": "Transaction Id" }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Base64 content of DMDC Certificate", "title": "Content" }, "date_of_interest": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Date Of Interest" }, "active_duty_covered": { "description": "This indicates if the person was on active duty on the active duty status date", "title": "Active Duty Covered", "type": "boolean" }, "active_duty_start_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the servicemember entered active duty", "title": "Active Duty Start Date" }, "active_duty_end_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the servicemember ended active duty", "title": "Active Duty End Date" }, "active_duty_service_component_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.DepartmentOfDefensePositionCode" }, { "type": "null" } ], "default": null, "description": "The code used by the DoD that identifies the service position of the servicemember" }, "active_duty_service_component_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Active Duty Service Component String" }, "early_indication_covered": { "title": "Early Indication Covered", "type": "boolean" }, "early_indication_start_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The start date of the order notification", "title": "Early Indication Start Date" }, "early_indication_end_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The end date of the order notification", "title": "Early Indication End Date" }, "early_indication_service_component_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.DepartmentOfDefensePositionCode" }, { "type": "null" } ], "default": null, "description": "The code used by the DoD that identifies the service position of the servicemember" }, "early_indication_service_component_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Early Indication Service Component String" }, "hera_covered": { "description": "This indicates if the person left active duty within 367 days prior to the active duty", "title": "Hera Covered", "type": "boolean" }, "hera_start_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the servicemember entered active duty", "title": "Hera Start Date" }, "hera_end_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date the servicemember left active duty", "title": "Hera End Date" }, "hera_service_component_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hera Service Component Code" }, "hera_service_component_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Hera Service Component String" }, "active_duty_indicator_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Active Duty Indicator Code" }, "match_reason_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Matching code for search", "title": "Match Reason Code" }, "scra_eligibility_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Scra Eligibility Type" } }, "required": [ "covered", "active_duty_covered", "early_indication_covered", "hera_covered" ], "title": "SCRAResponseEligibility", "type": "object" }, "v1.SCRAResponsePerson": { "properties": { "pn_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Either a social security number (SSN) or an individual taxpayer identification number (ITIN)", "title": "Pn Id" }, "pn_id_confirmation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Pn Id Confirmation" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first name of the person of interest as provided in the request", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The last name of the person of interest as provided in the request", "title": "Last Name" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person of interest as provided in the request", "title": "Middle Name" }, "date_of_birth": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The date of birth of the person of interest as provided in the request", "title": "Date Of Birth" }, "active_duty_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "This is the active duty status as of the date provided in the request", "title": "Active Duty Date" }, "cadency_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cadency Name" }, "batch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Batch Id" } }, "title": "SCRAResponsePerson", "type": "object" }, "v1.SCRAResponseResult": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "DMDC TransactionID", "title": "Id" }, "person_request": { "$ref": "#/components/schemas/v1.SCRAResponsePerson" }, "eligibility": { "$ref": "#/components/schemas/v1.SCRAResponseEligibility" } }, "required": [ "person_request", "eligibility" ], "title": "SCRAResponseResult", "type": "object" }, "v1.OrganizationResponse": { "description": "Represents an organization response.", "properties": { "id": { "description": "The unique identifier of the Organization.", "examples": [ "51b37909-1f26-4e88-88f2-d3bfc03834eb" ], "format": "uuid", "title": "Organization Identifier", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the Organization.", "examples": [ "The Avengers" ], "title": "Organization Name" }, "domain_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The domain name of the Organization.", "examples": [ "avengers.com" ], "title": "Organization Domain Name" }, "type": { "$ref": "#/components/schemas/v1.OrganizationType", "description": "The type of the organization.", "title": "Organization Type" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An external identifier for referencing the Organization using the ID from a namespace in an external system.", "examples": [ "0c692180-eff6-4d78-81a5-b96938fde161", "org_818sja7i" ], "title": "External Identifier" }, "webhooks_version": { "$ref": "#/components/schemas/v1.WebhooksVersion", "description": "The version of Baselayer Webhooks the Organization utilizies.", "examples": [ "2.0" ] }, "federation": { "anyOf": [ { "$ref": "#/components/schemas/v1.FederationResponse" }, { "type": "null" } ], "description": "The Federation that the Organization belongs to (if any).", "examples": [ { "email": "stan-lee@marvel.com", "id": "6d49b18a-c030-4397-b1ff-7cc1fc3a4c53", "name": "Stan Lee" } ], "title": "Federation" }, "applications": { "description": "The Applications belonging to the Organization.", "examples": [ { "enabled": true, "external_id": null, "id": "45670cb4-c724-422c-bbcf-eb1ac7839c00", "name": "Avengers - Sandbox", "type": "sandbox" }, { "enabled": false, "external_id": null, "id": "07ec800c-2987-4768-a35f-b5b7cd92430b", "name": "Avengers - Production", "type": "production" } ], "items": { "$ref": "#/components/schemas/v1.ApplicationResponse" }, "title": "Applications", "type": "array" } }, "required": [ "id", "name", "domain_name", "type", "external_id", "webhooks_version", "federation", "applications" ], "title": "OrganizationResponse (v1)", "type": "object" }, "v1.DiscoveredDirectoryListing": { "description": "A business listing discovered on a directory/aggregator site (BBB, Yelp, etc.).\n\nCaptures the NAICS-relevant data extracted from directory pages during\nwebsite discovery. The ``category`` is the most valuable field — directory\nsites like BBB and Yelp assign industry labels that map almost 1-to-1 to\nNAICS codes.", "properties": { "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Directory domain where the listing was found.", "examples": [ "bbb.org", "yelp.com", "yellowpages.com" ], "title": "Source" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the directory page that was scraped.", "examples": [ "https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234" ], "title": "Url" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business category assigned by the directory site.", "examples": [ "Plumbing Contractor", "Italian Restaurant", "Moving Company" ], "title": "Category" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business name as listed on the directory (may be a DBA).", "examples": [ "Joe's Plumbing & Heating" ], "title": "Business Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number from the directory listing.", "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address from the directory listing.", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Website URL listed on the directory page for the business.", "title": "Business Website" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Physical address from the directory listing.", "title": "Address" }, "people": { "description": "Officers, principals, or key people listed on the directory page.", "items": { "$ref": "#/components/schemas/v1.DirectoryListingPerson" }, "title": "People", "type": "array" } }, "title": "DiscoveredDirectoryListing", "type": "object" }, "v1.EmailMatchType": { "enum": [ "NO_MATCH", "EXACT", "DOMAIN" ], "title": "EmailMatchType", "type": "string" }, "v1.ISO2CountryCode": { "description": "Enumeration of ISO 3166-1 alpha-2 country codes.\n\nAttributes:\n (Various country codes like Andorra = \"AD\", etc.)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ISO2CountryCode", "type": "string" }, "v1.InputSocialProfileMatch": { "properties": { "site": { "description": "The social media platform from the original input.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "value": { "description": "The username, handle, or URL from the original input.", "examples": [ "acme-corp" ], "title": "Value", "type": "string" }, "matched": { "description": "Whether this input social profile was successfully scraped and verified during discovery.", "title": "Matched", "type": "boolean" } }, "required": [ "site", "value", "matched" ], "title": "InputSocialProfileMatch", "type": "object" }, "v1.InternationalWebPresenceResponse": { "properties": { "request_type": { "const": "INTERNATIONAL", "description": "The type of web presence request.", "examples": [ "INTERNATIONAL" ], "title": "Request Type", "type": "string" }, "id": { "description": "The ID of the Web Presence request", "examples": [ "bcb2e939-f7cc-4dd6-b3b5-15b88c3341fc" ], "format": "uuid", "title": "Id", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The status of the Web Presence request", "examples": [ "COMPLETED" ] }, "created_at": { "description": "The date and time when the Web Presence request was created.", "examples": [ "2026-10-29T05:44:48.460351" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The most recent date and time when the Web Presence request was updated.", "examples": [ "2026-10-29T05:44:48.460368" ], "title": "Updated At" }, "options": { "description": "The options for the web presence request.", "examples": [ [ "Order.NaicsPrediction", "Order.WebsiteAnalysis" ] ], "items": { "enum": [ "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull", "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.DirectoryListing" ], "title": "WebPresenceRequestOptions", "type": "string" }, "title": "Options", "type": "array" }, "name": { "description": "The name of the business as it was input for the search.", "examples": [ "Ray's Pizza" ], "title": "Name", "type": "string" }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "description": "Alternative names for the business (e.g., DBA names)", "examples": [ "Orginal Ray's Pizza", "Ray's Famous Pizza" ], "title": "Alternative Names" }, "address": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "The address of the business as it was input for the search.", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.ISO2CountryCode" }, { "type": "null" } ], "default": null, "description": "The ISO 2 country code the request was served under. A US territory given as input is reported as US.", "examples": [ "US" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The website of the business as it was input for the search.", "examples": [ "https://www.actual-valid-company-website.com/" ], "title": "Website" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of business officers related to the business as they were input for the search.", "examples": [ [ "John Doe", "Jane Smith" ] ], "title": "Officer Names" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number as it was input for the search.", "examples": [ "123-456-7890" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email as it was input for the search.", "examples": [ "support@example.com" ], "title": "Email" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID associated with the web presence request.", "examples": [ "WebPresence1234" ], "title": "Reference Id" }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalAddressMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted address matches the found business entity.", "examples": [ "EXACT", "REGION", "NO_MATCH" ] }, "business_address_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best address match was found. Only populated when business_address_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "REVIEW" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Business Address Match Sources" }, "phone_number_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.PhoneNumberMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted phone number matches phone numbers found during discovery. Only populated when a phone number was provided in the request.", "examples": [ "EXACT", "AREA_CODE", "NO_MATCH" ] }, "phone_number_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best phone number match was found. Only populated when phone_number_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "REVIEW", "DIRECTORY" ] ], "title": "Phone Number Match Sources" }, "email_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.EmailMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted email matches emails found during discovery. Only populated when an email was provided in the request.", "examples": [ "EXACT", "DOMAIN", "NO_MATCH" ] }, "email_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best email match was found. Only populated when email_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Email Match Sources" }, "people_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True if at least one officer name matches a person discovered during web presence analysis (exact or similar). Only populated when officer_names were provided in the request.", "examples": [ true, false ], "title": "People Match" }, "people_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the people match was found.", "examples": [ [ "FOUND_WEBSITE", "DIRECTORY" ], [ "DIRECTORY" ] ], "title": "People Match Sources" }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the inputted website matches the found business entity.", "examples": [ true, false ], "title": "Business Website Match" }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ], "title": "Business Website Redirect Match" }, "found_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The discovered website of the business.", "examples": [ "https://example.com/" ], "title": "Found Website" }, "website_accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The confidence score of the discovered website.", "examples": [ 0.95 ], "title": "Website Accuracy" }, "found_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered social profiles related to the business.", "title": "Found Social Profiles" }, "input_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Scraped social profiles from user-provided inputs.", "title": "Input Social Profiles" }, "social_profiles_match": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.InputSocialProfileMatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Match results for user-provided social profile inputs. Each entry echoes back the original input (site, value) and indicates whether it was also independently found during organic social discovery.", "title": "Social Profiles Match" }, "found_reviews": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredReview" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered reviews related to the business.", "title": "Found Reviews" }, "found_directory_listings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredDirectoryListing" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered directory listings related to the business.", "title": "Found Directory Listings" }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the web presence.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "154a1c36-cd59-4641-b787-26e6eb1cc7c2", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "input_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the input website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "92a8362d-ff4e-49d8-a022-ace4371cea2d", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "industry_prediction": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "default": null, "description": "The predicted NAICS code associated with the web presence.", "examples": [ { "accuracy": 0.95, "code": "541330", "keywords": [ "Engineering", "Services" ], "mcc_codes": [ { "code": "1234", "description": null, "mastercard_risk": null, "visa_risk_tier": null } ], "reasoning": null, "risk_level": "low", "sic_codes": [ { "code": "5678", "description": null } ], "title": "Engineering Services" } ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The scores associated with the web presence request, including WebKYB and WebRisk scores.", "title": "Scores" }, "reason_codes": { "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ], "items": { "$ref": "#/components/schemas/v1.ReasonCode" }, "title": "Reason Codes", "type": "array" } }, "required": [ "request_type", "id", "state", "created_at", "name" ], "title": "InternationalWebPresenceResponse (v1)", "type": "object" }, "v1.PhoneNumberMatchType": { "enum": [ "NO_MATCH", "EXACT", "AREA_CODE" ], "title": "PhoneNumberMatchType", "type": "string" }, "v1.USWebPresenceResponse": { "properties": { "request_type": { "const": "UNITED_STATES", "description": "The type of web presence request.", "examples": [ "UNITED_STATES" ], "title": "Request Type", "type": "string" }, "id": { "description": "The ID of the Web Presence request", "examples": [ "df6fc8ed-b90f-422e-9347-9c104acf0e13" ], "format": "uuid", "title": "Id", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The status of the Web Presence request", "examples": [ "COMPLETED" ] }, "created_at": { "description": "The date and time when the Web Presence request was created.", "examples": [ "2026-10-29T05:44:48.455999" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The most recent date and time when the Web Presence request was updated.", "examples": [ "2026-10-29T05:44:48.456022" ], "title": "Updated At" }, "options": { "description": "The options for the web presence request.", "examples": [ [ "Order.NaicsPrediction", "Order.WebsiteAnalysis" ] ], "items": { "enum": [ "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull", "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.DirectoryListing" ], "title": "WebPresenceRequestOptions", "type": "string" }, "title": "Options", "type": "array" }, "name": { "description": "The name of the business as it was input for the search.", "examples": [ "Ray's Pizza" ], "title": "Name", "type": "string" }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "description": "Alternative names for the business (e.g., DBA names)", "examples": [ "Orginal Ray's Pizza", "Ray's Famous Pizza" ], "title": "Alternative Names" }, "address": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "The address of the business as it was input for the search.", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.ISO2CountryCode" }, { "type": "null" } ], "default": null, "description": "The ISO 2 country code the request was served under. A US territory given as input is reported as US.", "examples": [ "US" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The website of the business as it was input for the search.", "examples": [ "https://www.actual-valid-company-website.com/" ], "title": "Website" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of business officers related to the business as they were input for the search.", "examples": [ [ "John Doe", "Jane Smith" ] ], "title": "Officer Names" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number as it was input for the search.", "examples": [ "123-456-7890" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email as it was input for the search.", "examples": [ "support@example.com" ], "title": "Email" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID associated with the web presence request.", "examples": [ "WebPresence1234" ], "title": "Reference Id" }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted address matches the found business entity.", "examples": [ "EXACT", "CITY", "NO_MATCH" ] }, "business_address_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best address match was found. Only populated when business_address_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "REVIEW" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Business Address Match Sources" }, "phone_number_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.PhoneNumberMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted phone number matches phone numbers found during discovery. Only populated when a phone number was provided in the request.", "examples": [ "EXACT", "AREA_CODE", "NO_MATCH" ] }, "phone_number_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best phone number match was found. Only populated when phone_number_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "REVIEW", "DIRECTORY" ] ], "title": "Phone Number Match Sources" }, "email_match": { "anyOf": [ { "$ref": "#/components/schemas/v1.EmailMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted email matches emails found during discovery. Only populated when an email was provided in the request.", "examples": [ "EXACT", "DOMAIN", "NO_MATCH" ] }, "email_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best email match was found. Only populated when email_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Email Match Sources" }, "people_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True if at least one officer name matches a person discovered during web presence analysis (exact or similar). Only populated when officer_names were provided in the request.", "examples": [ true, false ], "title": "People Match" }, "people_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the people match was found.", "examples": [ [ "FOUND_WEBSITE", "DIRECTORY" ], [ "DIRECTORY" ] ], "title": "People Match Sources" }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the inputted website matches the found business entity.", "examples": [ true, false ], "title": "Business Website Match" }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ], "title": "Business Website Redirect Match" }, "found_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The discovered website of the business.", "examples": [ "https://example.com/" ], "title": "Found Website" }, "website_accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The confidence score of the discovered website.", "examples": [ 0.95 ], "title": "Website Accuracy" }, "found_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered social profiles related to the business.", "title": "Found Social Profiles" }, "input_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Scraped social profiles from user-provided inputs.", "title": "Input Social Profiles" }, "social_profiles_match": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.InputSocialProfileMatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Match results for user-provided social profile inputs. Each entry echoes back the original input (site, value) and indicates whether it was also independently found during organic social discovery.", "title": "Social Profiles Match" }, "found_reviews": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredReview" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered reviews related to the business.", "title": "Found Reviews" }, "found_directory_listings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DiscoveredDirectoryListing" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered directory listings related to the business.", "title": "Found Directory Listings" }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the web presence.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "931a60db-33d9-427d-af7e-fd70aa05bde0", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "input_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the input website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "c0ac144a-ef4c-4b1b-8dfb-82b11d98bd58", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "industry_prediction": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "default": null, "description": "The predicted NAICS code associated with the web presence.", "examples": [ { "accuracy": 0.95, "code": "541330", "keywords": [ "Engineering", "Services" ], "mcc_codes": [ { "code": "1234", "description": null, "mastercard_risk": null, "visa_risk_tier": null } ], "reasoning": null, "risk_level": "low", "sic_codes": [ { "code": "5678", "description": null } ], "title": "Engineering Services" } ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The scores associated with the web presence request, including WebKYB and WebRisk scores.", "title": "Scores" }, "reason_codes": { "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ], "items": { "$ref": "#/components/schemas/v1.ReasonCode" }, "title": "Reason Codes", "type": "array" } }, "required": [ "request_type", "id", "state", "created_at", "name" ], "title": "USWebPresenceResponse (v1)", "type": "object" }, "v1.WebPresenceSource": { "enum": [ "INPUT_WEBSITE", "FOUND_WEBSITE", "SOCIAL_PROFILE", "INPUT_SOCIAL_PROFILE", "REVIEW", "DIRECTORY" ], "type": "string" }, "v2.AddressMatchType": { "enum": [ "NO_MATCH", "CITY", "STATE", "SIMILAR", "EXACT" ], "title": "AddressMatchType", "type": "string" }, "v2.AddressRDI": { "enum": [ "Residential", "Commercial" ], "title": "AddressRDI", "type": "string" }, "v2.AddressSummaryResponse": { "description": "Response model for address summary data.\n\nThis model defines the structure for address summary API responses.", "properties": { "id": { "description": "Unique identifier for the address.", "format": "uuid", "title": "Id", "type": "string" }, "street": { "description": "Street name of the address.", "examples": [ "913 Hendrix Gardens Suite 492" ], "title": "Street", "type": "string" }, "city": { "description": "City name of the address.", "examples": [ "Jasonfurt" ], "title": "City", "type": "string" }, "state": { "$ref": "#/components/schemas/v2.StateAbbreviation", "description": "State 2 letter abbreviation of the address.", "examples": [ "VA" ] }, "zip": { "description": "Zip code of the address.", "examples": [ "19773" ], "title": "Zip", "type": "string" }, "latitude": { "description": "Latitude of the address.", "examples": [ 38.03012 ], "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude of the address.", "examples": [ 78.47665 ], "title": "Longitude", "type": "number" }, "rdi": { "anyOf": [ { "$ref": "#/components/schemas/v2.AddressRDI" }, { "type": "null" } ], "default": null, "description": "Residential Delivery Indicator of the address.", "examples": [ "Commercial" ] }, "deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is deliverable.", "examples": [ false ], "title": "Deliverable" }, "cmra": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the address is a Commercial Mail Receiving Agency (CMRA).", "examples": [ false ], "title": "Cmra" }, "url": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The URL to the address details.", "title": "Url" }, "delivery_type": { "anyOf": [ { "$ref": "#/components/schemas/v2.USPSDeliveryType" }, { "type": "null" } ], "default": null, "description": "The USPS delivery type.", "examples": [ "STREET", "FIRM" ] } }, "required": [ "id", "street", "city", "state", "zip", "latitude", "longitude" ], "title": "AddressSummaryResponse (v1)", "type": "object" }, "v2.ConfidenceLevel": { "enum": [ "high", "medium", "low" ], "title": "ConfidenceLevel", "type": "string" }, "v2.DirectoryListingPerson": { "description": "An officer, principal, or key person listed on a directory page.", "properties": { "name": { "title": "Name", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" } }, "required": [ "name" ], "title": "DirectoryListingPerson", "type": "object" }, "v2.DiscoveredDirectoryListing": { "description": "A business listing discovered on a directory/aggregator site (BBB, Yelp, etc.).\n\nCaptures the NAICS-relevant data extracted from directory pages during\nwebsite discovery. The ``category`` is the most valuable field — directory\nsites like BBB and Yelp assign industry labels that map almost 1-to-1 to\nNAICS codes.", "properties": { "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Directory domain where the listing was found.", "examples": [ "bbb.org", "yelp.com", "yellowpages.com" ], "title": "Source" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the directory page that was scraped.", "examples": [ "https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234" ], "title": "Url" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business category assigned by the directory site.", "examples": [ "Plumbing Contractor", "Italian Restaurant", "Moving Company" ], "title": "Category" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business name as listed on the directory (may be a DBA).", "examples": [ "Joe's Plumbing & Heating" ], "title": "Business Name" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Phone number from the directory listing.", "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Email address from the directory listing.", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Website URL listed on the directory page for the business.", "title": "Business Website" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Physical address from the directory listing.", "title": "Address" }, "people": { "description": "Officers, principals, or key people listed on the directory page.", "items": { "$ref": "#/components/schemas/v2.DirectoryListingPerson" }, "title": "People", "type": "array" } }, "title": "DiscoveredDirectoryListing", "type": "object" }, "v2.DiscoveredFacebookMetadata": { "description": "Facebook-specific metadata extracted from a verified business profile.", "properties": { "is_business_page": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a Facebook business page vs personal profile", "title": "Is Business Page" }, "has_reviews": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Facebook page has customer reviews", "title": "Has Reviews" }, "check_ins_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of check-ins at this business location", "title": "Check Ins Count" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "title": "Followers Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Facebook bio/description content", "title": "Bio" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "title": "Phone Number" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "title": "Address" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "title": "Business Website" } }, "title": "DiscoveredFacebookMetadata", "type": "object" }, "v2.DiscoveredInstagramMetadata": { "description": "Instagram-specific metadata extracted from a verified business profile.", "properties": { "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Instagram account is private", "examples": [ false, true ], "title": "Is Private" }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is an Instagram business account", "examples": [ true, false ], "title": "Is Business Account" }, "has_business_address": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the business address is displayed on the Instagram profile", "examples": [ true, false ], "title": "Has Business Address" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Instagram bio/description content", "examples": [ "Professional roofing services since 2010 🏠" ], "title": "Bio" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1250, 5000 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredInstagramMetadata", "type": "object" }, "v2.DiscoveredLinkedInMetadata": { "description": "LinkedIn-specific metadata extracted from a verified business profile.", "properties": { "company_size_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Company size range as displayed on LinkedIn (e.g., '11-50 employees')", "examples": [ "11-50 employees", "51-200 employees" ], "title": "Company Size Range" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Industry classification from LinkedIn", "examples": [ "Construction", "Financial Services" ], "title": "Industry" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 250, 1500 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "LinkedIn bio/description content", "title": "Bio" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "info@business.com" ], "title": "Email" }, "number_of_employees": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of employees (LinkedIn only)", "examples": [ 25, 150 ], "title": "Number Of Employees" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredLinkedInMetadata", "type": "object" }, "v2.DiscoveredPinterestMetadata": { "description": "Pinterest-specific metadata extracted from a verified business profile.", "properties": { "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "title": "Follower Count" }, "monthly_views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Monthly views count if displayed", "title": "Monthly Views" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Pinterest profile bio/description content", "title": "Bio" }, "has_business_website": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether a business website link is provided", "title": "Has Business Website" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "title": "Business Website" } }, "title": "DiscoveredPinterestMetadata", "type": "object" }, "v2.DiscoveredReview": { "properties": { "source": { "anyOf": [ { "$ref": "#/components/schemas/v2.ReviewSource" }, { "type": "null" } ], "default": null, "description": "The source of the review.", "examples": [ "yelp" ] }, "url": { "description": "The URL of the review.", "examples": [ "https://www.yelp.com/biz/certified-power-inc-mundelein" ], "title": "Url", "type": "string" }, "confidence": { "anyOf": [ { "$ref": "#/components/schemas/v2.ConfidenceLevel" }, { "type": "null" } ], "default": "high", "description": "The confidence level that this review is for the business.", "examples": [ "high" ] }, "rating": { "anyOf": [ { "maximum": 5.0, "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "description": "The numeric rating of the review (e.g., 4.5 out of 5).", "examples": [ 4.5 ], "title": "Rating" }, "volume": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of reviews.", "examples": [ 23 ], "title": "Volume" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Overall summary of the reviews and general sentiment towards the business.", "examples": [ "5 reviews mention that the service was great and the owner was very helpful." ], "title": "Summary" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website if found in profile", "examples": [ "https://www.example.com" ], "title": "Business Website" }, "reviews": { "description": "Individual reviews for this business.", "items": { "$ref": "#/components/schemas/v2.ReviewDetail" }, "title": "Reviews", "type": "array" }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/v2.GoogleReviewMetadata" }, { "type": "null" } ], "default": null, "description": "Platform-specific metadata for the review. Currently only populated for Google reviews." } }, "required": [ "url" ], "title": "DiscoveredReview", "type": "object" }, "v2.DiscoveredSocialProfile": { "properties": { "site": { "description": "The type of social profile.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "username": { "description": "The username of the social profile.", "examples": [ "certifiedpowerinc" ], "title": "Username", "type": "string" }, "confidence": { "anyOf": [ { "$ref": "#/components/schemas/v2.ConfidenceLevel" }, { "type": "null" } ], "default": null, "description": "The confidence level of the social profile.", "examples": [ "high" ] }, "metadata": { "anyOf": [ { "$ref": "#/components/schemas/v2.DiscoveredInstagramMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredLinkedInMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredFacebookMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredXMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredYouTubeMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredTikTokMetadata" }, { "$ref": "#/components/schemas/v2.DiscoveredPinterestMetadata" }, { "type": "null" } ], "default": null, "description": "The metadata of the social profile. Based on the site of the social profile.", "title": "Metadata" }, "found_on": { "description": "Location(s) where this social profile was found: InputWebsite (user-provided website), FoundWebsite (discovered website)", "examples": [ [ "FOUND_WEBSITE" ], [ "FOUND_WEBSITE", "INPUT_WEBSITE" ] ], "items": { "enum": [ "INPUT_WEBSITE", "FOUND_WEBSITE" ], "type": "string" }, "title": "Found On", "type": "array", "uniqueItems": true }, "url": { "description": "The URL of the social profile.", "examples": [ "https://www.instagram.com/certifiedpowerinc" ], "readOnly": true, "title": "Url", "type": "string" } }, "required": [ "site", "username", "url" ], "title": "DiscoveredSocialProfile", "type": "object" }, "v2.DiscoveredTikTokMetadata": { "description": "TikTok-specific metadata extracted from a verified business profile.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the TikTok account is verified", "examples": [ true, false ], "title": "Is Verified" }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a TikTok business account", "examples": [ true, false ], "title": "Is Business Account" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 5000, 25000 ], "title": "Follower Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "TikTok bio/description content", "examples": [ "Your trusted local contractor 🔨 Follow for tips!" ], "title": "Bio" }, "has_business_website": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether a business website link is provided", "examples": [ true, false ], "title": "Has Business Website" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredTikTokMetadata", "type": "object" }, "v2.DiscoveredXMetadata": { "description": "Twitter/X-specific metadata extracted from a verified business profile.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Twitter/X account is verified", "examples": [ true, false ], "title": "Is Verified" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1500, 10000 ], "title": "Follower Count" }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Twitter/X bio/description content", "examples": [ "Leading provider of construction services in the NYC area" ], "title": "Bio" }, "joined_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "When the account joined Twitter/X (e.g., 'Joined February 2010')", "examples": [ "Joined February 2010", "Joined March 2015" ], "title": "Joined Date" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business address if found in profile", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "contact@business.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredXMetadata", "type": "object" }, "v2.DiscoveredYouTubeMetadata": { "description": "YouTube-specific metadata extracted from a verified business channel.", "properties": { "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the YouTube channel is verified", "examples": [ true, false ], "title": "Is Verified" }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of subscribers if displayed", "examples": [ 1200, 15000 ], "title": "Subscriber Count" }, "channel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Type of channel (e.g., 'Business', 'Brand', 'Personal')", "examples": [ "Business", "Brand", "Personal" ], "title": "Channel Type" }, "has_business_email": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether business contact email is provided", "examples": [ true, false ], "title": "Has Business Email" }, "channel_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Channel about/description content", "examples": [ "Weekly tutorials on home improvement and DIY projects" ], "title": "Channel Description" }, "followers_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of followers if displayed", "examples": [ 1200, 15000 ], "title": "Followers Count" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business phone number if found in profile", "examples": [ "+12125551234" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business email address if found in profile", "examples": [ "business@example.com" ], "title": "Email" }, "business_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business website URL if found in profile", "examples": [ "https://www.business.com" ], "title": "Business Website" } }, "title": "DiscoveredYouTubeMetadata", "type": "object" }, "v2.EmailMatchType": { "enum": [ "NO_MATCH", "EXACT", "DOMAIN" ], "title": "EmailMatchType", "type": "string" }, "v2.GoogleReviewMetadata": { "description": "Google Maps-specific metadata for a discovered review.", "properties": { "open_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Current open/closed state from Google Maps.", "examples": [ "Open", "Closed", "Temporarily closed" ], "title": "Open State" }, "operating_hours": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Operating hours data from Google Maps.", "title": "Operating Hours" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Business description from Google Maps.", "title": "Description" }, "types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Business type tags from Google Maps.", "examples": [ [ "Restaurant", "Italian restaurant" ] ], "title": "Types" }, "service_options": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Service options from Google Maps (e.g., dine-in, takeout).", "title": "Service Options" } }, "title": "GoogleReviewMetadata", "type": "object" }, "v2.ISO2CountryCode": { "description": "Enumeration of ISO 3166-1 alpha-2 country codes.\n\nAttributes:\n (Various country codes like Andorra = \"AD\", etc.)", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "title": "ISO2CountryCode", "type": "string" }, "v2.InputSocialProfileMatch": { "properties": { "site": { "description": "The social media platform from the original input.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "value": { "description": "The username, handle, or URL from the original input.", "examples": [ "acme-corp" ], "title": "Value", "type": "string" }, "matched": { "description": "Whether this input social profile was successfully scraped and verified during discovery.", "title": "Matched", "type": "boolean" } }, "required": [ "site", "value", "matched" ], "title": "InputSocialProfileMatch", "type": "object" }, "v2.InternationalAddressMatchType": { "enum": [ "NO_MATCH", "REGION", "CITY", "COUNTRY", "EXACT" ], "title": "InternationalAddressMatchType", "type": "string" }, "v2.InternationalWebPresenceResponse": { "description": "International Web Presence Response with v2 fields.", "properties": { "request_type": { "const": "INTERNATIONAL", "description": "The type of web presence request.", "examples": [ "INTERNATIONAL" ], "title": "Request Type", "type": "string" }, "id": { "description": "The ID of the Web Presence request", "examples": [ "bcb2e939-f7cc-4dd6-b3b5-15b88c3341fc" ], "format": "uuid", "title": "Id", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v2.TaskState", "description": "The status of the Web Presence request", "examples": [ "COMPLETED" ] }, "created_at": { "description": "The date and time when the Web Presence request was created.", "examples": [ "2026-10-29T05:44:48.460351" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The most recent date and time when the Web Presence request was updated.", "examples": [ "2026-10-29T05:44:48.460368" ], "title": "Updated At" }, "options": { "description": "The options for the web presence request.", "examples": [ [ "Order.NaicsPrediction", "Order.WebsiteAnalysis" ] ], "items": { "enum": [ "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull", "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.DirectoryListing" ], "title": "WebPresenceRequestOptions", "type": "string" }, "title": "Options", "type": "array" }, "name": { "description": "The name of the business as it was input for the search.", "examples": [ "Ray's Pizza" ], "title": "Name", "type": "string" }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "description": "Alternative names for the business (e.g., DBA names)", "examples": [ "Orginal Ray's Pizza", "Ray's Famous Pizza" ], "title": "Alternative Names" }, "address": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "The address of the business as it was input for the search.", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/v2.ISO2CountryCode" }, { "type": "null" } ], "default": null, "description": "The ISO 2 country code the request was served under. A US territory given as input is reported as US.", "examples": [ "US" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The website of the business as it was input for the search.", "examples": [ "https://www.actual-valid-company-website.com/" ], "title": "Website" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of business officers related to the business as they were input for the search.", "examples": [ [ "John Doe", "Jane Smith" ] ], "title": "Officer Names" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number as it was input for the search.", "examples": [ "123-456-7890" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email as it was input for the search.", "examples": [ "support@example.com" ], "title": "Email" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID associated with the web presence request.", "examples": [ "WebPresence1234" ], "title": "Reference Id" }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.InternationalAddressMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted address matches the found business entity.", "examples": [ "EXACT", "REGION", "NO_MATCH" ] }, "business_address_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best address match was found. Only populated when business_address_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "REVIEW" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Business Address Match Sources" }, "phone_number_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.PhoneNumberMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted phone number matches phone numbers found during discovery. Only populated when a phone number was provided in the request.", "examples": [ "EXACT", "AREA_CODE", "NO_MATCH" ] }, "phone_number_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best phone number match was found. Only populated when phone_number_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "REVIEW", "DIRECTORY" ] ], "title": "Phone Number Match Sources" }, "email_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.EmailMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted email matches emails found during discovery. Only populated when an email was provided in the request.", "examples": [ "EXACT", "DOMAIN", "NO_MATCH" ] }, "email_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best email match was found. Only populated when email_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Email Match Sources" }, "people_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True if at least one officer name matches a person discovered during web presence analysis (exact or similar). Only populated when officer_names were provided in the request.", "examples": [ true, false ], "title": "People Match" }, "people_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the people match was found.", "examples": [ [ "FOUND_WEBSITE", "DIRECTORY" ], [ "DIRECTORY" ] ], "title": "People Match Sources" }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the inputted website matches the found business entity.", "examples": [ true, false ], "title": "Business Website Match" }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ], "title": "Business Website Redirect Match" }, "found_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The discovered website of the business.", "examples": [ "https://example.com/" ], "title": "Found Website" }, "website_accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The confidence score of the discovered website.", "examples": [ 0.95 ], "title": "Website Accuracy" }, "found_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered social profiles related to the business.", "title": "Found Social Profiles" }, "input_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Scraped social profiles from user-provided inputs.", "title": "Input Social Profiles" }, "social_profiles_match": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.InputSocialProfileMatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Match results for user-provided social profile inputs. Each entry echoes back the original input (site, value) and indicates whether it was also independently found during organic social discovery.", "title": "Social Profiles Match" }, "found_reviews": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredReview" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered reviews related to the business.", "title": "Found Reviews" }, "found_directory_listings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredDirectoryListing" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered directory listings related to the business.", "title": "Found Directory Listings" }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the web presence.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "154a1c36-cd59-4641-b787-26e6eb1cc7c2", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "input_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the input website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "92a8362d-ff4e-49d8-a022-ace4371cea2d", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "industry_prediction": { "anyOf": [ { "$ref": "#/components/schemas/v2.PredictedNaicsResponse" }, { "type": "null" } ], "default": null, "description": "The predicted NAICS code associated with the web presence.", "examples": [ { "accuracy": 0.95, "code": "541330", "keywords": [ "Engineering", "Services" ], "mcc_codes": [ { "code": "1234", "description": null, "mastercard_risk": null, "visa_risk_tier": null } ], "reasoning": null, "risk_level": "low", "sic_codes": [ { "code": "5678", "description": null } ], "title": "Engineering Services" } ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The scores associated with the web presence request, including WebKYB and WebRisk scores.", "title": "Scores" }, "reason_codes": { "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ], "items": { "$ref": "#/components/schemas/v2.ReasonCode" }, "title": "Reason Codes", "type": "array" }, "discovered_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the discovered website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "34f7c345-e851-4e81-b392-2a59eab0e05d", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] } }, "required": [ "request_type", "id", "state", "created_at", "name" ], "title": "InternationalWebPresenceResponse (v2)", "type": "object" }, "v2.MCC": { "description": "Represents a Merchant Category Code (MCC).", "properties": { "code": { "description": "The 4-digit MCC.", "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the MCC.", "title": "Description" }, "mastercard_risk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates if there is a risk associated with Mastercard transactions.", "title": "Mastercard Risk" }, "visa_risk_tier": { "anyOf": [ { "$ref": "#/components/schemas/v2.VisaRiskTier" }, { "type": "null" } ], "default": null, "description": "The Visa risk tier associated with this MCC." } }, "required": [ "code" ], "title": "MCC", "type": "object" }, "v2.PhoneNumberMatchType": { "enum": [ "NO_MATCH", "EXACT", "AREA_CODE" ], "title": "PhoneNumberMatchType", "type": "string" }, "v2.PredictedNaicsResponse": { "properties": { "code": { "description": "The predicted NAICS code for the business.", "examples": [ "336111" ], "title": "Code", "type": "string" }, "title": { "description": "The title of the predicted NAICS code.", "examples": [ "Automobile Manufacturing" ], "title": "Title", "type": "string" }, "accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "The accuracy of the NAICS code prediction.", "examples": [ 1.0, 0.4 ], "title": "Accuracy" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Any keywords associated with the NAICS code to indicate area of business activity.", "examples": [ [ "Automobiles", "Manufacturing", "Cars", "Trucks" ] ], "title": "Keywords" }, "mcc_codes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.MCC" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of MCC codes associated with the NAICS code.", "title": "Mcc Codes" }, "sic_codes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.SICCode" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of SIC codes associated with the NAICS code.", "title": "Sic Codes" }, "risk_level": { "anyOf": [ { "$ref": "#/components/schemas/v2.RiskLevel" }, { "type": "null" } ], "default": null, "description": "The risk level associated with the NAICS code.", "examples": [ "low", "medium", "high" ] }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Explanation of why this specific NAICS code was chosen for the business.", "examples": [ "Based on homepage content mentioning automobile manufacturing and assembly processes.", "Reviews and social profiles consistently reference restaurant and food service operations." ], "title": "Reasoning" } }, "required": [ "code", "title" ], "title": "PredictedNaicsResponse (v1)", "type": "object" }, "v2.ReasonCode": { "description": "Every reason code Baselayer has ever issued.\n\nMembers are named exactly as their value so the code a customer sees is the\ncode a developer greps for. A member is never removed: rows that recorded it\nstill name it.", "enum": [ "ADDRESS_FAILED_TO_NORMALIZE", "ENTITY_NOT_FOUND", "BUSINESS_NAME_NO_MATCH", "NO_ACTIVE_REGISTRATIONS", "DOMESTIC_REGISTRATION_INACTIVE", "SOLE_REGISTRATION_STATUS_UNKNOWN", "ENTITY_AGE_UNDER_7D", "ENTITY_AGE_UNDER_30D", "ENTITY_AGE_UNDER_90D", "ENTITY_AGE_UNDER_6M", "ENTITY_AGE_UNDER_12M", "TIN_MISMATCH", "TIN_IS_SSN", "ADDRESS_NO_MATCH", "ADDRESS_PARTIAL_MATCH", "SEARCH_ADDRESS_UNDELIVERABLE", "SEARCH_ADDRESS_PO_BOX", "SEARCH_ADDRESS_CMRA", "SEARCH_ADDRESS_RESIDENTIAL", "PRIMARY_ADDRESS_UNDELIVERABLE", "PRIMARY_ADDRESS_PO_BOX", "PRIMARY_ADDRESS_CMRA", "PRIMARY_ADDRESS_RESIDENTIAL", "NO_OFFICER_MATCH", "SUBMITTED_DOMAIN_UNDER_7D", "DISCOVERED_DOMAIN_UNDER_7D", "TAX_LIEN_ACTIVE", "TAX_LIEN_PAST", "UCC_LIEN_ACTIVE", "BANKRUPTCY_ACTIVE", "BANKRUPTCY_RECENT", "LITIGATION_ACTIVE", "LITIGATION_RECENT", "NETWORK_HIGH_VELOCITY", "NETWORK_HIGH_APPLICATION_COUNT", "ADDRESS_MISMATCH", "NETWORK_NO_HISTORY" ], "title": "ReasonCode", "type": "string" }, "v2.RequestOrigin": { "enum": [ "api", "console", "mcp", "onboarding" ], "title": "RequestOrigin", "type": "string" }, "v2.ReviewDetail": { "properties": { "username": { "description": "The username of the reviewer.", "examples": [ "John Doe" ], "title": "Username", "type": "string" }, "text": { "description": "The text of the review.", "examples": [ "This is a great review!" ], "title": "Text", "type": "string" }, "date": { "description": "The date of the review.", "examples": [ "2024-01-01" ], "format": "date", "title": "Date", "type": "string" }, "rating": { "description": "The rating of the review.", "examples": [ 5 ], "title": "Rating", "type": "integer" } }, "required": [ "username", "text", "date", "rating" ], "title": "ReviewDetail", "type": "object" }, "v2.ReviewSource": { "enum": [ "yelp", "google", "trustpilot", "tripadvisor", "other" ], "title": "ReviewSource", "type": "string" }, "v2.RiskLevel": { "enum": [ "high", "medium", "low", "no_risk" ], "title": "RiskLevel", "type": "string" }, "v2.SICCode": { "description": "Represents a Standard Industrial Classification (SIC) code.", "properties": { "code": { "description": "The 4-digit SIC code.", "title": "Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Description of the SIC code.", "title": "Description" } }, "required": [ "code" ], "title": "SICCode", "type": "object" }, "v2.SSLCertificateType": { "description": "Type of SSL certificate based on validation level.\n\nDV (Domain Validation): Only domain ownership verified - easiest to obtain\nOV (Organization Validation): Organization identity verified\nEV (Extended Validation): Extensive organization verification - highest trust", "enum": [ "DV", "OV", "EV", "Unknown" ], "title": "SSLCertificateType", "type": "string" }, "v2.SSLInvalidReason": { "description": "Reasons why an SSL certificate check failed or could not be determined.\n\nUsed when is_valid is False (certificate invalid) or None (indeterminate).", "enum": [ "CERTIFICATE_EXPIRED", "HOSTNAME_MISMATCH", "SELF_SIGNED", "REVOKED", "UNTRUSTED_AUTHORITY", "VERIFICATION_FAILED", "NOT_HTTPS", "CONNECTION_TIMED_OUT", "UNABLE_TO_CONNECT", "SERVER_DISCONNECTED", "SERVER_ERROR", "CONNECTION_ERROR" ], "title": "SSLInvalidReason", "type": "string" }, "v2.SSLValidityInfo": { "description": "SSL certificate information with fraud-relevant signals.\n\nis_valid semantics:\n True: Certificate is valid and trusted\n False: Certificate is definitively invalid (expired, untrusted, revoked, etc.)\n None: Cannot determine (connection failed, timeout, non-HTTPS)", "properties": { "is_valid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the SSL certificate is valid (True=valid, False=invalid, None=indeterminate)", "title": "Is Valid" }, "reason": { "anyOf": [ { "$ref": "#/components/schemas/v2.SSLInvalidReason" }, { "type": "null" } ], "default": null, "description": "Reason if SSL certificate is invalid or indeterminate", "examples": [ "CERTIFICATE_EXPIRED", "HOSTNAME_MISMATCH", "SELF_SIGNED", "UNABLE_TO_CONNECT" ] }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Certificate issuer (CA) common name", "examples": [ "DigiCert Global Root CA", "R3" ], "title": "Issuer" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Certificate subject common name", "examples": [ "www.example.com", "*.example.com" ], "title": "Subject" }, "issued_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the certificate was issued", "title": "Issued Date" }, "expiry_date": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the certificate expires", "title": "Expiry Date" }, "days_until_expiry": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days until certificate expires (negative if expired)", "examples": [ 365, 30, -5 ], "title": "Days Until Expiry" }, "cert_age_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Days since certificate was issued", "examples": [ 180, 30, 5 ], "title": "Cert Age Days" }, "certificate_type": { "anyOf": [ { "$ref": "#/components/schemas/v2.SSLCertificateType" }, { "type": "null" } ], "default": null, "description": "Certificate validation level (DV=Domain only, OV=Organization verified, EV=Extended validation)", "examples": [ "DV", "EV" ] }, "is_wildcard": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether this is a wildcard certificate (*.example.com)", "title": "Is Wildcard" }, "key_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Public key size in bits", "examples": [ 2048, 4096, 256 ], "title": "Key Size" }, "tls_version": { "anyOf": [ { "$ref": "#/components/schemas/v2.TLSVersion" }, { "type": "null" } ], "default": null, "description": "TLS protocol version used", "examples": [ "TLSv1.2", "TLSv1.3" ] }, "is_self_signed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the certificate is self-signed (not trusted by a CA)", "title": "Is Self Signed" }, "is_revoked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the certificate has been revoked (via OCSP check)", "title": "Is Revoked" } }, "title": "SSLValidityInfo", "type": "object" }, "v2.ScoreResponse": { "properties": { "type": { "$ref": "#/components/schemas/v2.ScoreType", "description": "The type of score.", "examples": [ "risk" ] }, "score": { "description": "The score value.", "examples": [ 95.0 ], "title": "Score", "type": "number" }, "rating": { "description": "The rating associated with the score.", "examples": [ "A", "B" ], "title": "Rating", "type": "string" } }, "required": [ "type", "score", "rating" ], "title": "ScoreResponse (v1)", "type": "object" }, "v2.ScoreType": { "enum": [ "fraud", "risk", "kyb" ], "title": "ScoreType", "type": "string" }, "v2.SocialProfile": { "properties": { "site": { "description": "The type of social profile.", "enum": [ "linked_in:personal", "linked_in:company", "twitter", "instagram", "facebook", "youtube", "tiktok", "pinterest", "x" ], "examples": [ "instagram" ], "type": "string" }, "username": { "description": "The username of the social profile.", "examples": [ "certifiedpowerinc" ], "title": "Username", "type": "string" }, "url": { "description": "The URL of the social profile.", "examples": [ "https://www.instagram.com/certifiedpowerinc" ], "readOnly": true, "title": "Url", "type": "string" } }, "required": [ "site", "username", "url" ], "title": "SocialProfile", "type": "object" }, "v2.StateAbbreviation": { "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "VI", "AE", "AA", "AP", "GU", "AS" ], "title": "StateAbbreviation", "type": "string" }, "v2.TLSVersion": { "description": "TLS protocol version used for SSL connections.", "enum": [ "TLSv1.0", "TLSv1.1", "TLSv1.2", "TLSv1.3", "SSLv3", "Unknown" ], "title": "TLSVersion", "type": "string" }, "v2.TaskState": { "enum": [ "PENDING", "EXECUTING", "COMPLETED", "FAILED", "CANCELLED" ], "title": "TaskState", "type": "string" }, "v2.USPSDeliveryType": { "description": "Enum representing the different types of USPS delivery points.\nUsed to classify addresses based on how mail is delivered to them.", "enum": [ "FIRM", "GENERAL_DELIVERY", "HIGH_RISE", "POST_OFFICE", "RURAL_ROUTE", "STREET" ], "title": "USPSDeliveryType", "type": "string" }, "v2.USWebPresenceResponse": { "description": "US Web Presence Response with v2 fields.", "properties": { "request_type": { "const": "UNITED_STATES", "description": "The type of web presence request.", "examples": [ "UNITED_STATES" ], "title": "Request Type", "type": "string" }, "id": { "description": "The ID of the Web Presence request", "examples": [ "df6fc8ed-b90f-422e-9347-9c104acf0e13" ], "format": "uuid", "title": "Id", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v2.TaskState", "description": "The status of the Web Presence request", "examples": [ "COMPLETED" ] }, "created_at": { "description": "The date and time when the Web Presence request was created.", "examples": [ "2026-10-29T05:44:48.455999" ], "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The most recent date and time when the Web Presence request was updated.", "examples": [ "2026-10-29T05:44:48.456022" ], "title": "Updated At" }, "options": { "description": "The options for the web presence request.", "examples": [ [ "Order.NaicsPrediction", "Order.WebsiteAnalysis" ] ], "items": { "enum": [ "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull", "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.DirectoryListing" ], "title": "WebPresenceRequestOptions", "type": "string" }, "title": "Options", "type": "array" }, "name": { "description": "The name of the business as it was input for the search.", "examples": [ "Ray's Pizza" ], "title": "Name", "type": "string" }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 10, "type": "array" }, { "type": "null" } ], "description": "Alternative names for the business (e.g., DBA names)", "examples": [ "Orginal Ray's Pizza", "Ray's Famous Pizza" ], "title": "Alternative Names" }, "address": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "default": null, "description": "The address of the business as it was input for the search.", "examples": [ "123 Main St, Anytown, USA" ], "title": "Address" }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/v2.ISO2CountryCode" }, { "type": "null" } ], "default": null, "description": "The ISO 2 country code the request was served under. A US territory given as input is reported as US.", "examples": [ "US" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The website of the business as it was input for the search.", "examples": [ "https://www.actual-valid-company-website.com/" ], "title": "Website" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of business officers related to the business as they were input for the search.", "examples": [ [ "John Doe", "Jane Smith" ] ], "title": "Officer Names" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The phone number as it was input for the search.", "examples": [ "123-456-7890" ], "title": "Phone Number" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The email as it was input for the search.", "examples": [ "support@example.com" ], "title": "Email" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID associated with the web presence request.", "examples": [ "WebPresence1234" ], "title": "Reference Id" }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.AddressMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted address matches the found business entity.", "examples": [ "EXACT", "CITY", "NO_MATCH" ] }, "business_address_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best address match was found. Only populated when business_address_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "REVIEW" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Business Address Match Sources" }, "phone_number_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.PhoneNumberMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted phone number matches phone numbers found during discovery. Only populated when a phone number was provided in the request.", "examples": [ "EXACT", "AREA_CODE", "NO_MATCH" ] }, "phone_number_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best phone number match was found. Only populated when phone_number_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "REVIEW", "DIRECTORY" ] ], "title": "Phone Number Match Sources" }, "email_match": { "anyOf": [ { "$ref": "#/components/schemas/v2.EmailMatchType" }, { "type": "null" } ], "default": null, "description": "Indicates how closely the inputted email matches emails found during discovery. Only populated when an email was provided in the request.", "examples": [ "EXACT", "DOMAIN", "NO_MATCH" ] }, "email_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the best email match was found. Only populated when email_match is not NoMatch.", "examples": [ [ "FOUND_WEBSITE", "SOCIAL_PROFILE" ], [ "INPUT_WEBSITE", "DIRECTORY" ] ], "title": "Email Match Sources" }, "people_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "True if at least one officer name matches a person discovered during web presence analysis (exact or similar). Only populated when officer_names were provided in the request.", "examples": [ true, false ], "title": "People Match" }, "people_match_sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebPresenceSource" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The sources where the people match was found.", "examples": [ [ "FOUND_WEBSITE", "DIRECTORY" ], [ "DIRECTORY" ] ], "title": "People Match Sources" }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the inputted website matches the found business entity.", "examples": [ true, false ], "title": "Business Website Match" }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ], "title": "Business Website Redirect Match" }, "found_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The discovered website of the business.", "examples": [ "https://example.com/" ], "title": "Found Website" }, "website_accuracy": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "deprecated": true, "description": "The confidence score of the discovered website.", "examples": [ 0.95 ], "title": "Website Accuracy" }, "found_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered social profiles related to the business.", "title": "Found Social Profiles" }, "input_social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredSocialProfile" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Scraped social profiles from user-provided inputs.", "title": "Input Social Profiles" }, "social_profiles_match": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.InputSocialProfileMatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Match results for user-provided social profile inputs. Each entry echoes back the original input (site, value) and indicates whether it was also independently found during organic social discovery.", "title": "Social Profiles Match" }, "found_reviews": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredReview" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered reviews related to the business.", "title": "Found Reviews" }, "found_directory_listings": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.DiscoveredDirectoryListing" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "A list of discovered directory listings related to the business.", "title": "Found Directory Listings" }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the web presence.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "931a60db-33d9-427d-af7e-fd70aa05bde0", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "input_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the input website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "c0ac144a-ef4c-4b1b-8dfb-82b11d98bd58", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] }, "industry_prediction": { "anyOf": [ { "$ref": "#/components/schemas/v2.PredictedNaicsResponse" }, { "type": "null" } ], "default": null, "description": "The predicted NAICS code associated with the web presence.", "examples": [ { "accuracy": 0.95, "code": "541330", "keywords": [ "Engineering", "Services" ], "mcc_codes": [ { "code": "1234", "description": null, "mastercard_risk": null, "visa_risk_tier": null } ], "reasoning": null, "risk_level": "low", "sic_codes": [ { "code": "5678", "description": null } ], "title": "Engineering Services" } ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The scores associated with the web presence request, including WebKYB and WebRisk scores.", "title": "Scores" }, "reason_codes": { "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ], "items": { "$ref": "#/components/schemas/v2.ReasonCode" }, "title": "Reason Codes", "type": "array" }, "discovered_website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteAnalysisDetails" }, { "type": "null" } ], "default": null, "description": "The website analysis details associated with the discovered website.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": [ "contact@example.com" ], "id": "f3213bff-45f8-44a6-8feb-15b0e8fa6e53", "parked": false, "people": [], "phone_numbers": [ "123-456-7890" ], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null } ] } }, "required": [ "request_type", "id", "state", "created_at", "name" ], "title": "USWebPresenceResponse (v2)", "type": "object" }, "v2.VisaRiskTier": { "enum": [ 1, 2, 3 ], "title": "VisaRiskTier", "type": "integer" }, "v2.WebPresenceSource": { "enum": [ "INPUT_WEBSITE", "FOUND_WEBSITE", "SOCIAL_PROFILE", "INPUT_SOCIAL_PROFILE", "REVIEW", "DIRECTORY" ], "type": "string" }, "v2.WebhookEvent": { "description": "The canonical list of supported Webhook events.\n\nEvery Webhook event sent via the notifier must be registered here.\nAn exhaustive match is used against this enumeration to ensure that all\nevents are valid and have corresponding rendering logic.\n\n@see WebhookNotifier.render_payload", "enum": [ "BusinessSearch.submitted", "BusinessSearch.completed", "BusinessSearch.failed", "BusinessSearch.cancelled", "BusinessSearch.updated", "SearchBatch.updated", "PersonSearch.submitted", "PersonSearch.completed", "PersonSearch.failed", "PersonSearch.updated", "DMFSearch.submitted", "DMFSearch.completed", "DMFSearch.failed", "LiensSearch.submitted", "LiensSearch.completed", "LiensSearch.failed", "LienFiling.created", "LienFiling.updated", "LienFiling.deleted", "LienFilingImportBatch.completed", "LienFilingImportBatch.failed", "DocketSearch.submitted", "DocketSearch.completed", "DocketSearch.failed", "DocketDetailsSearch.submitted", "DocketDetailsSearch.completed", "DocketDetailsSearch.failed", "DocketExhibitSearch.submitted", "DocketExhibitSearch.completed", "DocketExhibitSearch.failed", "APIKey.created", "APIKey.deleted", "OnboardingSession.completed", "OnboardingSession.failed", "OnboardingSession.updated", "Verification.completed", "Verification.failed", "Verification.updated", "Order.created", "EmailSender.failed", "NAICSPredictionRequest.submitted", "NAICSPredictionRequest.completed", "NAICSPredictionRequest.failed", "WebsiteAnalysisRequest.submitted", "WebsiteAnalysisRequest.completed", "WebsiteAnalysisRequest.failed", "WebPresenceRequest.submitted", "WebPresenceRequest.completed", "WebPresenceRequest.failed", "PortfolioItem.created", "PortfolioItem.updated", "PortfolioItem.deleted", "PortfolioGroup.created", "PortfolioGroup.updated", "PortfolioGroup.deleted", "TINVerification.submitted", "TINVerification.completed", "TINVerification.failed", "AdverseMediaSearch.submitted", "AdverseMediaSearch.completed", "AdverseMediaSearch.failed", "EmployeeVerificationRequest.submitted", "EmployeeVerificationRequest.completed", "EmployeeVerificationRequest.failed", "InternationalBusinessSearch.submitted", "InternationalBusinessSearch.completed", "InternationalBusinessSearch.failed" ], "title": "WebhookEvent", "type": "string" }, "v2.WebhookMetadata": { "properties": { "type": { "$ref": "#/components/schemas/v2.WebhookEvent" }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/v2.RequestOrigin" }, { "type": "null" } ], "default": null }, "notices": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notices" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "application_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Application Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "External Id" }, "application_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Application Type" } }, "required": [ "type" ], "title": "WebhookMetadata", "type": "object" }, "v2.WebsiteAnalysisDetails": { "properties": { "id": { "description": "The ID of the Website Analysis request", "format": "uuid", "title": "Id", "type": "string" }, "url": { "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.warner.com/" ], "format": "uri", "minLength": 1, "title": "Url", "type": "string" }, "redirects": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteRedirectInfo" }, { "type": "null" } ], "default": null, "description": "Redirect information for this website, if a cross-domain redirect was detected.", "examples": [ { "is_redirect_url": true, "redirects_to": "baselayer.com" } ] }, "parked": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "A boolean indicating if the website is suspected of being a parked domain.", "examples": [ true, false ], "title": "Parked" }, "email_deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "A boolean indicating if the website is able to send and receive emails.", "examples": [ true, false ], "title": "Email Deliverable" }, "phone_numbers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The list of phone numbers that were identified on the analyzed website.", "examples": [ [ "362-345-4551", "(872) 628-1402" ] ], "title": "Phone Numbers" }, "emails": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The list of email addresses that were identified on the analyzed website.", "examples": [ [ "bennettamber@example.org", "goldenshawn@example.com" ] ], "title": "Emails" }, "social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.SocialProfile" }, "type": "array" }, { "type": "null" } ], "description": "The list of social media profiles that were identified on the analyzed website.", "examples": [ [ { "site": "twitter", "url": "https://twitter.com/michelle98", "username": "michelle98" } ] ], "title": "Social Profiles" }, "addresses": { "default": [], "description": "The list of mailing addresses that were identified on the analyzed website.", "items": { "$ref": "#/components/schemas/v2.AddressSummaryResponse" }, "title": "Addresses", "type": "array" }, "people": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v2.WebsiteAnalysisPerson" }, "type": "array" }, { "type": "null" } ], "description": "The list of people identified on the analyzed website.", "examples": [ [ { "name": "Jane Smith", "titles": [ "Co-Founder", "CEO" ] }, { "name": "John Doe", "titles": [ "CTO" ] } ] ], "title": "People" }, "website_build_status": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteBuildStatus" }, { "type": "null" } ], "default": null, "description": "The build status of the website." }, "website_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A summary of the business based on the analyzed website content.", "examples": [ "Howard Concrete Pumping Co., Inc. is a concrete pumping contractor serving the construction industry. The company specializes in concrete placement services for residential and commercial construction projects. They operate throughout the greater metropolitan area and have been providing reliable concrete pumping solutions for over 20 years." ], "title": "Website Summary" }, "console_url": { "description": "The URL to the Website Analysis details in the console.", "examples": [ "https://console.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis" ], "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Console Url", "type": "string" }, "screenshot_url": { "anyOf": [ { "format": "uri", "maxLength": 2083, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "description": "The URL to download the homepage screenshot of the analyzed website.", "examples": [ "https://api.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis/screenshot" ], "title": "Screenshot Url" }, "whois_record": { "anyOf": [ { "$ref": "#/components/schemas/v2.WhoIsRecordResponse" }, { "type": "null" } ], "default": null, "description": "The WHOIS record information for the analyzed website." }, "ssl_validity": { "anyOf": [ { "$ref": "#/components/schemas/v2.SSLValidityInfo" }, { "type": "null" } ], "default": null, "description": "The SSL certificate validity information for the analyzed website, including fraud-relevant signals.", "examples": [ { "cert_age_days": 185, "certificate_type": "EV", "days_until_expiry": 180, "expiry_date": "2025-01-15T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-01-15T00:00:00", "issuer": "DigiCert Global Root CA", "key_size": 2048, "reason": null, "subject": "www.example.com", "tls_version": "TLSv1.3" }, { "cert_age_days": 395, "certificate_type": "DV", "days_until_expiry": -30, "expiry_date": "2024-01-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": false, "is_wildcard": false, "issued_date": "2023-01-01T00:00:00", "issuer": "R3", "key_size": 256, "reason": "CERTIFICATE_EXPIRED", "subject": "expired.example.com", "tls_version": "TLSv1.2" } ] }, "website_structure_metrics": { "anyOf": [ { "$ref": "#/components/schemas/v2.WebsiteStructureMetrics" }, { "type": "null" } ], "default": null, "description": "Website structure metrics including depth and breadth discovered during scraping.", "examples": [ { "breadth": "15+", "depth": "2+" }, { "breadth": "5", "depth": "1" }, { "breadth": "1", "depth": "0" } ] } }, "required": [ "id", "url", "parked", "emails", "social_profiles", "console_url" ], "title": "WebsiteAnalysisDetails (v1)", "type": "object" }, "v2.WebsiteAnalysisPerson": { "properties": { "name": { "title": "Name", "type": "string" }, "titles": { "items": { "type": "string" }, "title": "Titles", "type": "array", "uniqueItems": true } }, "required": [ "name", "titles" ], "title": "WebsiteAnalysisPerson", "type": "object" }, "v2.WebsiteBuildStatus": { "enum": [ "coming_soon", "inactive", "active" ], "title": "WebsiteBuildStatus", "type": "string" }, "v2.WebsiteRedirectInfo": { "properties": { "is_redirect_url": { "description": "Indicates that this website performs a cross-domain redirect.", "examples": [ true ], "title": "Is Redirect Url", "type": "boolean" }, "redirects_to": { "description": "The domain this website redirects to.", "examples": [ "baselayer.com" ], "title": "Redirects To", "type": "string" } }, "required": [ "is_redirect_url", "redirects_to" ], "title": "WebsiteRedirectInfo (v1)", "type": "object" }, "v2.WebsiteStructureMetrics": { "description": "Website structure metrics discovered during scraping.\n\nFormatted as strings for display:\n- depth: \"0\", \"1\", or \"2+\"\n- breadth: actual count as string or \"15+\"", "properties": { "depth": { "description": "Maximum depth reached: '0' (homepage only), '1' (one level), or '2+' (structured site)", "examples": [ "0", "1", "2+" ], "title": "Depth", "type": "string" }, "breadth": { "description": "Total unique pages discovered: actual count or '15+' for substantial sites", "examples": [ "5", "12", "15+" ], "title": "Breadth", "type": "string" } }, "required": [ "depth", "breadth" ], "title": "WebsiteStructureMetrics", "type": "object" }, "v2.WhoIsRecordResponse": { "properties": { "domain_created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain was first registered.", "examples": [ "2020-05-15T10:30:00Z" ], "title": "Domain Created At" }, "domain_age_months": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "The age of the domain since its creation in months.", "examples": [ 15 ], "title": "Domain Age Months" }, "domain_updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain registration was last updated.", "examples": [ "2023-06-01T14:45:00Z" ], "title": "Domain Updated At" }, "domain_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "The date and time when the domain registration is set to expire.", "examples": [ "2025-05-15T10:30:00Z" ], "title": "Domain Expires At" }, "registrar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the domain registrar.", "examples": [ "Example Registrar Inc." ], "title": "Registrar" } }, "required": [ "domain_created_at", "domain_updated_at", "domain_expires_at", "registrar" ], "title": "WhoIsRecordResponse (v1)", "type": "object" }, "OnboardingFinding": { "properties": { "code": { "$ref": "#/components/schemas/OnboardingFindingCode", "description": "Machine-readable finding code." }, "check": { "$ref": "#/components/schemas/OnboardingFindingCheck", "description": "Verification check the finding pertains to." }, "gating": { "type": "boolean", "title": "Gating", "description": "True when the finding names a verdict gate that held the session in review; False for reviewer-facing evidence flags (website corroboration, officer match) that never move the automated verdict." }, "summary": { "type": "string", "title": "Summary", "description": "Human-readable finding summary, frozen at packet delivery with the session's specifics (e.g. the submitted website)." }, "data_keys": { "items": { "$ref": "#/components/schemas/OnboardingDataKey" }, "type": "array", "title": "Data Keys", "description": "Collected data keys whose submitted values this finding disputes; empty when the finding names no specific field. Derived from the code, so persisted rows can never go stale.", "readOnly": true } }, "type": "object", "required": [ "code", "check", "gating", "summary", "data_keys" ], "title": "OnboardingFinding", "description": "One materialized finding on a delivered onboarding session.\n\nReads of persisted findings must go through :meth:`from_persisted`:\nunknown keys are ignored (a newer writer may have added fields) and a\nrow this reader cannot parse at all is skipped with a warning — one\nskewed row must never take down a whole queue page, results dossier,\nor webhook render." }, "v1.InternationalBusinessSearchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the international business search." }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name inputted in the search (null when omitted).", "examples": [ "Acme Corporation" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address string inputted in the search (null when omitted).", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/InternationalSearchISO2CountryCode" }, { "type": "null" } ], "description": "The ISO 2 country code the search ran against.", "examples": [ "GB" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalAddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "filing_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Number", "description": "The company registration (filing) number inputted in the search.", "examples": [ "09517735" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/InternationalAddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "filing_number_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Filing Number Match", "description": "Whether the inputted filing number found the company at the registry. False means the search fell back to the name search; null means no filing number was provided or the lookup was unavailable.", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.205317" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.205334" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "True when the KYB grade is A or B. A filing-number mismatch reduces the score but does not independently block verification.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "Persisted watchlist screening results for this search. A source with count zero completed screening without matches. An absent source does not indicate a completed or clean screen." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "Address validation is unavailable." ] }, "options": { "items": { "$ref": "#/components/schemas/InternationalBusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional, separately-billed add-ons requested for this search.", "examples": [ [ "Order.Enhanced" ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalBusinessResponse" }, { "type": "null" } ], "description": "A summary of the found business. When the enhanced profile add-on is ordered, this also includes officers, beneficial owners, shareholders, share capital, contact details, and the registered agent, along with fuller registry and tax identifiers and classified business activities." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "country_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Name", "description": "The display name of `iso2_country_code`, as `GET /international/countries` names it.", "readOnly": true, "examples": [ "United Kingdom" ] } }, "type": "object", "required": [ "id", "state", "created_at", "url", "country_name" ], "title": "InternationalBusinessSearchResponse (v1)", "description": "Response model for international business search." }, "v1.AuditLogEntryResponse": { "description": "One committed audit-log entry, sliced to the caller's own org-scoped\nrefs (``GET /issuance/audit_log``).", "properties": { "seq": { "description": "The entry's permanent sequence number (Merkle leaf index).", "title": "Seq", "type": "integer" }, "event": { "description": "The decoded audit event.", "discriminator": { "mapping": { "credential_revocation": "#/components/schemas/v1.CredentialRevocationReadEvent", "identity_registration": "#/components/schemas/v1.IdentityRegistrationReadEvent", "issuance": "#/components/schemas/v1.IssuanceReadEvent" }, "propertyName": "event_type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.IssuanceReadEvent" }, { "$ref": "#/components/schemas/v1.CredentialRevocationReadEvent" }, { "$ref": "#/components/schemas/v1.IdentityRegistrationReadEvent" } ], "title": "Event" } }, "required": [ "seq", "event" ], "title": "AuditLogEntryResponse (v1)", "type": "object" }, "v1.CredentialEventResponse": { "description": "One issuance or revocation, as the organization that minted reads it.", "properties": { "event_type": { "$ref": "#/components/schemas/v1.CredentialEventKind" }, "occurred_at": { "format": "date-time", "title": "Occurred At", "type": "string" }, "credential_id": { "description": "The credential's unique id: its token's `jti`.", "title": "Credential Id", "type": "string" }, "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the credential was minted in." }, "source_environment": { "anyOf": [ { "$ref": "#/components/schemas/v1.ApplicationType" }, { "type": "null" } ], "default": null, "description": "On a test credential for a person or business verified in another environment, that environment; the credential itself is signed in `environment`. Null otherwise." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel" }, "preset": { "anyOf": [ { "$ref": "#/components/schemas/v1.CredentialPreset" }, { "type": "null" } ], "description": "The preset the mint named; null when it listed its own paths." }, "individual_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Display Name" }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref" }, "business_legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Legal Name" }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref" }, "issued_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Issued to column: the person's name, or the business's when no person acts for it.", "title": "Issued To" }, "audience": { "title": "Audience", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.IssuedCredentialLifecycleState", "description": "The credential's state now, not at the event." }, "actor": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "description": "Who minted (issued) or revoked (revoked), as they were then." }, "revocation_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.AuditRevocationReason" }, { "type": "null" } ], "description": "Why it was revoked; null on issued rows." } }, "required": [ "event_type", "occurred_at", "credential_id", "environment", "level", "preset", "individual_display_name", "individual_ref", "business_legal_name", "business_ref", "issued_to", "audience", "state", "actor", "revocation_reason" ], "title": "CredentialEventResponse (v1)", "type": "object" }, "v1.CredentialMintResponse": { "description": "Body of ``POST /issuance/credentials``: one credential for an individual, and\nfor a business L3 mint the subject's followed by the actor's.", "properties": { "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the credentials were minted in." }, "ttl_capped": { "description": "Whether supporting evidence expiry shortened the requested validity; each entry's `expires_at` is the instant it ends.", "title": "Ttl Capped", "type": "boolean" }, "credentials": { "description": "The minted credentials, subject first.", "items": { "$ref": "#/components/schemas/v1.CredentialMintEntry" }, "title": "Credentials", "type": "array" } }, "required": [ "environment", "ttl_capped", "credentials" ], "title": "CredentialMintResponse (v1)", "type": "object" }, "v1.CredentialMintRequest": { "description": "Body for ``POST /issuance/credentials``: mint an L2 or L3 credential for a\nverified person as themselves (``type: INDIVIDUAL``), or as the operator\nof a specific business (``type: BUSINESS``, which also names the\nbusiness's ``business_ref``).", "discriminator": { "mapping": { "BUSINESS": "#/components/schemas/v1.BusinessCredentialMintRequest", "INDIVIDUAL": "#/components/schemas/v1.IndividualCredentialMintRequest" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.IndividualCredentialMintRequest" }, { "$ref": "#/components/schemas/v1.BusinessCredentialMintRequest" } ], "title": "CredentialMintRequest" }, "v1.IssuedCredentialResponse": { "description": "One record from the organization's credential issuance log.\n\nThe dispute-evidence view of a mint: who was authorized, for which\ncounterparty, disclosing what, signed with which key, and whether the\ncredential has since been revoked, keyed by the ``credential_id`` (the\ntoken's ``jti``) a relying party's exchange log records. Carries no\ncredential material; only ``IssuedCredentialDetailResponse`` does.", "properties": { "credential_id": { "description": "The credential's unique id: exactly the `jti` its token carries.", "title": "Credential Id", "type": "string" }, "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the credential was minted in." }, "source_environment": { "anyOf": [ { "$ref": "#/components/schemas/v1.ApplicationType" }, { "type": "null" } ], "default": null, "description": "On a test credential for a person or business verified in another environment, that environment; the credential itself is signed in `environment`. Null otherwise." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "description": "The credential layer minted." }, "credential_format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "description": "The credential's wire format." }, "iss": { "description": "The token's `iss` claim: the issuer that signed it.", "title": "Iss", "type": "string" }, "vct": { "description": "The token's `vct` claim: the credential type identifier.", "title": "Vct", "type": "string" }, "status_list": { "$ref": "#/components/schemas/v1.CredentialStatusListPointer", "description": "The token's `status.status_list` claim: where a verifier reads this credential's revocation bit." }, "linked_credential_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "On a business L3 mint's actor credential, the `credential_id` of the business credential minted with it; null otherwise.", "title": "Linked Credential Id" }, "status": { "$ref": "#/components/schemas/v1.IssuedCredentialStatus", "description": "The credential's persisted revocation standing: `VALID`, or `REVOKED` once its bit is set on the published status list. Expiry does not change it." }, "state": { "$ref": "#/components/schemas/v1.IssuedCredentialLifecycleState", "description": "The credential's lifecycle as of this request: `ACTIVE`, `EXPIRED` once `expires_at` has passed, or `REVOKED`. The same value the `state` filter selects on." }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The instant the credential was revoked; null while it remains valid.", "title": "Revoked At" }, "revocation_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.AuditRevocationReason" }, { "type": "null" } ], "default": null, "description": "Why the credential was revoked. Null while it remains valid and on records revoked before the reason was recorded." }, "revoked_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who revoked the credential: the console user or the API key. Captured at revocation and never rewritten. Null while the credential remains valid and on records revoked before the actor was recorded." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The pairwise individual reference involved in the mint: the individual subject, or the acting individual who authorized a business mint. Null on counterparty mints and when that individual no longer exists.", "title": "Individual Ref" }, "individual_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first and last name of the individual `individual_ref` names, as the credential minted it. Null on counterparty mints and on records minted before names were recorded.", "title": "Individual Display Name" }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The pairwise business reference minted for, as issued to your organization; null on individual mints and when the subject no longer exists.", "title": "Business Ref" }, "business_legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The business's legal name as the credential minted it. Null on individual mints and on records minted before names were recorded.", "title": "Business Legal Name" }, "audience": { "description": "The canonical audience the credential is scoped to.", "title": "Audience", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Counterparty credentials only: the public business DID the credential's sub claim carries; null on agent credentials.", "title": "Subject" }, "issued_at": { "description": "Issuance instant (the issuer JWT's iat).", "format": "date-time", "title": "Issued At", "type": "string" }, "expires_at": { "description": "Expiry instant (the issuer JWT's exp).", "format": "date-time", "title": "Expires At", "type": "string" }, "disclosed_fields": { "description": "The dotted disclosure paths the credential carries; empty for L2 mints.", "items": { "type": "string" }, "title": "Disclosed Fields", "type": "array" }, "active_keys": { "description": "Names of the verification checks that passed (e.g. `phone_possession` for an individual, `tax_id_match` for a business), from the token-exchange profile's key vocabulary; the verification level is derived from them.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "signing_kid": { "description": "The id of the issuer key that signed the credential (the RFC 7638 thumbprint published in the issuer's JWKS).", "title": "Signing Kid", "type": "string" }, "minted_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who initiated the mint: the console user or the API key. Captured at mint time and never rewritten. Null on records minted before the actor's kind was recorded." }, "agent_key_kid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The caller-supplied kid of the agent key the credential was bound to, if one was provided. Null on counterparty credentials and on records minted before it was recorded.", "title": "Agent Key Kid" }, "agent_key_thumbprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "RFC 7638 thumbprint of the agent public key bound into the credential's cnf claim. Null on counterparty credentials and on records minted before it was recorded.", "title": "Agent Key Thumbprint" }, "disclosure_mode": { "anyOf": [ { "$ref": "#/components/schemas/v1.DisclosureMode" }, { "type": "null" } ], "default": null, "description": "The selective-disclosure mode the mint requested. Null on L2 and counterparty mints, and on L3 records minted before it was recorded." }, "preset": { "anyOf": [ { "maxLength": 32, "pattern": "^[a-z][a-z0-9_]*$", "type": "string" }, { "type": "null" } ], "default": null, "description": "The preset the mint disclosed by; null when it listed its own disclosed_fields, and on L2 and counterparty mints.", "title": "Preset" } }, "required": [ "credential_id", "environment", "level", "credential_format", "iss", "vct", "status_list", "status", "state", "audience", "issued_at", "expires_at", "signing_kid" ], "title": "IssuedCredentialResponse (v1)", "type": "object" }, "v1.CredentialPreviewRequest": { "description": "Body for ``POST /issuance/credentials/preview``: the mint body, previewed.", "discriminator": { "mapping": { "BUSINESS": "#/components/schemas/v1.BusinessCredentialPreviewRequest", "INDIVIDUAL": "#/components/schemas/v1.IndividualCredentialPreviewRequest" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.IndividualCredentialPreviewRequest" }, { "$ref": "#/components/schemas/v1.BusinessCredentialPreviewRequest" } ], "title": "CredentialPreviewRequest" }, "v1.CredentialPreviewResponse": { "description": "Body of ``POST /issuance/credentials/preview``: what a mint with the same body\nwould disclose, without signing, storing or allocating anything. The\nmint response's shape, with leaves in place of the credential strings.", "properties": { "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the mint would run in." }, "ttl_capped": { "description": "Whether supporting evidence expiry would shorten the requested validity.", "title": "Ttl Capped", "type": "boolean" }, "credentials": { "description": "The credentials a mint would produce, subject first.", "items": { "$ref": "#/components/schemas/v1.CredentialPreviewEntry" }, "title": "Credentials", "type": "array" } }, "required": [ "environment", "ttl_capped", "credentials" ], "title": "CredentialPreviewResponse (v1)", "type": "object" }, "v1.RevokeCredentialRequest": { "additionalProperties": false, "description": "Why a credential is being revoked.", "properties": { "reason": { "$ref": "#/components/schemas/v1.CustomerRevocationReason", "description": "Why the credential is being revoked; recorded on the issuance record and its audit event." } }, "required": [ "reason" ], "title": "RevokeCredentialRequest (v1)", "type": "object" }, "v1.CredentialPresetResponse": { "description": "One entry of ``GET /issuance/credentials/presets``: a use case and the exact\npaths a mint by it requests under each hat.", "properties": { "key": { "$ref": "#/components/schemas/v1.CredentialPreset", "description": "The value a mint sends as `preset`." }, "label": { "description": "Display name.", "title": "Label", "type": "string" }, "requires_business": { "description": "Whether only a business mint (a person at a business) accepts it.", "title": "Requires Business", "type": "boolean" }, "individual_disclosed_fields": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The subject claim paths an individual mint by this preset requests; null when it requires a business.", "title": "Individual Disclosed Fields" }, "business_disclosed_fields": { "description": "The business credential's paths a business mint by this preset requests.", "items": { "type": "string" }, "title": "Business Disclosed Fields", "type": "array" }, "business_actor_disclosed_fields": { "description": "The actor credential's unprefixed paths a business mint by this preset requests, as `actor_disclosed_fields`.", "items": { "type": "string" }, "title": "Business Actor Disclosed Fields", "type": "array" }, "is_individual_default": { "description": "Whether this is the preset to preselect for a person on their own: the most conservative one an individual mint accepts.", "title": "Is Individual Default", "type": "boolean" }, "is_business_default": { "description": "Whether this is the preset to preselect for a person at a business: the most conservative one a business mint accepts.", "title": "Is Business Default", "type": "boolean" } }, "required": [ "key", "label", "requires_business", "individual_disclosed_fields", "business_disclosed_fields", "business_actor_disclosed_fields", "is_individual_default", "is_business_default" ], "title": "CredentialPresetResponse (v1)", "type": "object" }, "v1.IssuedCredentialDetailResponse": { "description": "``GET /issuance/credentials/{credential_id}``: the issuance record plus the\ncredential string the mint returned.", "properties": { "credential_id": { "description": "The credential's unique id: exactly the `jti` its token carries.", "title": "Credential Id", "type": "string" }, "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the credential was minted in." }, "source_environment": { "anyOf": [ { "$ref": "#/components/schemas/v1.ApplicationType" }, { "type": "null" } ], "default": null, "description": "On a test credential for a person or business verified in another environment, that environment; the credential itself is signed in `environment`. Null otherwise." }, "level": { "$ref": "#/components/schemas/v1.CredentialMintLevel", "description": "The credential layer minted." }, "credential_format": { "$ref": "#/components/schemas/v1.CredentialWireFormat", "description": "The credential's wire format." }, "iss": { "description": "The token's `iss` claim: the issuer that signed it.", "title": "Iss", "type": "string" }, "vct": { "description": "The token's `vct` claim: the credential type identifier.", "title": "Vct", "type": "string" }, "status_list": { "$ref": "#/components/schemas/v1.CredentialStatusListPointer", "description": "The token's `status.status_list` claim: where a verifier reads this credential's revocation bit." }, "linked_credential_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "On a business L3 mint's actor credential, the `credential_id` of the business credential minted with it; null otherwise.", "title": "Linked Credential Id" }, "status": { "$ref": "#/components/schemas/v1.IssuedCredentialStatus", "description": "The credential's persisted revocation standing: `VALID`, or `REVOKED` once its bit is set on the published status list. Expiry does not change it." }, "state": { "$ref": "#/components/schemas/v1.IssuedCredentialLifecycleState", "description": "The credential's lifecycle as of this request: `ACTIVE`, `EXPIRED` once `expires_at` has passed, or `REVOKED`. The same value the `state` filter selects on." }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "The instant the credential was revoked; null while it remains valid.", "title": "Revoked At" }, "revocation_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.AuditRevocationReason" }, { "type": "null" } ], "default": null, "description": "Why the credential was revoked. Null while it remains valid and on records revoked before the reason was recorded." }, "revoked_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who revoked the credential: the console user or the API key. Captured at revocation and never rewritten. Null while the credential remains valid and on records revoked before the actor was recorded." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The pairwise individual reference involved in the mint: the individual subject, or the acting individual who authorized a business mint. Null on counterparty mints and when that individual no longer exists.", "title": "Individual Ref" }, "individual_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The first and last name of the individual `individual_ref` names, as the credential minted it. Null on counterparty mints and on records minted before names were recorded.", "title": "Individual Display Name" }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The pairwise business reference minted for, as issued to your organization; null on individual mints and when the subject no longer exists.", "title": "Business Ref" }, "business_legal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The business's legal name as the credential minted it. Null on individual mints and on records minted before names were recorded.", "title": "Business Legal Name" }, "audience": { "description": "The canonical audience the credential is scoped to.", "title": "Audience", "type": "string" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Counterparty credentials only: the public business DID the credential's sub claim carries; null on agent credentials.", "title": "Subject" }, "issued_at": { "description": "Issuance instant (the issuer JWT's iat).", "format": "date-time", "title": "Issued At", "type": "string" }, "expires_at": { "description": "Expiry instant (the issuer JWT's exp).", "format": "date-time", "title": "Expires At", "type": "string" }, "disclosed_fields": { "description": "The dotted disclosure paths the credential carries; empty for L2 mints.", "items": { "type": "string" }, "title": "Disclosed Fields", "type": "array" }, "active_keys": { "description": "Names of the verification checks that passed (e.g. `phone_possession` for an individual, `tax_id_match` for a business), from the token-exchange profile's key vocabulary; the verification level is derived from them.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "signing_kid": { "description": "The id of the issuer key that signed the credential (the RFC 7638 thumbprint published in the issuer's JWKS).", "title": "Signing Kid", "type": "string" }, "minted_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "default": null, "description": "Who initiated the mint: the console user or the API key. Captured at mint time and never rewritten. Null on records minted before the actor's kind was recorded." }, "agent_key_kid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The caller-supplied kid of the agent key the credential was bound to, if one was provided. Null on counterparty credentials and on records minted before it was recorded.", "title": "Agent Key Kid" }, "agent_key_thumbprint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "RFC 7638 thumbprint of the agent public key bound into the credential's cnf claim. Null on counterparty credentials and on records minted before it was recorded.", "title": "Agent Key Thumbprint" }, "disclosure_mode": { "anyOf": [ { "$ref": "#/components/schemas/v1.DisclosureMode" }, { "type": "null" } ], "default": null, "description": "The selective-disclosure mode the mint requested. Null on L2 and counterparty mints, and on L3 records minted before it was recorded." }, "preset": { "anyOf": [ { "maxLength": 32, "pattern": "^[a-z][a-z0-9_]*$", "type": "string" }, { "type": "null" } ], "default": null, "description": "The preset the mint disclosed by; null when it listed its own disclosed_fields, and on L2 and counterparty mints.", "title": "Preset" }, "credential": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The SD-JWT-VC wire string the mint returned, stored encrypted. Null unless the caller may mint credentials, on records minted before it was stored, and when the stored copy cannot be decrypted. Holder-bound: it cannot be presented without the agent's private key.", "title": "Credential" } }, "required": [ "credential_id", "environment", "level", "credential_format", "iss", "vct", "status_list", "status", "state", "audience", "issued_at", "expires_at", "signing_kid" ], "title": "IssuedCredentialDetailResponse (v1)", "type": "object" }, "v1.DirectoryBusinessListItemResponse": { "description": "One listed directory entry, as the browse list renders it.", "properties": { "id": { "description": "The directory entry's id — resolvable via `GET /directory/businesses/{id}`.", "format": "uuid", "title": "Id", "type": "string" }, "display_name": { "description": "The business's display name.", "title": "Display Name", "type": "string" }, "domain": { "description": "The merchant's canonical domain, where its kya-profile.json and counterparty credential are served.", "title": "Domain", "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The business's website URL.", "title": "Website" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the business's logo.", "title": "Logo Url" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A short description of what the business does.", "title": "Summary" }, "kyb_verified": { "description": "Whether the entry is backed by a business whose public registry record is current: an active registration in good standing. Derived from public records, never from any organization's private evaluation; always false for an entry with no linked business.", "title": "Kyb Verified", "type": "boolean" }, "payment_rails": { "description": "The agentic payment rails the business advertises accepting.", "items": { "$ref": "#/components/schemas/v1.AgenticPaymentRail" }, "title": "Payment Rails", "type": "array" } }, "required": [ "id", "display_name", "domain", "kyb_verified" ], "title": "DirectoryBusinessListItemResponse (v1)", "type": "object" }, "v1.DirectoryBusinessResponse": { "description": "Body for ``GET /directory/businesses/{id}``: the full entry.", "properties": { "id": { "description": "The directory entry's id — resolvable via `GET /directory/businesses/{id}`.", "format": "uuid", "title": "Id", "type": "string" }, "display_name": { "description": "The business's display name.", "title": "Display Name", "type": "string" }, "domain": { "description": "The merchant's canonical domain, where its kya-profile.json and counterparty credential are served.", "title": "Domain", "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The business's website URL.", "title": "Website" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "URL of the business's logo.", "title": "Logo Url" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "A short description of what the business does.", "title": "Summary" }, "kyb_verified": { "description": "Whether the entry is backed by a business whose public registry record is current: an active registration in good standing. Derived from public records, never from any organization's private evaluation; always false for an entry with no linked business.", "title": "Kyb Verified", "type": "boolean" }, "payment_rails": { "description": "The agentic payment rails the business advertises accepting.", "items": { "$ref": "#/components/schemas/v1.AgenticPaymentRail" }, "title": "Payment Rails", "type": "array" }, "registry_record": { "anyOf": [ { "$ref": "#/components/schemas/v1.DirectoryRegistryRecordResponse" }, { "type": "null" } ], "default": null, "description": "The public-record identity of the linked business — legal name and incorporation facts; null for an entry with no linked business, which is also always unverified." }, "contacts": { "description": "Points of contact the business publishes for questions — self-declared business-role details, never verification data.", "items": { "$ref": "#/components/schemas/v1.DirectoryContact" }, "title": "Contacts", "type": "array" }, "kya_profile": { "anyOf": [ { "$ref": "#/components/schemas/v1.DisclosureProfile" }, { "type": "null" } ], "default": null, "description": "The business's published kya-profile.json: the disclosure scopes it requests, each naming the fields, purpose, legal basis, and retention behind one use case." }, "counterparty_credential": { "anyOf": [ { "$ref": "#/components/schemas/v1.DirectoryCounterpartyCredentialResponse" }, { "type": "null" } ], "default": null, "description": "The serving state of the counterparty credential this entry's domain hosts; null when the entry has no linked business, or that business never minted one for this domain." } }, "required": [ "id", "display_name", "domain", "kyb_verified" ], "title": "DirectoryBusinessResponse (v1)", "type": "object" }, "v1.OperatorLinkResponse": { "description": "One operator link your organization holds, naming both ends: a row\nof 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": [ { "format": "uuid", "type": "string" }, { "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" }, "v1.OperatorLinkDetailResponse": { "description": "One operator link with the evidence behind it.", "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": [ { "format": "uuid", "type": "string" }, { "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" }, "evidence": { "$ref": "#/components/schemas/v1.OperatorLinkEvidenceResponse", "description": "The evaluation a credential minted now would assert, which can be older than the newest when a later session only lacked a check." } }, "required": [ "status", "created_at", "individual_ref", "business_ref", "business_legal_name", "shortfalls", "evidence" ], "title": "OperatorLinkDetailResponse (v1)", "type": "object" }, "v1.BusinessOperatorLinkDecisionRequest": { "additionalProperties": false, "description": "Body for verifying or rejecting your organization's operator link.", "properties": { "decision": { "$ref": "#/components/schemas/v1.BusinessOperatorLinkDecision", "description": "`VERIFIED` to affirm that the individual operates the business, `REJECTED` to refuse it. Applies to your organization only." }, "reason": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional internal reason, kept with the decision.", "title": "Reason" } }, "required": [ "decision" ], "title": "BusinessOperatorLinkDecisionRequest (v1)", "type": "object" }, "v1.Verification": { "description": "A verification of an individual, or of an individual and the business\nthey operate, submitted directly.\n\nThe body of every ``/issuance/identities/verifications`` route and of the\n``Verification.*`` webhooks.", "properties": { "verification_id": { "description": "Unique id of the verification.", "format": "uuid", "title": "Verification Id", "type": "string" }, "type": { "$ref": "#/components/schemas/v1.VerificationType", "description": "Whether a business is verified too." }, "state": { "$ref": "#/components/schemas/v1.VerificationState", "description": "Lifecycle state of the verification workflow." }, "automated_verdict": { "anyOf": [ { "$ref": "#/components/schemas/v1.OnboardingVerdict" }, { "type": "null" } ], "default": null, "description": "What the checks concluded, `APPROVED` or `UNDER_REVIEW`; null until the verification completes." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/v1.OnboardingVerdict" }, { "type": "null" } ], "default": null, "description": "The effective verdict: your reviewer's decision when one was made, otherwise `automated_verdict`." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "default": null, "description": "Typed state and detail when the workflow ended in FAILED; null otherwise." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it.", "title": "Individual Ref" }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified.", "title": "Business Ref" }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessOperatorLinkStatus" }, { "type": "null" } ], "default": null, "description": "Status of the individual-operates-business link as of this verification." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Caller-supplied correlation id.", "title": "Reference Id" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The `Idempotency-Key` the verification was created with.", "title": "Idempotency Key" }, "environment": { "$ref": "#/components/schemas/v1.ApplicationType", "description": "The environment the verification ran in." }, "created_at": { "description": "When the verification was created.", "format": "date-time", "title": "Created At", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the verification reached a terminal status.", "title": "Completed At" } }, "required": [ "verification_id", "type", "state", "environment", "created_at" ], "title": "Verification (v1)", "type": "object" }, "v1.CreateVerificationRequest": { "description": "A direct verification, chosen by ``type``. Re-verify an individual\nwith ``POST /issuance/identities/individuals/{individual_ref}/reverify``.", "discriminator": { "mapping": { "BUSINESS": "#/components/schemas/v1.BusinessVerificationRequest", "INDIVIDUAL": "#/components/schemas/v1.IndividualVerificationRequest" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.IndividualVerificationRequest" }, { "$ref": "#/components/schemas/v1.BusinessVerificationRequest" } ], "title": "CreateVerificationRequest" }, "v1.IdentityListItemResponse": { "description": "One person in ``GET /issuance/identities/individuals``.\n\nThe row an operator scans a population by: who the identity is, whether\nit can still mint, and how much it has been used. Everything is scoped\nto the calling organization — the reference, the covered links counted,\nand the credentials counted are all its own.", "properties": { "individual_ref": { "description": "This organization's pairwise reference to the individual.", "title": "Individual Ref", "type": "string" }, "display_name": { "description": "The verified name, as the latest snapshot recorded it. Mask it in shared surfaces; the API returns what the organization itself submitted.", "title": "Display Name", "type": "string" }, "verification_state": { "$ref": "#/components/schemas/v1.IdentityVerificationState", "description": "CURRENT, or EXPIRED (re-verify before minting). Derived from the snapshot's validity window, never stored." }, "verification_level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Verification level derived from active_keys; null when the attested attributes are insufficient for any defined level.", "title": "Verification Level" }, "active_keys": { "description": "Names of the individual verification checks the identity currently holds (e.g. `phone_possession`, `ssn_identity_match`), from the token-exchange profile's key vocabulary; verification_level is derived from them. A re-verification keeps an earlier `phone_possession` it cannot re-run.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "linked_business_count": { "description": "Businesses this organization covers a live operator link to for the individual; rejected links are not counted.", "title": "Linked Business Count", "type": "integer" }, "businesses": { "description": "Up to three of the businesses counted by `linked_business_count`: verified links first, then link requests, each oldest first.", "items": { "$ref": "#/components/schemas/v1.IdentityListBusinessResponse" }, "title": "Businesses", "type": "array" }, "last_activity_at": { "description": "The latest of: verified or re-verified, a link confirmed or decided, an agent credential issued or revoked. Your organization's own activity only.", "format": "date-time", "title": "Last Activity At", "type": "string" }, "credentials_minted_30d": { "description": "Credentials this organization minted for the individual in the last 30 days, counting business credentials it acted for.", "title": "Credentials Minted 30D", "type": "integer" }, "verified_at": { "description": "When the latest verification was recorded.", "format": "date-time", "title": "Verified At", "type": "string" }, "expires_at": { "description": "When the latest verification expires.", "format": "date-time", "title": "Expires At", "type": "string" } }, "required": [ "individual_ref", "display_name", "verification_state", "linked_business_count", "last_activity_at", "credentials_minted_30d", "verified_at", "expires_at" ], "title": "IdentityListItemResponse (v1)", "type": "object" }, "v1.BusinessListItemResponse": { "description": "One business in ``GET /issuance/identities/businesses``.\n\nPopulation rule: a business appears once this organization holds a\npairwise reference for it, which the directory mints for any business it\ncovers an operator link to. Operator counts are reported per status\nrather than collapsed into one verdict — a business with settled\noperators and one awaiting review is both.", "properties": { "business_ref": { "description": "This organization's pairwise reference to the business.", "title": "Business Ref", "type": "string" }, "legal_name": { "description": "The business's registered legal name.", "title": "Legal Name", "type": "string" }, "incorporation_state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "State of incorporation." }, "kyb_outcome": { "$ref": "#/components/schemas/v1.BusinessKybOutcome", "description": "What this organization's most recent confirmation concluded." }, "not_verified_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessNotVerifiedReason" }, { "type": "null" } ], "default": null, "description": "VERIFICATION_INCOMPLETE when the check never finished; null when verified or when it ran and failed." }, "verified_people_count": { "description": "Covered operator links in VERIFIED — people who can mint.", "title": "Verified People Count", "type": "integer" }, "under_review_people_count": { "description": "Covered operator links in UNDER_REVIEW — business mints for these people are refused until a reviewer decides.", "title": "Under Review People Count", "type": "integer" }, "rejected_people_count": { "description": "Covered operator links a reviewer rejected.", "title": "Rejected People Count", "type": "integer" }, "last_verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When this organization last covered the business with an evaluation of its own.", "title": "Last Verified At" }, "last_activity_at": { "description": "The latest of: an operator link confirmed or decided, and an agent credential issued or revoked for the business, by this organization. Starts when the business entered the directory.", "format": "date-time", "title": "Last Activity At", "type": "string" }, "linked_people_count": { "description": "Operator links this organization covers, in any status.", "readOnly": true, "title": "Linked People Count", "type": "integer" } }, "required": [ "business_ref", "legal_name", "incorporation_state", "kyb_outcome", "verified_people_count", "under_review_people_count", "rejected_people_count", "last_activity_at", "linked_people_count" ], "title": "BusinessListItemResponse (v1)", "type": "object" }, "v1.IdentityStatusResponse": { "description": "Body for ``GET /issuance/identities/individuals/{individual_ref}``.\n\nStrictly scoped to the calling organization: only links it covered with\nits own sessions are listed, and no PII beyond what the organization\nitself submitted is echoed — ``display_name`` repeats the verified name\nthe list row already returns to the same caller, nothing more.", "properties": { "individual_ref": { "description": "The queried pairwise individual reference.", "title": "Individual Ref", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The verified name, as the latest snapshot recorded it — the same value the list row carries. Null when every snapshot has been superseded. Mask it in shared surfaces; the API returns what the organization itself submitted.", "title": "Display Name" }, "verification_state": { "$ref": "#/components/schemas/v1.IdentityVerificationState", "description": "CURRENT, or EXPIRED (re-verify before minting). SUPERSEDED only when your organization holds no current verification of the individual, which registration never leaves." }, "verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the latest verification was recorded.", "title": "Verified At" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the latest verification expires.", "title": "Expires At" }, "active_keys": { "description": "Names of the individual verification checks the identity currently holds (e.g. `phone_possession`, `ssn_identity_match`), from the token-exchange profile's key vocabulary; verification_level is derived from them. A re-verification keeps an earlier `phone_possession` it cannot re-run.", "items": { "type": "string" }, "title": "Active Keys", "type": "array" }, "available_disclosure_paths": { "description": "The subject-relative credential disclosure paths the current verification can populate, hash leaves included (e.g. `hashes.ssn`). Paths only, never values. A requested path missing here is skipped at mint, not refused. Empty when this organization holds no current verification.", "items": { "type": "string" }, "title": "Available Disclosure Paths", "type": "array" }, "verification_level": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Verification level derived from active_keys; null when the attested attributes are insufficient for any defined level.", "title": "Verification Level" }, "possession_verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the individual last proved control of their phone. A re-check cannot contact the individual, so it keeps the earlier proof and this stays at that proof's date, which can be older than `verified_at`. Null when the latest verification attests no phone possession.", "title": "Possession Verified At" }, "latest_reverification": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionHistoryItemResponse" }, { "type": "null" } ], "default": null, "description": "The most recent re-verification started through `POST /issuance/identities/verifications` with this `individual_ref`, whatever its outcome. Only an approved re-check replaces the current verification; a failed, rejected or under-review one leaves it unchanged." }, "businesses": { "description": "Businesses this organization holds a verified or under-review operator link for, oldest first, each with its pairwise ref and link status. Rejected links are not listed.", "items": { "$ref": "#/components/schemas/v1.IdentityBusinessLinkResponse" }, "title": "Businesses", "type": "array" }, "submissions": { "description": "This organization's approved verifications of the individual, newest first — every approved submission whose evaluation ran against the same national id. A re-check still in flight is `latest_reverification` and in Reviews.", "items": { "$ref": "#/components/schemas/v1.IdentitySubmissionHistoryItemResponse" }, "title": "Submissions", "type": "array" }, "credentials": { "$ref": "#/components/schemas/v1.CredentialSummaryResponse", "description": "This organization's agent credentials for the individual, counting business credentials they acted for." }, "active_credentials": { "description": "The agent credentials counted as `credentials.active`, newest first.", "items": { "$ref": "#/components/schemas/v1.ActiveCredentialResponse" }, "title": "Active Credentials", "type": "array" }, "verification_history": { "description": "Superseded verifications, newest first — when the individual was verified before and when each verification was replaced. Dates only; superseded identity fields are never re-disclosed.", "items": { "$ref": "#/components/schemas/v1.IdentityVerificationHistoryItemResponse" }, "title": "Verification History", "type": "array" } }, "required": [ "individual_ref", "verification_state", "credentials" ], "title": "IdentityStatusResponse (v1)", "type": "object" }, "v1.BusinessIdentityStatusResponse": { "description": "Body for ``GET /issuance/identities/businesses/{business_ref}``.\n\nStrictly scoped to the calling organization, like the person profile:\nthe outcome and checks read the session behind its latest confirmation,\nthe people are the operator links it covered, and the submission history\nis its own approved sessions. No global business id and no EIN are ever\nechoed.", "properties": { "business_ref": { "description": "The queried pairwise business reference.", "title": "Business Ref", "type": "string" }, "legal_name": { "description": "The business's registered legal name.", "title": "Legal Name", "type": "string" }, "kyb_outcome": { "$ref": "#/components/schemas/v1.BusinessKybOutcome", "description": "What this organization's latest confirmation concluded." }, "not_verified_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessNotVerifiedReason" }, { "type": "null" } ], "default": null, "description": "VERIFICATION_INCOMPLETE when the check never finished; null otherwise." }, "checks": { "description": "Each check of the evaluation behind the latest confirmation, in card order; empty when `checks_unavailable_reason` is set.", "items": { "$ref": "#/components/schemas/v1.BusinessKybCheckResponse" }, "title": "Checks", "type": "array" }, "checks_unavailable_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessChecksUnavailableReason" }, { "type": "null" } ], "default": null, "description": "EVIDENCE_UNAVAILABLE when the evaluation behind the latest confirmation can no longer be read (`kyb_outcome` still stands, as the confirmation recorded it); NO_CONFIRMED_VERIFICATION when this organization holds no confirmation of the business." }, "last_verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When this organization's latest confirmation was recorded.", "title": "Last Verified At" }, "incorporation": { "$ref": "#/components/schemas/v1.BusinessIncorporationResponse", "description": "The registry facts of the incorporation." }, "available_disclosure_paths": { "description": "The subject-relative credential disclosure paths the business's records can populate, hash leaves included (e.g. `hashes.ein`). Paths only, never values. A requested path missing here is skipped at mint, not refused. The acting person's `actor.*` paths are on their person profile without the `actor.` prefix.", "items": { "type": "string" }, "title": "Available Disclosure Paths", "type": "array" }, "people": { "description": "People this organization holds covered operator links for, each with their pairwise ref and link status.", "items": { "$ref": "#/components/schemas/v1.BusinessOperatorLinkResponse" }, "title": "People", "type": "array" }, "credentials": { "$ref": "#/components/schemas/v1.CredentialSummaryResponse", "description": "This organization's agent credentials for the business." }, "submissions": { "description": "This organization's approved sessions that covered the business, newest first.", "items": { "$ref": "#/components/schemas/v1.IdentitySubmissionHistoryItemResponse" }, "title": "Submissions", "type": "array" } }, "required": [ "business_ref", "legal_name", "kyb_outcome", "checks", "incorporation", "credentials" ], "title": "BusinessIdentityStatusResponse (v1)", "type": "object" }, "v1.WebsiteAnalysisResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the Website Analysis request" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the Website Analysis request" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the Website Analysis was created.", "examples": [ "2026-10-29T05:44:48.057469" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The most recent date and time when the Website Analysis was updated.", "examples": [ "2026-10-29T05:44:48.057488" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.ray.com/" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "If the website analysis was performed on a business's website, this will be the ID of the business.", "examples": [ "05e6169f-f9c2-416f-8da2-99b881b6cae3" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The details of the website analysis.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis", "emails": [ "njohnson@example.net" ], "id": "ef378489-5cf1-4043-8f6b-3ecb59ca5a1e", "parked": false, "people": [], "phone_numbers": [ "285.302.6793" ], "screenshot_url": "https://api.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis/screenshot", "social_profiles": [], "ssl_validity": { "cert_age_days": 245, "certificate_type": "OV", "days_until_expiry": 120, "expiry_date": "2025-03-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-03-01T00:00:00", "issuer": "DigiCert Inc", "key_size": 2048, "subject": "mitchell.com", "tls_version": "TLSv1.3" }, "url": "http://mitchell.com/", "website_structure_metrics": { "breadth": "15+", "depth": "2+" }, "whois_record": { "domain_created_at": "2020-05-15T10:30:00", "domain_expires_at": "2025-05-15T10:30:00", "domain_updated_at": "2023-06-01T14:45:00", "registrar": "Example Registrar Inc." } } ] } }, "type": "object", "required": [ "id", "state", "created_at", "updated_at", "url" ], "title": "WebsiteAnalysisResponse (v1)" }, "v2.WebPresenceResponse": { "oneOf": [ { "$ref": "#/components/schemas/v1.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v1.InternationalWebPresenceResponse" } ], "title": "WebPresenceResponse", "description": "Web presence response - either US or International based on the request's country code.\n\nThis is a discriminated union that selects the appropriate response type\nbased on the `request_type` field.", "discriminator": { "propertyName": "request_type", "mapping": { "INTERNATIONAL": "#/components/schemas/v1.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v1.USWebPresenceResponse" } } }, "v1.WebPresenceResponse": { "description": "Web presence response - either US or International based on the request's country code.\n\nThis is a discriminated union that selects the appropriate response type\nbased on the `request_type` field.", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v1.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v1.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v1.InternationalWebPresenceResponse" } ], "title": "WebPresenceResponse" }, "v1.EmployeeVerificationRequestResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the employee verification request." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the request was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the request was last updated." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "Current state of the request." }, "person_name": { "type": "string", "title": "Person Name", "description": "Full name of the person being verified." }, "business_name": { "type": "string", "title": "Business Name", "description": "Name of the business being checked." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Business address provided for disambiguation." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names provided for the business." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Whether the person was verified as an employee." }, "role_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Title", "description": "Job title or role, if discovered." }, "department": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Department", "description": "Department, if discovered." }, "evidence_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Summary", "description": "Summary of evidence found." }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/EmployeeVerificationContact" }, { "type": "null" } ], "description": "Contact information discovered for the person." }, "socials": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSocial" }, "type": "array" }, { "type": "null" } ], "title": "Socials", "description": "Social media profiles discovered for the person." }, "miscellaneous_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationMiscLink" }, "type": "array" }, { "type": "null" } ], "title": "Miscellaneous Links", "description": "Other web links found for the person (e.g. GitHub, personal site)." }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources", "description": "Sources consulted during verification." } }, "type": "object", "required": [ "id", "created_at", "state", "person_name", "business_name" ], "title": "EmployeeVerificationRequestResponse (v1)" }, "v1.OrganizationDetailResponse": { "description": "An Organization plus its lien-filing configuration.\n\nServed by the standalone ``GET /organization`` (and its ``PATCH``/``PUT``),\nthe org-management endpoints, the federation organization list, and the\nadmin organization endpoints. The nested-in-user view (``/me``,\n``/users/{id}``) and the federation summary use the lean\n``OrganizationResponse`` instead — only the single-resource org views carry\nthe lien-filing fields. (``webhooks_version`` lives on the lean base: the\nconsole reads it off the nested org.)", "properties": { "id": { "description": "The unique identifier of the Organization.", "examples": [ "51b37909-1f26-4e88-88f2-d3bfc03834eb" ], "format": "uuid", "title": "Organization Identifier", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the Organization.", "examples": [ "The Avengers" ], "title": "Organization Name" }, "domain_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The domain name of the Organization.", "examples": [ "avengers.com" ], "title": "Organization Domain Name" }, "type": { "$ref": "#/components/schemas/v1.OrganizationType", "description": "The type of the organization.", "title": "Organization Type" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An external identifier for referencing the Organization using the ID from a namespace in an external system.", "examples": [ "0c692180-eff6-4d78-81a5-b96938fde161", "org_818sja7i" ], "title": "External Identifier" }, "webhooks_version": { "$ref": "#/components/schemas/v1.WebhooksVersion", "description": "The version of Baselayer Webhooks the Organization utilizies.", "examples": [ "2.0" ] }, "federation": { "anyOf": [ { "$ref": "#/components/schemas/v1.FederationResponse" }, { "type": "null" } ], "description": "The Federation that the Organization belongs to (if any).", "examples": [ { "email": "stan-lee@marvel.com", "id": "6d49b18a-c030-4397-b1ff-7cc1fc3a4c53", "name": "Stan Lee" } ], "title": "Federation" }, "applications": { "description": "The Applications belonging to the Organization.", "examples": [ { "enabled": true, "external_id": null, "id": "45670cb4-c724-422c-bbcf-eb1ac7839c00", "name": "Avengers - Sandbox", "type": "sandbox" }, { "enabled": false, "external_id": null, "id": "07ec800c-2987-4768-a35f-b5b7cd92430b", "name": "Avengers - Production", "type": "production" } ], "items": { "$ref": "#/components/schemas/v1.ApplicationResponse" }, "title": "Applications", "type": "array" }, "lien_filing_decision_policy": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingDecisionPolicy" }, { "type": "null" } ], "default": null, "description": "The organization's Batch Filing rules. Null when the organization has not set them, in which case the engine defaults apply.", "title": "Batch Filing Decision Policy" }, "lien_filing_correspondence_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "default": null, "description": "The email address for lien filing correspondence.", "examples": [ "lien-filing-email@example.com" ], "title": "Lien Filing Correspondence Email" }, "lien_filing_secured_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyPreference" }, { "type": "null" } ], "default": null, "description": "The secured party for lien filing.", "title": "Lien Filing Secured Party" }, "lien_filing_collateral_statement": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The collateral statement for lien filing.", "title": "Lien Filing Collateral Statement" }, "lien_filing_collateral_statement_templates": { "description": "The list of collateral statement templates for lien filing.", "items": { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementTemplate" }, "title": "Lien Filing Collateral Statement Templates", "type": "array" }, "settings": { "$ref": "#/components/schemas/v1.AccountSettingsResponse", "description": "The settings in effect for this Organization.", "title": "Settings" }, "settings_source": { "$ref": "#/components/schemas/v1.AccountSettingsSource", "description": "Where the current active settings are sourced from.", "title": "Settings source" } }, "required": [ "id", "name", "domain_name", "type", "external_id", "webhooks_version", "federation", "applications", "settings", "settings_source" ], "title": "OrganizationDetailResponse (v1)", "type": "object" }, "v1.PredictedNaicsRequestResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the NAICS prediction request.", "examples": [ "7d25333a-2472-46fa-a469-0fc4822759cd" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the NAICS prediction request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The ID of the business for which the NAICS code was predicted.", "examples": [ "f697fb24-0487-495c-8819-1ef48e2469f6" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The ID of the business search from which this NAICS prediction request originated.", "examples": [ "f81496d5-82cc-4227-beee-e523111835b6" ] }, "predicted_naics": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "description": "The predicted NAICS code(s) for the business entity." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the NAICS prediction request." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the NAICS prediction request was created.", "examples": [ "2026-10-29T05:44:47.891567" ] } }, "type": "object", "required": [ "id", "state", "created_at" ], "title": "PredictedNaicsRequestResponse (v1)" }, "v1.AddressResponse": { "description": "Response model for address data.\n\nThis model defines the complete structure for address-related API responses.", "properties": { "id": { "description": "The ID of the address", "format": "uuid", "title": "Id", "type": "string" }, "primary_number": { "description": "The primary number of the address", "examples": [ "94941" ], "title": "Primary Number", "type": "string" }, "street_name": { "description": "The street name", "examples": [ "Harrison Drive" ], "title": "Street Name", "type": "string" }, "street_predirection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The street predirection e.g. N 5th St", "examples": [ "North", "West" ], "title": "Street Predirection" }, "street_postdirection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The street postdirection e.g. 5th St NW", "examples": [ "South", "East" ], "title": "Street Postdirection" }, "street_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The street suffix e.g. St, Ave, Blvd, etc.", "examples": [ "St", "Ave", "Blvd" ], "title": "Street Suffix" }, "secondary_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The secondary number of the address e.g. Apt, Suite, etc.", "examples": [ "517", "2026", "112" ], "title": "Secondary Number" }, "secondary_designator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The secondary designator of the address e.g. Apartment, Suite etc.", "examples": [ "Apartment", "Suite", "Unit" ], "title": "Secondary Designator" }, "pmb_designator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Private Mailbox Designator", "title": "Pmb Designator" }, "pmb_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Private Mailbox Number", "title": "Pmb Number" }, "city": { "description": "The city name", "examples": [ "Wilsonside", "Fayettesville" ], "title": "City", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.StateAbbreviation", "description": "The state 2 letter abbreviation" }, "zipcode": { "description": "The 5 digit zipcode", "examples": [ "90210", "31337" ], "title": "Zipcode", "type": "string" }, "plus4_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The 4 digit zipcode extension", "title": "Plus4 Code" }, "rdi": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressRDI" }, { "type": "null" } ], "default": null, "description": "Residential Delivery Indicator" }, "cmra": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the address is a Commercial Mail Receiving Agency", "title": "Cmra" }, "deliverable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the address is deliverable", "title": "Deliverable" }, "latitude": { "description": "The latitude of the address", "examples": [ 38.03012 ], "title": "Latitude", "type": "number" }, "longitude": { "description": "The longitude of the address", "examples": [ 78.47665 ], "title": "Longitude", "type": "number" }, "associated_registered_agents": { "default": [], "description": "All registered agents that have ever been associated with this address", "items": { "type": "string" }, "title": "Associated Registered Agents", "type": "array" }, "delivery_type": { "anyOf": [ { "$ref": "#/components/schemas/v1.USPSDeliveryType" }, { "type": "null" } ], "default": null, "description": "The delivery type of the address" } }, "required": [ "id", "primary_number", "street_name", "city", "state", "zipcode", "latitude", "longitude" ], "title": "AddressResponse (v1)", "type": "object" }, "v1.DocketSearchResponse": { "description": "Represents a docket search response.", "properties": { "id": { "description": "ID of the docket search request", "format": "uuid", "title": "Id", "type": "string" }, "search_entities": { "description": "A list of entities searched in the docket search.", "items": { "$ref": "#/components/schemas/v1.AdditionalDocketSearchEntityResponse" }, "title": "Search Entities", "type": "array" }, "business_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the business the search was performed for", "title": "Business Id" }, "person_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the person the search was performed for", "title": "Person Id" }, "business_search_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "ID of the business search the docket search was performed for", "title": "Business Search Id" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "State of the search request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the docket search request.", "title": "Error" }, "last_updated_at": { "description": "Date the search was last updated", "format": "date", "title": "Last Updated At", "type": "string" }, "dockets": { "description": "A list of dockets associated with the search request.", "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "title": "Dockets", "type": "array" } }, "required": [ "id", "search_entities", "state", "last_updated_at", "dockets" ], "title": "DocketSearchResponse (v1)", "type": "object" }, "v1.AdhocDocketSearchResponse": { "description": "Represents an adhoc docket search response.", "properties": { "id": { "description": "ID of the docket search request", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name used for the ad-hoc docket search.", "title": "Name", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "State of the search request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the docket search request.", "title": "Error" }, "last_updated_at": { "description": "Date the search was last updated", "format": "date", "title": "Last Updated At", "type": "string" }, "dockets": { "description": "A list of dockets associated with the search request.", "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "title": "Dockets", "type": "array" } }, "required": [ "id", "name", "state", "last_updated_at", "dockets" ], "title": "AdhocDocketSearchResponse (v1)", "type": "object" }, "v1.ReasonCodeResponse": { "properties": { "code": { "$ref": "#/components/schemas/v1.ReasonCode", "description": "The reason code. This is a stable identifier that can be used to uniquely identify a condition.", "examples": [ "SEARCH_ADDRESS_CMRA" ] }, "category": { "$ref": "#/components/schemas/v1.ReasonCodeCategory", "description": "The domain the code belongs to.", "examples": [ "address" ] }, "recommended_severity": { "$ref": "#/components/schemas/v1.ReasonCodeSeverity", "description": "Baselayer's recommended response tier", "examples": [ "high" ] }, "description": { "description": "What the condition means, in a sentence or two.", "examples": [ "Submitted address is a known commercial mail receiving agency, a private mailbox service that can mask where a business actually operates." ], "title": "Description", "type": "string" }, "deprecated": { "description": "Whether the code is deprecated: no longer issued, though it still appears on results that recorded it.", "examples": [ false ], "title": "Deprecated", "type": "boolean" }, "deprecated_at": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "description": "The UTC day the code is or will be deprecated, or null if none is scheduled.", "title": "Deprecated At" }, "successor_code": { "anyOf": [ { "$ref": "#/components/schemas/v1.ReasonCode" }, { "type": "null" } ], "description": "The code that replaces this one, if it is deprecated and has a replacement." } }, "required": [ "code", "category", "recommended_severity", "description", "deprecated", "deprecated_at", "successor_code" ], "title": "ReasonCodeResponse (v1)", "type": "object" }, "v1.DMFSearchResponse": { "properties": { "id": { "description": "The ID of the DMF search request", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the person of interest", "examples": [ "Michael Smith" ], "maxLength": 250, "title": "Name", "type": "string" }, "ssn": { "description": "The obfuscated social security number of the person of interest", "examples": [ "621-34-2918" ], "title": "Ssn", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the DMF search request.", "examples": [ "TimeoutError The IRS could not be reached." ], "title": "Error" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "default": null } }, "required": [ "id", "name", "ssn", "state" ], "title": "DMFSearchResponse (v1)", "type": "object" }, "v1.DMFSearchStatusResponse": { "description": "Lightweight status view of a DMF search (used by ``GET /dmf/searches/{id}/status``).", "properties": { "id": { "description": "The ID of the DMF search request", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name of the person of interest", "examples": [ "Michael Smith" ], "maxLength": 250, "title": "Name", "type": "string" }, "ssn": { "description": "The obfuscated social security number of the person of interest", "examples": [ "621-34-2918" ], "title": "Ssn", "type": "string" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] } }, "required": [ "id", "name", "ssn", "state" ], "title": "DMFSearchStatusResponse (v1)", "type": "object" }, "v1.DMFResponse": { "properties": { "id": { "description": "The ID of the DMF search request", "format": "uuid", "title": "Id", "type": "string" }, "code": { "$ref": "#/components/schemas/v1.DMFCode", "description": "The code of the DMF search response", "examples": [ "DMF" ] }, "count": { "description": "The number of results returned by the DMF search", "examples": [ 0, 1, 10 ], "title": "Count", "type": "integer" }, "details": { "default": [], "description": "The details of the DMF search response", "items": { "$ref": "#/components/schemas/v1.DMFResponseDetails" }, "title": "Details", "type": "array" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the DMF search request.", "examples": [ "TimeoutError The IRS could not be reached." ], "title": "Error" } }, "required": [ "id", "code", "count", "state" ], "title": "DMFResponse (v1)", "type": "object" }, "v1.SCRASearchRequest": { "additionalProperties": false, "properties": { "parse_permutate_options": { "anyOf": [ { "$ref": "#/components/schemas/v1.ParsePermutateOptions" }, { "type": "null" } ], "default": null, "description": "Name parsing and permutation settings" }, "certificate": { "default": false, "description": "Indicates if DMDC certificate should be included in response. Defaults to False", "title": "Certificate", "type": "boolean" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ], "title": "Reference Id" }, "first_name": { "description": "The first name of the person of interest", "maxLength": 20, "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the person of interest", "pattern": "^[A-Za-z \\-\\'\\s]*$", "title": "Last Name", "type": "string" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person of interest", "title": "Middle Name" }, "birth_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "The birth date of the person of interest. No dates before 1900-01-01 or in the future", "title": "Birth Date" }, "ssn": { "description": "The social security number of the person of interest", "format": "password", "title": "Ssn", "type": "string", "writeOnly": true }, "date_of_interest": { "default": "2026-10-29", "description": "The date queried to determine the status of the individual; to check whether the individual was actively serving, received a notice to serve, or was serving 367 days prior to the given date, or not. Date must be on or after 1985-09-30 and cannot be a future date. Default to today.", "format": "date", "title": "Date Of Interest", "type": "string" } }, "required": [ "first_name", "last_name", "ssn" ], "title": "SCRASearchRequest (v1)", "type": "object" }, "v1.SCRAResponse": { "properties": { "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The reference ID associated with the search.", "examples": [ "Search1234" ], "title": "Reference Id" }, "covered": { "description": "This indicates if any of the searches performed contained SCRA coverage", "title": "Covered", "type": "boolean" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.SCRAResponseResult" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of SCRA search results", "title": "Results" }, "created_at": { "description": "The datetime when the SCRA request was made", "format": "date-time", "readOnly": true, "title": "Created At", "type": "string" } }, "required": [ "covered", "created_at" ], "title": "SCRAResponse", "type": "object" }, "v1.MLASearchRequest": { "additionalProperties": false, "properties": { "parse_permutate_options": { "anyOf": [ { "$ref": "#/components/schemas/v1.ParsePermutateOptions" }, { "type": "null" } ], "default": null, "description": "Name parsing and permutation settings" }, "certificate": { "default": false, "description": "Indicates if DMDC certificate should be included in response. Defaults to False", "title": "Certificate", "type": "boolean" }, "reference_id": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "default": null, "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ], "title": "Reference Id" }, "first_name": { "description": "The first name of the person of interest", "maxLength": 20, "title": "First Name", "type": "string" }, "last_name": { "description": "The last name of the person of interest", "pattern": "^[A-Za-z \\-\\'\\s]*$", "title": "Last Name", "type": "string" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The middle name of the person of interest", "title": "Middle Name" }, "birth_date": { "description": "The birth date of the person of interest. No dates before 1900-01-01 or in the future", "format": "date", "title": "Birth Date", "type": "string" }, "ssn": { "description": "The social security number of the person of interest", "format": "password", "title": "Ssn", "type": "string", "writeOnly": true }, "itin": { "anyOf": [ { "pattern": "^\\d{3}-\\d{2}-\\d{4}$|^\\d{9}$", "type": "string" }, { "type": "null" } ], "default": null, "description": "The Individual taxpayer identification number of the person of interest", "title": "Itin" } }, "required": [ "first_name", "last_name", "birth_date", "ssn" ], "title": "MLASearchRequest (v1)", "type": "object" }, "v1.MLAResponse": { "properties": { "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The reference ID associated with the search.", "examples": [ "Search1234" ], "title": "Reference Id" }, "covered": { "description": "Do any of the searches performed contained MLA coverage", "title": "Covered", "type": "boolean" }, "results": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.MLAResponseResult" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of MLA search results", "title": "Results" }, "created_at": { "description": "The datetime when the MLA request was made", "format": "date-time", "readOnly": true, "title": "Created At", "type": "string" } }, "required": [ "covered", "created_at" ], "title": "MLAResponse", "type": "object" }, "v1.PortfolioItemResponse": { "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessPortfolioItemResponse" }, { "$ref": "#/components/schemas/v1.PersonPortfolioItemResponse" } ], "title": "PortfolioItemResponse", "description": "Portfolio item response - either Business or Person based on the item type.\n\nThis is a discriminated union that selects the appropriate response type\nbased on the `type` field.", "discriminator": { "propertyName": "type", "mapping": { "Business": "#/components/schemas/v1.BusinessPortfolioItemResponse", "Person": "#/components/schemas/v1.PersonPortfolioItemResponse" } } }, "v1.UpdatePortfolioItemRequest": { "additionalProperties": false, "properties": { "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The optional UUID of the group to move the item to. If None, removes the item from its current group.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "title": "Group Id" } }, "title": "UpdatePortfolioItemRequest (v1)", "type": "object" }, "v1.PortfolioGroupSummaryResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the portfolio group." }, "name": { "type": "string", "title": "Name", "description": "The name of the portfolio group." }, "items_count": { "type": "integer", "title": "Items Count", "description": "The number of items in this portfolio group." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the portfolio group was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the portfolio group was last updated." }, "console_url": { "type": "string", "title": "Console Url", "readOnly": true } }, "type": "object", "required": [ "id", "name", "items_count", "created_at", "updated_at", "console_url" ], "title": "PortfolioGroupSummaryResponse (v1)", "description": "Represents a summary of a portfolio group." }, "v1.PortfolioItemSnapshotResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the snapshot." }, "portfolio_item_id": { "type": "string", "format": "uuid", "title": "Portfolio Item Id", "description": "The unique identifier of the portfolio item this snapshot belongs to." }, "attributes": { "items": { "$ref": "#/components/schemas/MonitorableAttributes" }, "type": "array", "title": "Attributes", "description": "The attributes that were monitored when the snapshot was created.", "default": [] }, "schema_version": { "type": "integer", "title": "Schema Version", "description": "The schema version of the snapshot data." }, "data": { "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessPortfolioItemSnapshotData" }, { "$ref": "#/components/schemas/v1.PersonPortfolioItemSnapshotData" } ], "title": "Data", "description": "The snapshot data containing business information, liens, dockets, and website analysis.", "discriminator": { "propertyName": "type", "mapping": { "Business": "#/components/schemas/v1.BusinessPortfolioItemSnapshotData", "Person": "#/components/schemas/v1.PersonPortfolioItemSnapshotData" } } }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the snapshot was created." } }, "additionalProperties": true, "type": "object", "required": [ "id", "portfolio_item_id", "schema_version", "data", "created_at" ], "title": "PortfolioItemSnapshotResponse (v1)", "description": "Represents a portfolio item snapshot response." }, "v1.DiffChangeResponse": { "properties": { "path": { "type": "string", "title": "Path", "description": "The path of the change" }, "operation": { "$ref": "#/components/schemas/JSONPatchOperationType", "description": "The operation that was performed" }, "old_value": { "title": "Old Value", "description": "The old value of the change" }, "new_value": { "title": "New Value", "description": "The new value of the change" }, "changed_at": { "type": "string", "format": "date-time", "title": "Changed At", "description": "The date and time the change was made" } }, "type": "object", "required": [ "path", "operation", "old_value", "new_value", "changed_at" ], "title": "DiffChangeResponse (v1)", "description": "Represents a change in a diff." }, "v1.MonitoringPolicyResponse": { "description": "Represents a monitoring policy response.\n\nThis representation is designed for use in the singleton resource API representations.\nNote that `id`, `group_id`, and `item_id` are not included in this representation.\nThis is to avoid confusion when API resource inheritance is in effect.", "properties": { "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The monitoring cadence (e.g., 'daily', 'weekly', 'monthly')." }, "attributes": { "default": [], "description": "The attributes to monitor.", "items": { "$ref": "#/components/schemas/v1.MonitorableAttributes" }, "title": "Attributes", "type": "array" }, "lien_monitoring_scope": { "$ref": "#/components/schemas/v1.LienMonitoringScope", "description": "The scope of lien monitoring." }, "enabled": { "description": "Whether the monitoring policy is enabled.", "title": "Enabled", "type": "boolean" }, "last_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy was last executed.", "title": "Last Run At" }, "next_run_on": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy is scheduled to run next.", "title": "Next Run On" }, "inherited_from": { "anyOf": [ { "$ref": "#/components/schemas/v1.InheritedFrom" }, { "type": "null" } ], "default": null, "description": "Indicates where this policy was inherited from (e.g., 'portfolio', 'group', or None for direct)." } }, "required": [ "cadence", "lien_monitoring_scope", "enabled" ], "title": "MonitoringPolicyResponse (v1)", "type": "object" }, "v1.CreateMonitoringPolicyRequest": { "additionalProperties": false, "description": "Request model for creating or updating a monitoring policy.", "properties": { "enabled": { "default": true, "description": "Whether the monitoring policy should be enabled.", "title": "Enabled", "type": "boolean" }, "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The monitoring cadence (daily, weekly, monthly, yearly).", "examples": [ "daily", "weekly", "monthly", "yearly" ] }, "attributes": { "default": [], "description": "List of attributes to monitor (liens, litigations, bankruptcies, etc.).", "examples": [ [ "liens", "litigations" ], [ "website_analysis", "ofac" ] ], "items": { "$ref": "#/components/schemas/v1.MonitorableAttributes" }, "title": "Attributes", "type": "array" }, "lien_monitoring_scope": { "$ref": "#/components/schemas/v1.LienMonitoringScope", "default": "domestic", "description": "The scope of lien monitoring (domestic or registered).", "examples": [ "domestic", "registered" ] } }, "required": [ "cadence" ], "title": "CreateMonitoringPolicyRequest (v1)", "type": "object" }, "v1.NotificationPolicyResponse": { "description": "Represents a notification policy response.", "properties": { "id": { "description": "The unique identifier of the notification policy.", "format": "uuid", "title": "Id", "type": "string" }, "type": { "description": "The type of notification policy. Only `email` is supported.", "examples": [ "email" ], "title": "Type", "type": "string" }, "name": { "description": "The name of the notification policy.", "title": "Name", "type": "string" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The unique identifier of the portfolio group (if applicable).", "title": "Group Id" }, "item_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The unique identifier of the portfolio item (if applicable).", "title": "Item Id" }, "enabled": { "description": "Whether the notification policy is enabled.", "title": "Enabled", "type": "boolean" }, "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The notification cadence (daily, weekly, monthly, yearly).", "examples": [ "daily", "weekly", "monthly", "yearly" ] }, "last_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy was last executed.", "title": "Last Run At" }, "next_run_on": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy is scheduled to run next.", "title": "Next Run On" }, "attributes": { "default": [], "description": "List of attributes to notify on (officers, alternative_names).", "examples": [ [ "officers" ], [ "alternative_names" ] ], "items": { "$ref": "#/components/schemas/v1.NotifiableAttributes" }, "title": "Attributes", "type": "array" }, "recipients": { "default": [], "description": "List of email recipients for email notification policies.", "examples": [ [ "user@example.com", "admin@example.com" ] ], "items": { "type": "string" }, "title": "Recipients", "type": "array" }, "created_at": { "description": "When the notification policy was created.", "format": "date-time", "title": "Created At", "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy was last updated.", "title": "Updated At" } }, "required": [ "id", "type", "name", "enabled", "cadence", "created_at" ], "title": "NotificationPolicyResponse (v1)", "type": "object" }, "v1.CreateNotificationPolicyRequest": { "additionalProperties": false, "description": "Request model for creating a notification policy.", "properties": { "type": { "$ref": "#/components/schemas/v1.NotificationPolicyType", "description": "The type of notification policy. Only `email` is supported.", "examples": [ "email" ] }, "name": { "description": "The name of the notification policy.", "title": "Name", "type": "string" }, "enabled": { "default": true, "description": "Whether the notification policy should be enabled.", "title": "Enabled", "type": "boolean" }, "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The notification cadence (daily, weekly, monthly, yearly).", "examples": [ "daily", "weekly", "monthly", "yearly" ] }, "attributes": { "default": [], "description": "List of attributes to notify on (officers, alternative_names).", "examples": [ [ "officers" ], [ "alternative_names" ] ], "items": { "$ref": "#/components/schemas/v1.NotifiableAttributes" }, "title": "Attributes", "type": "array" }, "recipients": { "default": [], "description": "List of email recipients for email notification policies.", "examples": [ [ "user@example.com", "admin@example.com" ] ], "items": { "type": "string" }, "title": "Recipients", "type": "array" } }, "required": [ "type", "name", "cadence" ], "title": "CreateNotificationPolicyRequest (v1)", "type": "object" }, "v1.UpdateNotificationPolicyRequest": { "additionalProperties": false, "description": "Request model for updating a notification policy.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The name of the notification policy.", "title": "Name" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the notification policy should be enabled.", "title": "Enabled" }, "cadence": { "anyOf": [ { "$ref": "#/components/schemas/v1.MonitoringCadence" }, { "type": "null" } ], "default": null, "description": "The notification cadence (daily, weekly, monthly, yearly).", "examples": [ "daily", "weekly", "monthly", "yearly" ] }, "attributes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.NotifiableAttributes" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of attributes to notify on (officers, alternative_names).", "examples": [ [ "officers" ], [ "alternative_names" ] ], "title": "Attributes" }, "recipients": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of email recipients for email notification policies.", "examples": [ [ "user@example.com", "admin@example.com" ] ], "title": "Recipients" } }, "title": "UpdateNotificationPolicyRequest (v1)", "type": "object" }, "v1.MonitoringPolicyListResponse": { "description": "Represents a monitoring policy list response.", "properties": { "id": { "description": "The unique identifier of the portfolio item update.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "scope": { "$ref": "#/components/schemas/v1.PolicyScope", "description": "The scope of the monitoring policy." }, "item_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "The unique identifier of the portfolio item, if any.", "title": "Item Id" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "The unique identifier of the portfolio group, if any.", "title": "Group Id" }, "enabled": { "description": "Whether the monitoring policy is enabled.", "title": "Enabled", "type": "boolean" }, "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The monitoring cadence." }, "last_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the monitoring policy was last executed.", "title": "Last Run At" }, "next_run_on": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the monitoring policy will be executed next.", "title": "Next Run On" }, "attributes": { "default": [], "description": "The attributes to monitor.", "items": { "$ref": "#/components/schemas/v1.MonitorableAttributes" }, "title": "Attributes", "type": "array" }, "url": { "readOnly": true, "title": "Url", "type": "string" }, "group_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Group Url" }, "item_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Item Url" } }, "required": [ "id", "scope", "item_id", "group_id", "enabled", "cadence", "url", "group_url", "item_url" ], "title": "MonitoringPolicyListResponse (v1)", "type": "object" }, "v1.NotificationPolicyListResponse": { "description": "Represents a notification policy list response.", "properties": { "id": { "description": "The unique identifier of the notification policy.", "examples": [ "ede786f3-33ae-4894-843d-af2025f1d5b0" ], "format": "uuid", "title": "Id", "type": "string" }, "scope": { "$ref": "#/components/schemas/v1.PolicyScope", "description": "The scope of the notification policy. Coverage is additive: a portfolio policy covers every item in the portfolio, a group policy its group's items and an item policy its item, so an item may appear in several digests." }, "name": { "description": "The name of the notification policy.", "title": "Name", "type": "string" }, "item_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "The unique identifier of the portfolio item, if any.", "title": "Item Id" }, "group_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "The unique identifier of the portfolio group, if any.", "title": "Group Id" }, "enabled": { "description": "Whether the notification policy is enabled.", "title": "Enabled", "type": "boolean" }, "cadence": { "$ref": "#/components/schemas/v1.MonitoringCadence", "description": "The notification cadence." }, "last_run_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy was last executed.", "title": "Last Run At" }, "next_run_on": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "When the notification policy will be executed next.", "title": "Next Run On" }, "attributes": { "default": [], "description": "The attributes to notify on.", "items": { "$ref": "#/components/schemas/v1.NotifiableAttributes" }, "title": "Attributes", "type": "array" }, "url": { "readOnly": true, "title": "Url", "type": "string" }, "group_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Group Url" }, "item_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "readOnly": true, "title": "Item Url" } }, "required": [ "id", "scope", "name", "item_id", "group_id", "enabled", "cadence", "url", "group_url", "item_url" ], "title": "NotificationPolicyListResponse (v1)", "type": "object" }, "v1.PortfolioItemUpdateResponse": { "description": "Represents a portfolio item update.", "properties": { "item": { "$ref": "#/components/schemas/v1.PortfolioItemSummaryResponse", "description": "The portfolio item that was updated." }, "from_snapshot_id": { "description": "The unique identifier of the from snapshot.", "format": "uuid", "title": "From Snapshot Id", "type": "string" }, "to_snapshot_id": { "description": "The unique identifier of the to snapshot.", "format": "uuid", "title": "To Snapshot Id", "type": "string" }, "change_count": { "description": "The number of changes in the portfolio item update.", "title": "Change Count", "type": "integer" }, "notification_count": { "description": "The number of notifications in the portfolio item update.", "title": "Notification Count", "type": "integer" }, "notification_summaries": { "description": "The notification summaries in the portfolio item update.", "items": { "$ref": "#/components/schemas/v1.PortfolioItemNotificationSummary" }, "title": "Notification Summaries", "type": "array" }, "created_at": { "description": "When the portfolio item update was created.", "format": "date-time", "title": "Created At", "type": "string" }, "notifications": { "description": "The notifications this update generated.", "items": { "$ref": "#/components/schemas/v1.PortfolioMonitoringNotificationResponse" }, "title": "Notifications", "type": "array" }, "item_url": { "readOnly": true, "title": "Item Url", "type": "string" }, "from_snapshot_url": { "readOnly": true, "title": "From Snapshot Url", "type": "string" }, "to_snapshot_url": { "readOnly": true, "title": "To Snapshot Url", "type": "string" }, "diff_url": { "readOnly": true, "title": "Diff Url", "type": "string" }, "notifications_url": { "readOnly": true, "title": "Notifications Url", "type": "string" } }, "required": [ "item", "from_snapshot_id", "to_snapshot_id", "change_count", "notification_count", "notification_summaries", "created_at", "notifications", "item_url", "from_snapshot_url", "to_snapshot_url", "diff_url", "notifications_url" ], "title": "PortfolioItemUpdateResponse (v1)", "type": "object" }, "v1.LiensSearchResponse": { "description": "Represents the response from a liens search request. This includes the unique identifier of the request, the current state of the request, and a list of lien filings associated with the request.", "properties": { "id": { "description": "The identifier of this liens search response.", "format": "uuid", "title": "Id", "type": "string" }, "search_entities": { "description": "A list of entities searched in the liens search.", "items": { "$ref": "#/components/schemas/v1.AdditionalLiensSearchEntityResponse" }, "title": "Search Entities", "type": "array" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ], "title": "Error" }, "filings": { "description": "A list of lien filings associated with the search request.", "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "title": "Filings", "type": "array" }, "last_updated_at": { "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ], "format": "date", "title": "Last Updated At", "type": "string" }, "searched_states": { "anyOf": [ { "description": "Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.", "examples": [ [ "FL", "CA" ] ], "items": { "$ref": "#/components/schemas/v1.StateAbbreviation" }, "title": "States Specified for Liens Search", "type": "array" }, { "description": "Indicates that the liens search was limited to the domestic state of the business. A domestic state is defined as the state where the business filed its articles of incorporation and is considered its legal home state for tax purposes. This contrasts with any other states where the business might operate as a foreign entity. The search was thus focused on liens within this domestic jurisdiction, in line with the business's legal recognition and operational base.", "title": "Liens Search Limited to Domestic State", "type": "null" } ], "default": null, "title": "Searched States" }, "business_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The identifier of the business associated with these lien filings.", "examples": [ "2d96141a-66be-4dcc-91cb-208a0a7978f8" ], "title": "Business Id" }, "person_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The identifier of the person associated with these lien filings.", "examples": [ "ae3a53f8-517f-4c05-ad5f-05a938364917" ], "title": "Person Id" }, "business_search_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The identifier of the business search associated with these lien filings.", "examples": [ "13bffc01-7eba-40b7-960e-32132fd3ea15" ], "title": "Business Search Id" } }, "required": [ "id", "search_entities", "state", "filings", "last_updated_at" ], "title": "LiensSearchResponse (v1)", "type": "object" }, "v1.AdhocLiensSearchResponse": { "description": "Represents the response from an adhoc liens search request. This includes the unique identifier of the request, the current state of the request, and a list of lien filings associated with the request.", "properties": { "id": { "description": "The identifier of this liens search response.", "format": "uuid", "title": "Id", "type": "string" }, "name": { "description": "The name used for the ad-hoc liens search.", "title": "Name", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The Idempotency-Key header the request that created this resource carried, if any.", "title": "Idempotency Key" }, "state": { "$ref": "#/components/schemas/v1.TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ], "title": "Error" }, "filings": { "description": "A list of lien filings associated with the search request.", "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "title": "Filings", "type": "array" }, "last_updated_at": { "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ], "format": "date", "title": "Last Updated At", "type": "string" }, "searched_states": { "description": "Indicates the list of states specified in the liens search request.", "examples": [ [ "FL", "CA" ] ], "items": { "$ref": "#/components/schemas/v1.StateAbbreviation" }, "title": "States Specified for Liens Search", "type": "array" } }, "required": [ "id", "name", "state", "filings", "last_updated_at", "searched_states" ], "title": "AdhocLiensSearchResponse (v1)", "type": "object" }, "v1.BusinessSearchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessSummaryResponse" }, { "type": "null" } ], "description": "A summary of the found business - contains the business UUID." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchResponse (v1)", "description": "Represents a business search response." }, "v1.AutocompleteSessionGrantResponse": { "description": "A grant from ``POST /autocomplete/sessions``, and its organization's limits.", "properties": { "session_token": { "description": "Opaque, signed session grant. Send it verbatim in the ``X-Autocomplete-Session`` header of every autocomplete request; it carries its own expiry and budget.", "examples": [ "eyJhbGciOiJFZERTQSIsInR5cCI6ImFjczEiLCJraWQiOiJ…" ], "title": "Session Token", "type": "string" }, "expires_in": { "description": "Seconds until the grant expires, counted from this response. Time the refresh from this, not from ``expires_at``: it is right however far the caller's clock is off. Mint the next grant at about 80% of it so expiry never lands on the typing path.", "examples": [ 120 ], "title": "Expires In", "type": "integer" }, "expires_at": { "description": "When the grant stops working, in UTC: the token's own expiry, for display and logs. Time refreshes from ``expires_in``.", "examples": [ "2026-09-23T12:03:00Z" ], "format": "date-time", "title": "Expires At", "type": "string" }, "request_budget": { "description": "Requests this session may make per autocomplete route. Past it the autocomplete service answers 429 with ``session_budget_spent``; the remedy is a new session, not a retry.", "examples": [ 10 ], "title": "Request Budget", "type": "integer" }, "pivot_allowance": { "description": "How many times this session may change its query to a different name before the autocomplete service refuses it (429, code 482). Growing, trimming or correcting the name being typed never counts.", "examples": [ 5 ], "title": "Pivot Allowance", "type": "integer" }, "filter_min_stem": { "description": "Characters the query needs before the ``person.*``, ``address.*`` and ``state`` filters narrow the suggestions; shorter, a filtered request is a 422 naming ``q``.", "examples": [ 5 ], "title": "Filter Min Stem", "type": "integer" }, "min_query_chars": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "Characters a query needs before the autocomplete service searches at all; shorter, a request is a 422 naming ``q``. Advisory: the service holds it on its own.", "examples": [ 2 ], "title": "Min Query Chars" }, "filter_rules": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/v1.AutocompleteFilterRule" }, "propertyNames": { "$ref": "#/components/schemas/v1.AutocompleteRoute" }, "type": "object" }, { "type": "null" } ], "default": null, "description": "What each route in ``scope`` holds its narrowing filters to, so a client can wait before sending a filter the service would refuse. Each route's ``min_stem`` is what this session enforces on it, and ``filter_min_stem`` is the strictest of them. The service decides; a client that ignores this learns the same from the 422.", "title": "Filter Rules" }, "scope": { "$ref": "#/components/schemas/v1.AutocompleteSessionScope", "description": "What this session may search: the routes, the relations per route, and the most suggestions a request may ask for. Offer a search only where its route is listed." }, "sessions_per_window": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sessions this organization may mint per ten-minute window, one number shared by every user and API key in it; the mint past it is answered 429 with a ``Retry-After``. ``null`` when there is no limit.", "title": "Sessions Per Window" }, "sessions_per_day": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sessions this organization may mint in a rolling 24 hours, shared and refused the same way. ``null`` when there is no limit.", "title": "Sessions Per Day" }, "user_sessions_per_window": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sessions a user signed in to the console may mint per ten-minute window, their own pool beside the organization's; past it the mint answers 429 with a ``Retry-After``. ``null`` for an API key, whose sessions are billed, or when there is no limit.", "title": "User Sessions Per Window" }, "user_sessions_per_day": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sessions a user signed in to the console may mint in a rolling 24 hours, refused the same way. ``null`` for an API key, or when there is no limit.", "title": "User Sessions Per Day" } }, "required": [ "session_token", "expires_in", "expires_at", "request_budget", "pivot_allowance", "filter_min_stem", "scope", "sessions_per_window", "sessions_per_day", "user_sessions_per_window", "user_sessions_per_day" ], "title": "AutocompleteSessionGrantResponse (v1)", "type": "object" }, "v1.GetBusinessSearchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "GetBusinessSearchResponse (v1)" }, "v1.PersonSearchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.425737" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.425756" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with the search.", "examples": [ "Search1234" ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person to search for." }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Whether the SSN for this person search matches with the name provided", "examples": [ true, false ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] } }, "type": "object", "required": [ "id", "state", "created_at", "person" ], "title": "PersonSearchResponse (v1)", "description": "Represents a person search response." }, "v1.WebPresenceRequestSubmittedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v1.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v1.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v1.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "WebPresenceRequest.submitted", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestSubmittedWebhook", "type": "object" }, "v2.WebPresenceRequestSubmittedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v2.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v2.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v2.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v2.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v2.WebhookMetadata", "default": { "type": "WebPresenceRequest.submitted", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestSubmittedWebhook", "type": "object" }, "v1.WebPresenceRequestCompletedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v1.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v1.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v1.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "WebPresenceRequest.completed", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestCompletedWebhook", "type": "object" }, "v2.WebPresenceRequestCompletedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v2.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v2.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v2.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v2.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v2.WebhookMetadata", "default": { "type": "WebPresenceRequest.completed", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestCompletedWebhook", "type": "object" }, "v1.WebPresenceRequestFailedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v1.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v1.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v1.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v1.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v1.WebhookMetadata", "default": { "type": "WebPresenceRequest.failed", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestFailedWebhook", "type": "object" }, "v2.WebPresenceRequestFailedWebhook": { "properties": { "root": { "description": "The webhook payload data", "discriminator": { "mapping": { "INTERNATIONAL": "#/components/schemas/v2.InternationalWebPresenceResponse", "UNITED_STATES": "#/components/schemas/v2.USWebPresenceResponse" }, "propertyName": "request_type" }, "oneOf": [ { "$ref": "#/components/schemas/v2.USWebPresenceResponse" }, { "$ref": "#/components/schemas/v2.InternationalWebPresenceResponse" } ], "title": "Root" }, "__event__": { "$ref": "#/components/schemas/v2.WebhookMetadata", "default": { "type": "WebPresenceRequest.failed", "origin": "api", "notices": null, "organization_id": null, "application_id": null, "external_id": null, "application_type": null } } }, "required": [ "root" ], "title": "WebPresenceRequestFailedWebhook", "type": "object" }, "v1.AdverseMediaSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "AdverseMediaSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the adverse media search", "examples": [ "e8ebbadb-7aed-4ce0-8303-e5c250875003" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the adverse media search was created", "examples": [ "2026-10-29T05:44:47.850805" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the adverse media search was last updated", "examples": [ "2026-10-29T05:44:47.850824" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "ID of the business to search for adverse media", "examples": [ "9498d428-cb66-45fa-9d1b-7220d816acf1" ] }, "sentiment": { "anyOf": [ { "$ref": "#/components/schemas/NewsSentiment" }, { "type": "null" } ], "description": "Sentiment of the adverse media search", "examples": [ "positive", "negative", "neutral" ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary", "description": "Summary of the adverse media search" }, "articles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.AdverseMediaArticle" }, "type": "array" }, { "type": "null" } ], "title": "Articles", "description": "Articles found in the adverse media search" } }, "type": "object", "required": [ "id", "created_at", "state", "business_id" ], "title": "AdverseMediaSearchCompletedWebhook (v1)" }, "v1.AdverseMediaSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "AdverseMediaSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the adverse media search", "examples": [ "e8ebbadb-7aed-4ce0-8303-e5c250875003" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the adverse media search was created", "examples": [ "2026-10-29T05:44:47.850805" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the adverse media search was last updated", "examples": [ "2026-10-29T05:44:47.850824" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "ID of the business to search for adverse media", "examples": [ "9498d428-cb66-45fa-9d1b-7220d816acf1" ] }, "sentiment": { "anyOf": [ { "$ref": "#/components/schemas/NewsSentiment" }, { "type": "null" } ], "description": "Sentiment of the adverse media search", "examples": [ "positive", "negative", "neutral" ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary", "description": "Summary of the adverse media search" }, "articles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.AdverseMediaArticle" }, "type": "array" }, { "type": "null" } ], "title": "Articles", "description": "Articles found in the adverse media search" } }, "type": "object", "required": [ "id", "created_at", "state", "business_id" ], "title": "AdverseMediaSearchFailedWebhook (v1)" }, "v1.AdverseMediaSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "AdverseMediaSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the adverse media search", "examples": [ "e8ebbadb-7aed-4ce0-8303-e5c250875003" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the adverse media search was created", "examples": [ "2026-10-29T05:44:47.850805" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the adverse media search was last updated", "examples": [ "2026-10-29T05:44:47.850824" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "ID of the business to search for adverse media", "examples": [ "9498d428-cb66-45fa-9d1b-7220d816acf1" ] }, "sentiment": { "anyOf": [ { "$ref": "#/components/schemas/NewsSentiment" }, { "type": "null" } ], "description": "Sentiment of the adverse media search", "examples": [ "positive", "negative", "neutral" ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary", "description": "Summary of the adverse media search" }, "articles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.AdverseMediaArticle" }, "type": "array" }, { "type": "null" } ], "title": "Articles", "description": "Articles found in the adverse media search" } }, "type": "object", "required": [ "id", "created_at", "state", "business_id" ], "title": "AdverseMediaSearchSubmittedWebhook (v1)" }, "v1.APIKeyCreatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "APIKey.created", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the API Key." }, "name": { "type": "string", "title": "Name", "description": "The name of the API Key.", "examples": [ "Default API Key" ] }, "key": { "type": "string", "title": "Key", "description": "The API Key.", "examples": [ "f9e67690304c23f133f7d965f130139d36f985b1ce8169a7d8ed99dbd5edc3b9" ] }, "environment": { "anyOf": [ { "$ref": "#/components/schemas/ApplicationType" }, { "type": "null" } ], "description": "The environment the key authenticates in. Null on federation and operator keys, which belong to no application.", "examples": [ "production", "sandbox" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the API Key was created." }, "default_request_mode": { "$ref": "#/components/schemas/DefaultRequestMode", "description": "The default execution mode for requests authenticated with this API key. 'sync' means requests block until completion; 'async' means requests return immediately with a 202 status. The Prefer header overrides this default.", "examples": [ "async", "sync" ] }, "federation_grants": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FederationGrant" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Federation Grants", "description": "Federation grants scoping this key. Populated only on federation API keys; null for organization and operator keys." }, "organization_grants": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrganizationGrant" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Organization Grants", "description": "Surfaces this organization key may reach ('api' for the customer HTTP API, 'exports' for the SFTP bulk data feed). Null means unscoped: full API access and no SFTP. Always null on federation and operator keys." } }, "type": "object", "required": [ "id", "name", "key", "created_at", "default_request_mode" ], "title": "APIKeyCreatedWebhook (v1)" }, "v1.APIKeyDeletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "APIKey.deleted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the deleted resource." } }, "type": "object", "required": [ "id" ], "title": "APIKeyDeletedWebhook (v1)" }, "v1.LienFilingDeletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LienFiling.deleted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the deleted resource." } }, "type": "object", "required": [ "id" ], "title": "LienFilingDeletedWebhook (v1)" }, "v1.PortfolioGroupDeletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioGroup.deleted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the deleted resource." } }, "type": "object", "required": [ "id" ], "title": "PortfolioGroupDeletedWebhook (v1)" }, "v1.PortfolioItemDeletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioItem.deleted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the deleted resource." } }, "type": "object", "required": [ "id" ], "title": "PortfolioItemDeletedWebhook (v1)" }, "v1.BusinessSearchCancelledWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "BusinessSearch.cancelled", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchCancelledWebhook (v1)" }, "v1.BusinessSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "BusinessSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchCompletedWebhook (v1)" }, "v1.BusinessSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "BusinessSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchFailedWebhook (v1)" }, "v1.BusinessSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "BusinessSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchSubmittedWebhook (v1)" }, "v1.BusinessSearchUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "BusinessSearch.updated", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features enabled during search execution.", "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "orderables": { "items": { "$ref": "#/components/schemas/Orderable" }, "type": "array", "title": "Orderables", "description": "A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.", "default": [], "examples": [ [ { "id": "b2c7bd8c-3b0d-42f1-837c-d6850fab4754", "option": "Order.WebsiteAnalysis", "type": "WebsiteAnalysisRequest", "url": "https://api.baselayer.com/website_analysis_requests/b2c7bd8c-3b0d-42f1-837c-d6850fab4754" } ] ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "address": { "type": "string", "title": "Address", "description": "The address string inputted in the search.", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names inputted in the search.", "examples": [ [ "Doc Brown" ] ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names inputted in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website inputted in the search.", "examples": [ "https://baselayer.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number inputted in the search.", "examples": [ "636-555-3226" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email inputted in the search.", "examples": [ "support@baselayer.com" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN inputted in the search.", "examples": [ "555666777" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.", "examples": [ true, false ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] }, "tin_potential_match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin Potential Match", "description": "If the inputted TIN/EIN was *not* a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.", "deprecated": true, "examples": [ "Baselayer" ] }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "The watchlist hits associated with the searched business.", "default": [] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/AddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity.", "examples": [ "EXACT" ] }, "business_officer_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business officers.", "examples": [ "SIMILAR" ] }, "registered_agent_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted officer name matches the found business registered agent.", "examples": [ "SIMILAR" ] }, "business_website_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Match", "description": "Does the inputted website match the found business website?", "examples": [ true, false ] }, "business_website_redirect_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Business Website Redirect Match", "description": "Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.", "examples": [ true, false ] }, "search_address_validation_level": { "anyOf": [ { "$ref": "#/components/schemas/AddressValidationLevel" }, { "type": "null" } ], "description": "The validation level derived during address normalization.", "examples": [ "FULL", "PARTIAL", "INVALID" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.087278" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.087297" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Indicates whether the found business was a close enough match to be considered verified.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "reason_codes": { "items": { "$ref": "#/components/schemas/ReasonCode" }, "type": "array", "title": "Reason Codes", "description": "The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.", "examples": [ [ "SEARCH_ADDRESS_CMRA" ] ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ], "description": "A representation of the Business identified by the Search." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] }, "status_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Status Url", "description": "The API URL to retrieve the status of the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314/status" ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/febe48f6-1f57-11ef-8bbf-1edb1b067314/status" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the search details in the console.", "examples": [ "https://console.baselayer.com/business/febe48f6-1f57-11ef-8bbf-1edb1b067314" ] } }, "type": "object", "required": [ "id", "options", "state", "name", "address", "created_at", "url", "status_url", "business_url" ], "title": "BusinessSearchUpdatedWebhook (v1)" }, "v1.SearchBatchUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "SearchBatch.updated", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the business search batch." }, "name": { "type": "string", "title": "Name", "description": "The name of the business search batch." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the business search batch." }, "progress": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Progress", "description": "Processing progress from 0.0 to 1.0. Null if not yet started.", "examples": [ 0.0, 0.45, 1.0 ] }, "completed_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Completed Count", "description": "Number of rows that have been processed. Null if not yet started." }, "total_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Total Count", "description": "Total number of rows to process. Null if not yet started." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the business search batch was created." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features to enable during business search execution.", "default": [], "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [] }, "export_csv_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Csv Uri", "description": "GCS URI for the pre-computed CSV export. Available after batch completion." }, "export_jsonl_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Jsonl Uri", "description": "GCS URI for the pre-computed JSONL export. Available after batch completion." }, "report_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Report Version", "description": "Report schema version. Available after batch completion." }, "exports_generated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Exports Generated At", "description": "When the export artifacts above were generated. Null until the batch first exports. This moves forward whenever the exports are regenerated because late TIN verdicts changed the results, so compare it against the value you last downloaded to tell whether your copy is current." }, "tin_matching_pending_count": { "type": "integer", "minimum": 0, "title": "Tin Matching Pending Count", "description": "How many of this batch's searches have concluded still awaiting a TIN verification verdict from the IRS AND will be retried to get one. A positive count means the exports are provisional: those rows report a pending TIN status today, and the files and report will be regenerated once the verdicts land. Zero means nothing is left to retry, so the exports will not change again on their own — it does NOT mean every TIN was verified. Rows whose retries ran out, or whose program has TIN-match retries switched off, leave this count without an answer; `tin_matching_unresolved_count` reports those. A search that is still running is in neither count, because its TIN match has not been attempted to a conclusion yet — so on a batch that has not reached `COMPLETED`, both counts can read zero with verifications still to come.", "default": 0, "examples": [ 0, 12 ] }, "tin_matching_unresolved_count": { "type": "integer", "minimum": 0, "title": "Tin Matching Unresolved Count", "description": "How many of this batch's searches supplied a TIN, finished without a verification verdict, and will not be retried for one — the retry attempts were used up, the program has TIN-match retries switched off, the search was cancelled, or it was made against a sandbox application. These rows are final at a non-matched status: waiting longer will not change them, and re-submitting the search is the only way to try again. Counted alongside `tin_matching_pending_count` rather than folded into it, because a batch can settle (pending zero) with unresolved rows still in it. A search that has not finished is in neither count — nothing has been given up on yet — so both reading zero on a batch that is still running does not mean every TIN was verified.", "default": 0, "examples": [ 0, 3 ] }, "questionnaire": { "anyOf": [ { "$ref": "#/components/schemas/DataTestQuestionnaire" }, { "type": "null" } ], "description": "Data-test questionnaire answers submitted with the batch, if any." } }, "type": "object", "required": [ "id", "name", "state", "created_at" ], "title": "SearchBatchUpdatedWebhook (v1)" }, "v1.DMFSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DMFSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the DMF search request" }, "name": { "type": "string", "maxLength": 250, "title": "Name", "description": "The name of the person of interest", "examples": [ "Michael Smith" ] }, "ssn": { "type": "string", "title": "Ssn", "description": "The obfuscated social security number of the person of interest", "examples": [ "621-34-2918" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the DMF search request.", "examples": [ "TimeoutError The IRS could not be reached." ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "ssn", "state" ], "title": "DMFSearchCompletedWebhook (v1)" }, "v1.DMFSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DMFSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the DMF search request" }, "name": { "type": "string", "maxLength": 250, "title": "Name", "description": "The name of the person of interest", "examples": [ "Michael Smith" ] }, "ssn": { "type": "string", "title": "Ssn", "description": "The obfuscated social security number of the person of interest", "examples": [ "621-34-2918" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the DMF search request.", "examples": [ "TimeoutError The IRS could not be reached." ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "ssn", "state" ], "title": "DMFSearchFailedWebhook (v1)" }, "v1.DMFSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DMFSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the DMF search request" }, "name": { "type": "string", "maxLength": 250, "title": "Name", "description": "The name of the person of interest", "examples": [ "Michael Smith" ] }, "ssn": { "type": "string", "title": "Ssn", "description": "The obfuscated social security number of the person of interest", "examples": [ "621-34-2918" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the DMF search request", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the DMF search request.", "examples": [ "TimeoutError The IRS could not be reached." ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "ssn", "state" ], "title": "DMFSearchSubmittedWebhook (v1)" }, "v1.DocketDetailsSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketDetailsSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket update request" }, "docket_id": { "type": "string", "format": "uuid", "title": "Docket Id", "description": "ID of the docket the search was performed for" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the update request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Any errors that occurred during the docket search request." }, "docket": { "anyOf": [ { "$ref": "#/components/schemas/v1.DocketResponse" }, { "type": "null" } ], "description": "The docket associated with the update request" } }, "type": "object", "required": [ "id", "docket_id", "state" ], "title": "DocketDetailsSearchCompletedWebhook (v1)" }, "v1.DocketDetailsSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketDetailsSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket update request" }, "docket_id": { "type": "string", "format": "uuid", "title": "Docket Id", "description": "ID of the docket the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the update request" } }, "type": "object", "required": [ "id", "docket_id", "state" ], "title": "DocketDetailsSearchFailedWebhook (v1)" }, "v1.DocketDetailsSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketDetailsSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket update request" }, "docket_id": { "type": "string", "format": "uuid", "title": "Docket Id", "description": "ID of the docket the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the update request" } }, "type": "object", "required": [ "id", "docket_id", "state" ], "title": "DocketDetailsSearchSubmittedWebhook (v1)" }, "v1.DocketExhibitSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketExhibitSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket exhibit document request" }, "docket_exhibit_id": { "type": "string", "format": "uuid", "title": "Docket Exhibit Id", "description": "ID of the docket exhibit the search was performed for" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the docket exhibit search request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the docket exhibit search request." }, "docket_exhibit": { "anyOf": [ { "$ref": "#/components/schemas/v1.DocketExhibit" }, { "type": "null" } ], "description": "The docket exhibit associated with the docket exhibit update request" } }, "type": "object", "required": [ "id", "docket_exhibit_id", "state" ], "title": "DocketExhibitSearchCompletedWebhook (v1)" }, "v1.DocketExhibitSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketExhibitSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket exhibit document request" }, "docket_exhibit_id": { "type": "string", "format": "uuid", "title": "Docket Exhibit Id", "description": "ID of the docket exhibit the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the document search request" } }, "type": "object", "required": [ "id", "docket_exhibit_id", "state" ], "title": "DocketExhibitSearchFailedWebhook (v1)" }, "v1.DocketExhibitSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketExhibitSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket exhibit document request" }, "docket_exhibit_id": { "type": "string", "format": "uuid", "title": "Docket Exhibit Id", "description": "ID of the docket exhibit the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the document search request" } }, "type": "object", "required": [ "id", "docket_exhibit_id", "state" ], "title": "DocketExhibitSearchSubmittedWebhook (v1)" }, "v1.DocketSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket search request" }, "search_entities": { "items": { "$ref": "#/components/schemas/v1.AdditionalDocketSearchEntityResponse" }, "type": "array", "title": "Search Entities", "description": "A list of entities searched in the docket search." }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "ID of the business the search was performed for" }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "ID of the person the search was performed for" }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "ID of the business search the docket search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the search request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the docket search request." }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "Date the search was last updated" }, "dockets": { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array", "title": "Dockets", "description": "A list of dockets associated with the search request." } }, "type": "object", "required": [ "id", "search_entities", "state", "last_updated_at", "dockets" ], "title": "DocketSearchCompletedWebhook (v1)" }, "v1.DocketSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket search request" }, "search_entities": { "items": { "$ref": "#/components/schemas/v1.AdditionalDocketSearchEntityResponse" }, "type": "array", "title": "Search Entities", "description": "A list of entities searched in the docket search." }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "ID of the business the search was performed for" }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "ID of the person the search was performed for" }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "ID of the business search the docket search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the search request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the docket search request." }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "Date the search was last updated" }, "dockets": { "items": { "$ref": "#/components/schemas/v1.DocketResponse" }, "type": "array", "title": "Dockets", "description": "A list of dockets associated with the search request." } }, "type": "object", "required": [ "id", "search_entities", "state", "last_updated_at", "dockets" ], "title": "DocketSearchFailedWebhook (v1)" }, "v1.DocketSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "DocketSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this docket search request." }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business the search was performed for." }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person the search was performed for." }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search the docket search was performed for" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the docket search request." } }, "type": "object", "required": [ "id", "state" ], "title": "DocketSearchSubmittedWebhook (v1)" }, "v1.EmailSenderFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "EmailSender.failed", "origin": "api" } }, "host": { "type": "string", "title": "Host", "description": "The SMTP host." }, "port": { "type": "integer", "title": "Port", "description": "465 (implicit TLS) or 587 (STARTTLS)." }, "security": { "$ref": "#/components/schemas/SmtpSecurity", "description": "How the connection is encrypted." }, "username": { "type": "string", "title": "Username", "description": "The SMTP login username." }, "has_password": { "type": "boolean", "title": "Has Password", "description": "Whether a password is stored.", "default": true }, "from_address": { "type": "string", "title": "From Address", "description": "The address code emails are sent from." }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Name", "description": "The name shown beside the From address; null shows the organization's name." }, "status": { "$ref": "#/components/schemas/EmailSenderStatus", "description": "UNVERIFIED until a test code is entered back, VERIFIED once it is, FAILING when a live send fails for a reason the organization must fix." }, "verified_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Verified At", "description": "When the sender was last verified." }, "last_tested_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Tested At", "description": "When a test send last settled." }, "last_error_kind": { "anyOf": [ { "$ref": "#/components/schemas/EmailSendResultKind" }, { "type": "null" } ], "description": "How the last failed send ended." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the sender was saved." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the sender last changed." } }, "type": "object", "required": [ "host", "port", "security", "username", "from_address", "from_name", "status", "created_at" ], "title": "EmailSenderFailedWebhook (v1)" }, "v1.EmployeeVerificationRequestCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "EmployeeVerificationRequest.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the employee verification request." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the request was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the request was last updated." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "Current state of the request." }, "person_name": { "type": "string", "title": "Person Name", "description": "Full name of the person being verified." }, "business_name": { "type": "string", "title": "Business Name", "description": "Name of the business being checked." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Business address provided for disambiguation." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names provided for the business." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Whether the person was verified as an employee." }, "role_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Title", "description": "Job title or role, if discovered." }, "department": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Department", "description": "Department, if discovered." }, "evidence_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Summary", "description": "Summary of evidence found." }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/EmployeeVerificationContact" }, { "type": "null" } ], "description": "Contact information discovered for the person." }, "socials": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSocial" }, "type": "array" }, { "type": "null" } ], "title": "Socials", "description": "Social media profiles discovered for the person." }, "miscellaneous_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationMiscLink" }, "type": "array" }, { "type": "null" } ], "title": "Miscellaneous Links", "description": "Other web links found for the person (e.g. GitHub, personal site)." }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources", "description": "Sources consulted during verification." } }, "type": "object", "required": [ "id", "created_at", "state", "person_name", "business_name" ], "title": "EmployeeVerificationRequestCompletedWebhook (v1)" }, "v1.EmployeeVerificationRequestFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "EmployeeVerificationRequest.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the employee verification request." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the request was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the request was last updated." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "Current state of the request." }, "person_name": { "type": "string", "title": "Person Name", "description": "Full name of the person being verified." }, "business_name": { "type": "string", "title": "Business Name", "description": "Name of the business being checked." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Business address provided for disambiguation." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names provided for the business." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Whether the person was verified as an employee." }, "role_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Title", "description": "Job title or role, if discovered." }, "department": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Department", "description": "Department, if discovered." }, "evidence_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Summary", "description": "Summary of evidence found." }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/EmployeeVerificationContact" }, { "type": "null" } ], "description": "Contact information discovered for the person." }, "socials": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSocial" }, "type": "array" }, { "type": "null" } ], "title": "Socials", "description": "Social media profiles discovered for the person." }, "miscellaneous_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationMiscLink" }, "type": "array" }, { "type": "null" } ], "title": "Miscellaneous Links", "description": "Other web links found for the person (e.g. GitHub, personal site)." }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources", "description": "Sources consulted during verification." } }, "type": "object", "required": [ "id", "created_at", "state", "person_name", "business_name" ], "title": "EmployeeVerificationRequestFailedWebhook (v1)" }, "v1.EmployeeVerificationRequestSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "EmployeeVerificationRequest.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the employee verification request." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the request was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the request was last updated." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "Current state of the request." }, "person_name": { "type": "string", "title": "Person Name", "description": "Full name of the person being verified." }, "business_name": { "type": "string", "title": "Business Name", "description": "Name of the business being checked." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Business address provided for disambiguation." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names provided for the business." }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Whether the person was verified as an employee." }, "role_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Title", "description": "Job title or role, if discovered." }, "department": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Department", "description": "Department, if discovered." }, "evidence_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Summary", "description": "Summary of evidence found." }, "contact": { "anyOf": [ { "$ref": "#/components/schemas/EmployeeVerificationContact" }, { "type": "null" } ], "description": "Contact information discovered for the person." }, "socials": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSocial" }, "type": "array" }, { "type": "null" } ], "title": "Socials", "description": "Social media profiles discovered for the person." }, "miscellaneous_links": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationMiscLink" }, "type": "array" }, { "type": "null" } ], "title": "Miscellaneous Links", "description": "Other web links found for the person (e.g. GitHub, personal site)." }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EmployeeVerificationSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources", "description": "Sources consulted during verification." } }, "type": "object", "required": [ "id", "created_at", "state", "person_name", "business_name" ], "title": "EmployeeVerificationRequestSubmittedWebhook (v1)" }, "v1.OnboardingSessionCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "OnboardingSession.completed", "origin": "api" } }, "submission_id": { "type": "string", "format": "uuid", "title": "Submission Id", "description": "Unique id of the submission." }, "state": { "$ref": "#/components/schemas/ResumableWorkflowState", "description": "Lifecycle state of the verification workflow." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Resolved onboarding verdict; null until completion." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the workflow reached a terminal state." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Pairwise reference to the verified individual, unique to the calling organization and stable across re-verification." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Pairwise reference to the verified business, when the submission covered one." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the principal-operates-business link as of this submission's evaluation." } }, "type": "object", "required": [ "submission_id", "state" ], "title": "OnboardingSessionCompletedWebhook (v1)" }, "v1.OnboardingSessionFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "OnboardingSession.failed", "origin": "api" } }, "submission_id": { "type": "string", "format": "uuid", "title": "Submission Id", "description": "Unique id of the submission." }, "state": { "$ref": "#/components/schemas/ResumableWorkflowState", "description": "Lifecycle state of the verification workflow." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Resolved onboarding verdict; null until completion." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the workflow reached a terminal state." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Pairwise reference to the verified individual, unique to the calling organization and stable across re-verification." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Pairwise reference to the verified business, when the submission covered one." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the principal-operates-business link as of this submission's evaluation." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "description": "Why the session did not complete." } }, "type": "object", "required": [ "submission_id", "state" ], "title": "OnboardingSessionFailedWebhook (v1)" }, "v1.OnboardingSessionUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "OnboardingSession.updated", "origin": "api" } }, "submission_id": { "type": "string", "format": "uuid", "title": "Submission Id", "description": "Unique id of the submission." }, "state": { "$ref": "#/components/schemas/ResumableWorkflowState", "description": "Lifecycle state of the verification workflow." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Resolved onboarding verdict; null until completion." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the workflow reached a terminal state." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Pairwise reference to the verified individual, unique to the calling organization and stable across re-verification." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Pairwise reference to the verified business, when the submission covered one." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the principal-operates-business link as of this submission's evaluation." }, "decision": { "$ref": "#/components/schemas/ManualOnboardingDecision", "description": "Manual decision applied to the session." }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason", "description": "Reviewer-supplied decision reason, when given." }, "decided_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided At", "description": "When the decision was recorded." }, "findings": { "items": { "$ref": "#/components/schemas/OnboardingFinding" }, "type": "array", "title": "Findings", "description": "The session's materialized findings, frozen at packet delivery — the open findings this decision resolved." } }, "type": "object", "required": [ "submission_id", "state", "decision" ], "title": "OnboardingSessionUpdatedWebhook (v1)" }, "v1.InternationalBusinessSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "InternationalBusinessSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the international business search." }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name inputted in the search (null when omitted).", "examples": [ "Acme Corporation" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address string inputted in the search (null when omitted).", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/InternationalSearchISO2CountryCode" }, { "type": "null" } ], "description": "The ISO 2 country code the search ran against.", "examples": [ "GB" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalAddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "filing_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Number", "description": "The company registration (filing) number inputted in the search.", "examples": [ "09517735" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/InternationalAddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "filing_number_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Filing Number Match", "description": "Whether the inputted filing number found the company at the registry. False means the search fell back to the name search; null means no filing number was provided or the lookup was unavailable.", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.205317" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.205334" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "True when the KYB grade is A or B. A filing-number mismatch reduces the score but does not independently block verification.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "Persisted watchlist screening results for this search. A source with count zero completed screening without matches. An absent source does not indicate a completed or clean screen." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "Address validation is unavailable." ] }, "options": { "items": { "$ref": "#/components/schemas/InternationalBusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional, separately-billed add-ons requested for this search.", "examples": [ [ "Order.Enhanced" ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalBusinessResponse" }, { "type": "null" } ], "description": "A summary of the found business. When the enhanced profile add-on is ordered, this also includes officers, beneficial owners, shareholders, share capital, contact details, and the registered agent, along with fuller registry and tax identifiers and classified business activities." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] } }, "type": "object", "required": [ "id", "state", "created_at", "url" ], "title": "InternationalBusinessSearchCompletedWebhook (v1)" }, "v1.InternationalBusinessSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "InternationalBusinessSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the international business search." }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name inputted in the search (null when omitted).", "examples": [ "Acme Corporation" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address string inputted in the search (null when omitted).", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/InternationalSearchISO2CountryCode" }, { "type": "null" } ], "description": "The ISO 2 country code the search ran against.", "examples": [ "GB" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalAddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "filing_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Number", "description": "The company registration (filing) number inputted in the search.", "examples": [ "09517735" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/InternationalAddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "filing_number_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Filing Number Match", "description": "Whether the inputted filing number found the company at the registry. False means the search fell back to the name search; null means no filing number was provided or the lookup was unavailable.", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.205317" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.205334" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "True when the KYB grade is A or B. A filing-number mismatch reduces the score but does not independently block verification.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "Persisted watchlist screening results for this search. A source with count zero completed screening without matches. An absent source does not indicate a completed or clean screen." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "Address validation is unavailable." ] }, "options": { "items": { "$ref": "#/components/schemas/InternationalBusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional, separately-billed add-ons requested for this search.", "examples": [ [ "Order.Enhanced" ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalBusinessResponse" }, { "type": "null" } ], "description": "A summary of the found business. When the enhanced profile add-on is ordered, this also includes officers, beneficial owners, shareholders, share capital, contact details, and the registered agent, along with fuller registry and tax identifiers and classified business activities." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] } }, "type": "object", "required": [ "id", "state", "created_at", "url" ], "title": "InternationalBusinessSearchFailedWebhook (v1)" }, "v1.InternationalBusinessSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "InternationalBusinessSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the international business search." }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name inputted in the search (null when omitted).", "examples": [ "Acme Corporation" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The address string inputted in the search (null when omitted).", "examples": [ "1640 Riverside Drive, Hill Valley, CA" ] }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/InternationalSearchISO2CountryCode" }, { "type": "null" } ], "description": "The ISO 2 country code the search ran against.", "examples": [ "GB" ] }, "search_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalAddressSummaryResponse" }, { "type": "null" } ], "description": "The sanitized address inputted in the search." }, "filing_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Number", "description": "The company registration (filing) number inputted in the search.", "examples": [ "09517735" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID inputted in the search.", "examples": [ "Search1234" ] }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted name matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "business_address_match": { "anyOf": [ { "$ref": "#/components/schemas/InternationalAddressMatchType" }, { "type": "null" } ], "description": "Indicates how close the inputted address matches the found business entity. Null when this input was omitted.", "examples": [ "EXACT" ] }, "filing_number_match": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Filing Number Match", "description": "Whether the inputted filing number found the company at the registry. False means the search fell back to the name search; null means no filing number was provided or the lookup was unavailable.", "examples": [ true ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.205317" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.205334" ] }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "True when the KYB grade is A or B. A filing-number mismatch reduces the score but does not independently block verification.", "examples": [ true, false ] }, "scores": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.ScoreResponse" }, "type": "array" }, { "type": "null" } ], "title": "Scores", "description": "An array containing Baselayer's ratings." }, "watchlist_hits": { "items": { "$ref": "#/components/schemas/v1.WatchlistHitResponse" }, "type": "array", "title": "Watchlist Hits", "description": "Persisted watchlist screening results for this search. A source with count zero completed screening without matches. An absent source does not indicate a completed or clean screen." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred." }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "Address validation is unavailable." ] }, "options": { "items": { "$ref": "#/components/schemas/InternationalBusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional, separately-billed add-ons requested for this search.", "examples": [ [ "Order.Enhanced" ] ] }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.InternationalBusinessResponse" }, { "type": "null" } ], "description": "A summary of the found business. When the enhanced profile add-on is ordered, this also includes officers, beneficial owners, shareholders, share capital, contact details, and the registered agent, along with fuller registry and tax identifiers and classified business activities." }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "The API URL to retrieve the search.", "examples": [ "https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314" ] } }, "type": "object", "required": [ "id", "state", "created_at", "url" ], "title": "InternationalBusinessSearchSubmittedWebhook (v1)" }, "v1.LienFilingCreatedWebhook": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCreatedWebhook_LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingCreatedWebhook_LienFilingSubmissionUCC3Response" }, { "$ref": "#/components/schemas/v1.LienFilingCreatedWebhook_LienFilingSubmissionImportedResponse" } ], "title": "LienFilingCreatedWebhook" }, "v1.LienFilingImportBatchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LienFilingImportBatch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Import Batch ID", "description": "The batch's id, used to poll status and fetch per-row results." }, "name": { "type": "string", "title": "Name", "description": "The name of the batch, taken from the uploaded file.", "examples": [ "q3-portfolio-liens.csv" ] }, "state": { "$ref": "#/components/schemas/TaskState", "title": "State", "description": "Processing state of the batch.", "examples": [ "PENDING" ] }, "total_count": { "type": "integer", "title": "Total Count", "description": "Rows read from the uploaded CSV, excluding blank lines.", "examples": [ 100 ] }, "imported_count": { "type": "integer", "title": "Imported Count", "description": "Rows that resolved against the public record and produced a newly imported filing.", "default": 0, "examples": [ 80 ] }, "already_imported_count": { "type": "integer", "title": "Already Imported Count", "description": "Rows naming a lien the organization had already imported; the existing filing is kept.", "default": 0, "examples": [ 15 ] }, "not_found_count": { "type": "integer", "title": "Not Found Count", "description": "Rows whose state and filing number matched nothing in the public record.", "default": 0, "examples": [ 4 ] }, "invalid_row_count": { "type": "integer", "title": "Invalid Row Count", "description": "Rows rejected before resolution (unparseable state, blank filing number, and the like).", "default": 0, "examples": [ 1 ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Why the batch last failed, as a human-readable message. Set when the state is FAILED; a batch that failed once and succeeded on a resume can still carry the message from that attempt, so read it alongside the state rather than as a failure signal on its own.", "examples": [ "The uploaded CSV could not be read from storage." ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the batch was accepted." } }, "type": "object", "required": [ "id", "name", "state", "total_count", "created_at" ], "title": "LienFilingImportBatchCompletedWebhook (v1)" }, "v1.LienFilingImportBatchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LienFilingImportBatch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Import Batch ID", "description": "The batch's id, used to poll status and fetch per-row results." }, "name": { "type": "string", "title": "Name", "description": "The name of the batch, taken from the uploaded file.", "examples": [ "q3-portfolio-liens.csv" ] }, "state": { "$ref": "#/components/schemas/TaskState", "title": "State", "description": "Processing state of the batch.", "examples": [ "PENDING" ] }, "total_count": { "type": "integer", "title": "Total Count", "description": "Rows read from the uploaded CSV, excluding blank lines.", "examples": [ 100 ] }, "imported_count": { "type": "integer", "title": "Imported Count", "description": "Rows that resolved against the public record and produced a newly imported filing.", "default": 0, "examples": [ 80 ] }, "already_imported_count": { "type": "integer", "title": "Already Imported Count", "description": "Rows naming a lien the organization had already imported; the existing filing is kept.", "default": 0, "examples": [ 15 ] }, "not_found_count": { "type": "integer", "title": "Not Found Count", "description": "Rows whose state and filing number matched nothing in the public record.", "default": 0, "examples": [ 4 ] }, "invalid_row_count": { "type": "integer", "title": "Invalid Row Count", "description": "Rows rejected before resolution (unparseable state, blank filing number, and the like).", "default": 0, "examples": [ 1 ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Why the batch last failed, as a human-readable message. Set when the state is FAILED; a batch that failed once and succeeded on a resume can still carry the message from that attempt, so read it alongside the state rather than as a failure signal on its own.", "examples": [ "The uploaded CSV could not be read from storage." ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the batch was accepted." } }, "type": "object", "required": [ "id", "name", "state", "total_count", "created_at" ], "title": "LienFilingImportBatchFailedWebhook (v1)" }, "v1.LienFilingUpdatedWebhook": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUpdatedWebhook_LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingUpdatedWebhook_LienFilingSubmissionUCC3Response" }, { "$ref": "#/components/schemas/v1.LienFilingUpdatedWebhook_LienFilingSubmissionImportedResponse" } ], "title": "LienFilingUpdatedWebhook" }, "v1.LiensSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LiensSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this liens search response." }, "search_entities": { "items": { "$ref": "#/components/schemas/v1.AdditionalLiensSearchEntityResponse" }, "type": "array", "title": "Search Entities", "description": "A list of entities searched in the liens search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ] }, "filings": { "items": { "$ref": "#/components/schemas/v1.LienFilingResponse" }, "type": "array", "title": "Filings", "description": "A list of lien filings associated with the search request." }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ] }, "searched_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "States Specified for Liens Search", "description": "Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.", "examples": [ [ "FL", "CA" ] ] }, { "type": "null", "title": "Liens Search Limited to Domestic State", "description": "Indicates that the liens search was limited to the domestic state of the business. A domestic state is defined as the state where the business filed its articles of incorporation and is considered its legal home state for tax purposes. This contrasts with any other states where the business might operate as a foreign entity. The search was thus focused on liens within this domestic jurisdiction, in line with the business's legal recognition and operational base." } ], "title": "Searched States" }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business associated with these lien filings.", "examples": [ "2d96141a-66be-4dcc-91cb-208a0a7978f8" ] }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person associated with these lien filings.", "examples": [ "ae3a53f8-517f-4c05-ad5f-05a938364917" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search associated with these lien filings.", "examples": [ "13bffc01-7eba-40b7-960e-32132fd3ea15" ] } }, "type": "object", "required": [ "id", "search_entities", "state", "filings", "last_updated_at" ], "title": "LiensSearchCompletedWebhook (v1)" }, "v1.LiensSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LiensSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this liens search response." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ] }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ] }, "searched_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "States Specified for Liens Search", "description": "Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.", "examples": [ [ "CA", "GA" ] ] }, { "type": "null", "title": "Liens Search Limited to Domestic State", "description": "Indicates that the liens search was limited to the domestic state of the business. A domestic state is defined as the state where the business filed its articles of incorporation and is considered its legal home state for tax purposes. This contrasts with any other states where the business might operate as a foreign entity. The search was thus focused on liens within this domestic jurisdiction, in line with the business's legal recognition and operational base." } ], "title": "Searched States" }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person associated with these lien filings.", "examples": [ "d6890508-aaad-464d-aff4-7bc0aa910006" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business associated with these lien filings.", "examples": [ "dbbb560d-2990-4af7-888c-5cc5b2d29d60" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search associated with these lien filings.", "examples": [ "14360571-3fa5-4996-9288-6277350ca3c7" ] } }, "type": "object", "required": [ "id", "state", "last_updated_at" ], "title": "LiensSearchFailedWebhook (v1)" }, "v1.LiensSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "LiensSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this liens search response." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ] }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ] }, "searched_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "States Specified for Liens Search", "description": "Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.", "examples": [ [ "CA", "GA" ] ] }, { "type": "null", "title": "Liens Search Limited to Domestic State", "description": "Indicates that the liens search was limited to the domestic state of the business. A domestic state is defined as the state where the business filed its articles of incorporation and is considered its legal home state for tax purposes. This contrasts with any other states where the business might operate as a foreign entity. The search was thus focused on liens within this domestic jurisdiction, in line with the business's legal recognition and operational base." } ], "title": "Searched States" }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person associated with these lien filings.", "examples": [ "d6890508-aaad-464d-aff4-7bc0aa910006" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business associated with these lien filings.", "examples": [ "dbbb560d-2990-4af7-888c-5cc5b2d29d60" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search associated with these lien filings.", "examples": [ "14360571-3fa5-4996-9288-6277350ca3c7" ] } }, "type": "object", "required": [ "id", "state", "last_updated_at" ], "title": "LiensSearchSubmittedWebhook (v1)" }, "v1.NAICSPredictionRequestCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "NAICSPredictionRequest.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the NAICS prediction request.", "examples": [ "7d25333a-2472-46fa-a469-0fc4822759cd" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the NAICS prediction request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The ID of the business for which the NAICS code was predicted.", "examples": [ "f697fb24-0487-495c-8819-1ef48e2469f6" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The ID of the business search from which this NAICS prediction request originated.", "examples": [ "f81496d5-82cc-4227-beee-e523111835b6" ] }, "predicted_naics": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "description": "The predicted NAICS code(s) for the business entity." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the NAICS prediction request." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the NAICS prediction request was created.", "examples": [ "2026-10-29T05:44:47.891567" ] } }, "type": "object", "required": [ "id", "state", "created_at" ], "title": "NAICSPredictionRequestCompletedWebhook (v1)" }, "v1.NAICSPredictionRequestFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "NAICSPredictionRequest.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the NAICS prediction request.", "examples": [ "7d25333a-2472-46fa-a469-0fc4822759cd" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the NAICS prediction request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The ID of the business for which the NAICS code was predicted.", "examples": [ "f697fb24-0487-495c-8819-1ef48e2469f6" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The ID of the business search from which this NAICS prediction request originated.", "examples": [ "f81496d5-82cc-4227-beee-e523111835b6" ] }, "predicted_naics": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "description": "The predicted NAICS code(s) for the business entity." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the NAICS prediction request." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the NAICS prediction request was created.", "examples": [ "2026-10-29T05:44:47.891567" ] } }, "type": "object", "required": [ "id", "state", "created_at" ], "title": "NAICSPredictionRequestFailedWebhook (v1)" }, "v1.NAICSPredictionRequestSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "NAICSPredictionRequest.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the NAICS prediction request.", "examples": [ "7d25333a-2472-46fa-a469-0fc4822759cd" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the NAICS prediction request", "examples": [ "COMPLETED", "FAILED" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The ID of the business for which the NAICS code was predicted.", "examples": [ "f697fb24-0487-495c-8819-1ef48e2469f6" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The ID of the business search from which this NAICS prediction request originated.", "examples": [ "f81496d5-82cc-4227-beee-e523111835b6" ] }, "predicted_naics": { "anyOf": [ { "$ref": "#/components/schemas/v1.PredictedNaicsResponse" }, { "type": "null" } ], "description": "The predicted NAICS code(s) for the business entity." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the NAICS prediction request." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the NAICS prediction request was created.", "examples": [ "2026-10-29T05:44:47.891567" ] } }, "type": "object", "required": [ "id", "state", "created_at" ], "title": "NAICSPredictionRequestSubmittedWebhook (v1)" }, "v1.VerificationCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "Verification.completed", "origin": "api" } }, "verification_id": { "type": "string", "format": "uuid", "title": "Verification Id", "description": "Unique id of the verification." }, "type": { "$ref": "#/components/schemas/v1.VerificationType", "description": "Whether a business is verified too." }, "state": { "$ref": "#/components/schemas/v1.VerificationState", "description": "Lifecycle state of the verification workflow." }, "automated_verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "What the checks concluded, `APPROVED` or `UNDER_REVIEW`; null until the verification completes." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "The effective verdict: your reviewer's decision when one was made, otherwise `automated_verdict`." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "description": "Typed state and detail when the workflow ended in FAILED; null otherwise." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the individual-operates-business link as of this verification." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The `Idempotency-Key` the verification was created with." }, "environment": { "$ref": "#/components/schemas/ApplicationType", "description": "The environment the verification ran in." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the verification was created." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the verification reached a terminal status." } }, "type": "object", "required": [ "verification_id", "type", "state", "environment", "created_at" ], "title": "VerificationCompletedWebhook (v1)" }, "v1.VerificationFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "Verification.failed", "origin": "api" } }, "verification_id": { "type": "string", "format": "uuid", "title": "Verification Id", "description": "Unique id of the verification." }, "type": { "$ref": "#/components/schemas/v1.VerificationType", "description": "Whether a business is verified too." }, "state": { "$ref": "#/components/schemas/v1.VerificationState", "description": "Lifecycle state of the verification workflow." }, "automated_verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "What the checks concluded, `APPROVED` or `UNDER_REVIEW`; null until the verification completes." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "The effective verdict: your reviewer's decision when one was made, otherwise `automated_verdict`." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "description": "Typed state and detail when the workflow ended in FAILED; null otherwise." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the individual-operates-business link as of this verification." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The `Idempotency-Key` the verification was created with." }, "environment": { "$ref": "#/components/schemas/ApplicationType", "description": "The environment the verification ran in." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the verification was created." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the verification reached a terminal status." } }, "type": "object", "required": [ "verification_id", "type", "state", "environment", "created_at" ], "title": "VerificationFailedWebhook (v1)" }, "v1.VerificationUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "Verification.updated", "origin": "api" } }, "verification_id": { "type": "string", "format": "uuid", "title": "Verification Id", "description": "Unique id of the verification." }, "type": { "$ref": "#/components/schemas/v1.VerificationType", "description": "Whether a business is verified too." }, "state": { "$ref": "#/components/schemas/v1.VerificationState", "description": "Lifecycle state of the verification workflow." }, "automated_verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "What the checks concluded, `APPROVED` or `UNDER_REVIEW`; null until the verification completes." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "The effective verdict: your reviewer's decision when one was made, otherwise `automated_verdict`." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "description": "Typed state and detail when the workflow ended in FAILED; null otherwise." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified." }, "business_operator_link_status": { "anyOf": [ { "$ref": "#/components/schemas/BusinessOperatorLinkStatus" }, { "type": "null" } ], "description": "Status of the individual-operates-business link as of this verification." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The `Idempotency-Key` the verification was created with." }, "environment": { "$ref": "#/components/schemas/ApplicationType", "description": "The environment the verification ran in." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the verification was created." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the verification reached a terminal status." } }, "type": "object", "required": [ "verification_id", "type", "state", "environment", "created_at" ], "title": "VerificationUpdatedWebhook (v1)" }, "v1.OrderCreatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "Order.created", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this order." }, "type": { "$ref": "#/components/schemas/OrderType", "description": "The type of product that was ordered." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the order was created.", "examples": [ "2026-10-29T05:44:48.419081" ] }, "orderable_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Orderable Id", "description": "The identifier of the ordered product (e.g., a business search)." }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties", "description": "A dictionary of properties about the order." }, "user": { "anyOf": [ { "$ref": "#/components/schemas/v1.UserAttributionResponse" }, { "type": "null" } ], "description": "Details on the User who performed the search." } }, "type": "object", "required": [ "id", "type", "created_at", "properties" ], "title": "OrderCreatedWebhook (v1)" }, "v1.PersonSearchCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PersonSearch.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.425737" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.425756" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with the search.", "examples": [ "Search1234" ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person to search for." }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Whether the SSN for this person search matches with the name provided", "examples": [ true, false ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] } }, "type": "object", "required": [ "id", "state", "created_at", "person" ], "title": "PersonSearchCompletedWebhook (v1)" }, "v1.PersonSearchFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PersonSearch.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.425737" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.425756" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with the search.", "examples": [ "Search1234" ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person to search for." }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Whether the SSN for this person search matches with the name provided", "examples": [ true, false ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] } }, "type": "object", "required": [ "id", "state", "created_at", "person" ], "title": "PersonSearchFailedWebhook (v1)" }, "v1.PersonSearchSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PersonSearch.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.425737" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.425756" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with the search.", "examples": [ "Search1234" ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person to search for." }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Whether the SSN for this person search matches with the name provided", "examples": [ true, false ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] } }, "type": "object", "required": [ "id", "state", "created_at", "person" ], "title": "PersonSearchSubmittedWebhook (v1)" }, "v1.PersonSearchUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PersonSearch.updated", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the search." }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the search was created.", "examples": [ "2026-10-29T05:44:48.425737" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The datetime the search was updated at (generally when the search completed).", "examples": [ "2026-10-29T05:44:48.425756" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with the search.", "examples": [ "Search1234" ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person to search for." }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Whether the SSN for this person search matches with the name provided", "examples": [ true, false ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] } }, "type": "object", "required": [ "id", "state", "created_at", "person" ], "title": "PersonSearchUpdatedWebhook (v1)" }, "v1.PortfolioGroupCreatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioGroup.created", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the portfolio group." }, "name": { "type": "string", "title": "Name", "description": "The name of the portfolio group." }, "items_count": { "type": "integer", "title": "Items Count", "description": "The number of items in this portfolio group." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the portfolio group was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the portfolio group was last updated." } }, "type": "object", "required": [ "id", "name", "items_count", "created_at", "updated_at" ], "title": "PortfolioGroupCreatedWebhook (v1)" }, "v1.PortfolioGroupUpdatedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioGroup.updated", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the portfolio group." }, "name": { "type": "string", "title": "Name", "description": "The name of the portfolio group." }, "items_count": { "type": "integer", "title": "Items Count", "description": "The number of items in this portfolio group." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the portfolio group was created." }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the portfolio group was last updated." } }, "type": "object", "required": [ "id", "name", "items_count", "created_at", "updated_at" ], "title": "PortfolioGroupUpdatedWebhook (v1)" }, "v1.PortfolioItemCreatedWebhook": { "properties": { "root": { "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessPortfolioItemResponse" }, { "$ref": "#/components/schemas/v1.PersonPortfolioItemResponse" } ], "title": "Root", "description": "The webhook payload data", "discriminator": { "propertyName": "type", "mapping": { "Business": "#/components/schemas/v1.BusinessPortfolioItemResponse", "Person": "#/components/schemas/v1.PersonPortfolioItemResponse" } } }, "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioItem.created", "origin": "api" } } }, "type": "object", "required": [ "root" ], "title": "PortfolioItemCreatedWebhook" }, "v1.PortfolioItemUpdatedWebhook": { "properties": { "root": { "oneOf": [ { "$ref": "#/components/schemas/v1.BusinessPortfolioItemResponse" }, { "$ref": "#/components/schemas/v1.PersonPortfolioItemResponse" } ], "title": "Root", "description": "The webhook payload data", "discriminator": { "propertyName": "type", "mapping": { "Business": "#/components/schemas/v1.BusinessPortfolioItemResponse", "Person": "#/components/schemas/v1.PersonPortfolioItemResponse" } } }, "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "PortfolioItem.updated", "origin": "api" } } }, "type": "object", "required": [ "root" ], "title": "PortfolioItemUpdatedWebhook" }, "v1.TINVerificationCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "TINVerification.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the TIN verification request.", "examples": [ "d2682fdb-46fe-429c-8111-dee6db9d0eb3" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request.", "examples": [ "COMPLETED" ] }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "tin": { "type": "string", "maxLength": 9, "minLength": 9, "title": "Tin", "description": "The TIN inputted in the search.", "examples": [ "123456789" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Address", "description": "The address inputted in the search.", "examples": [ "123 Main St, Anytown, USA" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS.", "examples": [ true ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the TIN verification request was created.", "examples": [ "2026-10-29T05:44:48.448457" ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] } }, "type": "object", "required": [ "id", "state", "name", "tin", "created_at" ], "title": "TINVerificationCompletedWebhook (v1)" }, "v1.TINVerificationFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "TINVerification.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the TIN verification request.", "examples": [ "d2682fdb-46fe-429c-8111-dee6db9d0eb3" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request.", "examples": [ "COMPLETED" ] }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "tin": { "type": "string", "maxLength": 9, "minLength": 9, "title": "Tin", "description": "The TIN inputted in the search.", "examples": [ "123456789" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Address", "description": "The address inputted in the search.", "examples": [ "123 Main St, Anytown, USA" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS.", "examples": [ true ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the TIN verification request was created.", "examples": [ "2026-10-29T05:44:48.448457" ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] } }, "type": "object", "required": [ "id", "state", "name", "tin", "created_at" ], "title": "TINVerificationFailedWebhook (v1)" }, "v1.TINVerificationSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "TINVerification.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the TIN verification request.", "examples": [ "d2682fdb-46fe-429c-8111-dee6db9d0eb3" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request.", "examples": [ "COMPLETED" ] }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "tin": { "type": "string", "maxLength": 9, "minLength": 9, "title": "Tin", "description": "The TIN inputted in the search.", "examples": [ "123456789" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Address", "description": "The address inputted in the search.", "examples": [ "123 Main St, Anytown, USA" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS.", "examples": [ true ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the TIN verification request was created.", "examples": [ "2026-10-29T05:44:48.448457" ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] } }, "type": "object", "required": [ "id", "state", "name", "tin", "created_at" ], "title": "TINVerificationSubmittedWebhook (v1)" }, "v1.WebsiteAnalysisRequestCompletedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "WebsiteAnalysisRequest.completed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the Website Analysis request" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the Website Analysis request" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the Website Analysis was created.", "examples": [ "2026-10-29T05:44:48.057469" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The most recent date and time when the Website Analysis was updated.", "examples": [ "2026-10-29T05:44:48.057488" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.ray.com/" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "If the website analysis was performed on a business's website, this will be the ID of the business.", "examples": [ "05e6169f-f9c2-416f-8da2-99b881b6cae3" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The details of the website analysis.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis", "emails": [ "njohnson@example.net" ], "id": "ef378489-5cf1-4043-8f6b-3ecb59ca5a1e", "parked": false, "people": [], "phone_numbers": [ "285.302.6793" ], "screenshot_url": "https://api.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis/screenshot", "social_profiles": [], "ssl_validity": { "cert_age_days": 245, "certificate_type": "OV", "days_until_expiry": 120, "expiry_date": "2025-03-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-03-01T00:00:00", "issuer": "DigiCert Inc", "key_size": 2048, "subject": "mitchell.com", "tls_version": "TLSv1.3" }, "url": "http://mitchell.com/", "website_structure_metrics": { "breadth": "15+", "depth": "2+" }, "whois_record": { "domain_created_at": "2020-05-15T10:30:00", "domain_expires_at": "2025-05-15T10:30:00", "domain_updated_at": "2023-06-01T14:45:00", "registrar": "Example Registrar Inc." } } ] } }, "type": "object", "required": [ "id", "state", "created_at", "updated_at", "url" ], "title": "WebsiteAnalysisRequestCompletedWebhook (v1)" }, "v1.WebsiteAnalysisRequestFailedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "WebsiteAnalysisRequest.failed", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the Website Analysis request" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the Website Analysis request" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the Website Analysis was created.", "examples": [ "2026-10-29T05:44:48.057469" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The most recent date and time when the Website Analysis was updated.", "examples": [ "2026-10-29T05:44:48.057488" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.ray.com/" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "If the website analysis was performed on a business's website, this will be the ID of the business.", "examples": [ "05e6169f-f9c2-416f-8da2-99b881b6cae3" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The details of the website analysis.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis", "emails": [ "njohnson@example.net" ], "id": "ef378489-5cf1-4043-8f6b-3ecb59ca5a1e", "parked": false, "people": [], "phone_numbers": [ "285.302.6793" ], "screenshot_url": "https://api.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis/screenshot", "social_profiles": [], "ssl_validity": { "cert_age_days": 245, "certificate_type": "OV", "days_until_expiry": 120, "expiry_date": "2025-03-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-03-01T00:00:00", "issuer": "DigiCert Inc", "key_size": 2048, "subject": "mitchell.com", "tls_version": "TLSv1.3" }, "url": "http://mitchell.com/", "website_structure_metrics": { "breadth": "15+", "depth": "2+" }, "whois_record": { "domain_created_at": "2020-05-15T10:30:00", "domain_expires_at": "2025-05-15T10:30:00", "domain_updated_at": "2023-06-01T14:45:00", "registrar": "Example Registrar Inc." } } ] } }, "type": "object", "required": [ "id", "state", "created_at", "updated_at", "url" ], "title": "WebsiteAnalysisRequestFailedWebhook (v1)" }, "v1.WebsiteAnalysisRequestSubmittedWebhook": { "properties": { "__event__": { "$ref": "#/components/schemas/WebhookMetadata", "default": { "type": "WebsiteAnalysisRequest.submitted", "origin": "api" } }, "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The ID of the Website Analysis request" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the Website Analysis request" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the Website Analysis was created.", "examples": [ "2026-10-29T05:44:48.057469" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The most recent date and time when the Website Analysis was updated.", "examples": [ "2026-10-29T05:44:48.057488" ] }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url", "description": "The website URL that was analyzed as part of the Search.", "examples": [ "http://www.ray.com/" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "If the website analysis was performed on a business's website, this will be the ID of the business.", "examples": [ "05e6169f-f9c2-416f-8da2-99b881b6cae3" ] }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID associated with this request, inherited from the parent search.", "examples": [ "Search1234" ] }, "website_analysis": { "anyOf": [ { "$ref": "#/components/schemas/v1.WebsiteAnalysisDetails" }, { "type": "null" } ], "description": "The details of the website analysis.", "examples": [ { "addresses": [], "console_url": "https://console.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis", "emails": [ "njohnson@example.net" ], "id": "ef378489-5cf1-4043-8f6b-3ecb59ca5a1e", "parked": false, "people": [], "phone_numbers": [ "285.302.6793" ], "screenshot_url": "https://api.baselayer.com/business/da832aea-1f7c-11ef-9f4b-1edb1b067314/website_analysis/screenshot", "social_profiles": [], "ssl_validity": { "cert_age_days": 245, "certificate_type": "OV", "days_until_expiry": 120, "expiry_date": "2025-03-01T00:00:00", "is_revoked": false, "is_self_signed": false, "is_valid": true, "is_wildcard": false, "issued_date": "2024-03-01T00:00:00", "issuer": "DigiCert Inc", "key_size": 2048, "subject": "mitchell.com", "tls_version": "TLSv1.3" }, "url": "http://mitchell.com/", "website_structure_metrics": { "breadth": "15+", "depth": "2+" }, "whois_record": { "domain_created_at": "2020-05-15T10:30:00", "domain_expires_at": "2025-05-15T10:30:00", "domain_updated_at": "2023-06-01T14:45:00", "registrar": "Example Registrar Inc." } } ] } }, "type": "object", "required": [ "id", "state", "created_at", "updated_at", "url" ], "title": "WebsiteAnalysisRequestSubmittedWebhook (v1)" }, "v1.AdHocNAICSPredictionRequest": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the business." }, "address": { "type": "string", "title": "Address", "description": "The address of the business." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 10, "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names for the business (e.g., DBA names)" }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "List of business officers' names." }, "website": { "anyOf": [ { "type": "string", "maxLength": 2083 }, { "type": "null" } ], "title": "Website", "description": "The website URL associated with the business." }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "A phone number associated with the business." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "An email address associated with the business." }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the request." } }, "additionalProperties": false, "type": "object", "required": [ "name", "address" ], "title": "AdHocNAICSPredictionRequest (v1)", "description": "Request model for ad-hoc NAICS code prediction." }, "v1.AdditionalDocketSearchEntityRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name", "description": "The name of the entity to search for." }, "type": { "$ref": "#/components/schemas/BusinessOrPersonType", "description": "The type of the entity to search for." } }, "additionalProperties": false, "type": "object", "required": [ "name", "type" ], "title": "AdditionalDocketSearchEntityRequest (v1)", "description": "Represents a request to add an entity to a docket search." }, "v1.AdditionalLiensSearchEntityRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name", "description": "The name of the entity to search for." }, "type": { "$ref": "#/components/schemas/BusinessOrPersonType", "description": "The type of the entity to search for." }, "search_states": { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "minItems": 1, "title": "Search States", "description": "The states to search for liens in." } }, "additionalProperties": false, "type": "object", "required": [ "name", "type", "search_states" ], "title": "AdditionalLiensSearchEntityRequest (v1)", "description": "Represents a request to add an entity to a liens search." }, "v1.AdhocDocketSearchRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name", "description": "The name to search dockets for." }, "options": { "items": { "$ref": "#/components/schemas/DocketSearchOptions" }, "type": "array", "minItems": 1, "title": "Options", "description": "Options controlling which types of docket searches to run. Defaults to both civil litigations and bankruptcy. Use ['Order.Litigations'] for civil dockets only, or ['Order.Bankruptcy'] for bankruptcy only.", "default": [ "Order.Litigations", "Order.Bankruptcy" ], "examples": [ [ "Order.Litigations" ], [ "Order.Bankruptcy" ], [ "Order.Litigations", "Order.Bankruptcy" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "AdhocDocketSearchRequest (v1)", "description": "Represents an adhoc docket search request." }, "v1.AdhocDocketSearchState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket adhoc search request" }, "name": { "type": "string", "title": "Name", "description": "The name used for the ad-hoc docket search." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the search request" } }, "type": "object", "required": [ "id", "name", "state" ], "title": "AdhocDocketSearchState (v1)", "description": "Represents a docket adhoc search state." }, "v1.AdhocLiensSearchRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name", "description": "The name to search liens for." }, "search_states": { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "Search States", "description": "The states to search for liens in." } }, "additionalProperties": false, "type": "object", "required": [ "name", "search_states" ], "title": "AdhocLiensSearchRequest (v1)", "description": "Body for ``POST /lien_searches/adhoc``" }, "v1.AdhocLiensSearchState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the liens adhoc search request" }, "name": { "type": "string", "title": "Name", "description": "The name used for the ad-hoc liens search." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the liens search request." }, "searched_states": { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "States Specified for Liens Search", "description": "Indicates the list of states specified in the liens search request.", "examples": [ [ "CA", "GA" ] ] }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ] } }, "type": "object", "required": [ "id", "name", "state", "searched_states", "last_updated_at" ], "title": "AdhocLiensSearchState (v1)", "description": "Represents a liens adhoc search state." }, "v1.AutocompleteHighlight": { "properties": { "field": { "type": "string", "title": "Field", "description": "The document field the snippets were matched in.", "examples": [ "normalized_names" ] }, "snippets": { "items": { "type": "string" }, "type": "array", "title": "Snippets", "description": "Matched values with ```` tags around the matched tokens, one snippet per matched value.", "examples": [ [ "apple computer inc" ] ] } }, "type": "object", "required": [ "field" ], "title": "AutocompleteHighlight (v1)", "description": "Highlighted match snippets for one matched field of a suggestion." }, "v1.AutocompleteResponse": { "properties": { "query": { "type": "string", "title": "Query", "description": "The query the suggestions were generated for.", "examples": [ "apple" ] }, "suggestions": { "items": { "$ref": "#/components/schemas/v1.AutocompleteSuggestion" }, "type": "array", "title": "Suggestions", "description": "Suggestions ordered by relevance, best first." } }, "type": "object", "required": [ "query" ], "title": "AutocompleteResponse (v1)", "description": "Response for GET /autocomplete." }, "v1.AutocompleteSessionRequest": { "properties": { "scope": { "anyOf": [ { "$ref": "#/components/schemas/AutocompleteSessionScopeRequest" }, { "type": "null" } ], "description": "Narrows what the session may search, so a leaked session can do no more than this. Left out, everything the caller may search." } }, "additionalProperties": false, "type": "object", "title": "AutocompleteSessionRequest (v1)", "description": "What a caller asks of a new session; the body is optional." }, "v1.AutocompleteSuggestion": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The domicile root registration id of the suggested business family. Resolves to an SOSRegistration.", "examples": [ "b3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d" ] }, "entity_type": { "$ref": "#/components/schemas/AutocompleteEntityType", "description": "The type of entity this suggestion refers to.", "examples": [ "business" ] }, "name": { "type": "string", "title": "Name", "description": "The business name closest to the query, in normalized form.", "examples": [ "apple computer inc" ] }, "states": { "items": { "type": "string" }, "type": "array", "title": "States", "description": "States where the business holds registrations.", "examples": [ [ "CA", "DE" ] ] }, "registration_count": { "type": "integer", "title": "Registration Count", "description": "Number of registrations in the business's family.", "examples": [ 12 ] }, "score": { "type": "number", "title": "Score", "description": "Jaro-Winkler similarity between the normalized query and the matched name (0.0–1.0).", "examples": [ 0.96 ] }, "highlights": { "items": { "$ref": "#/components/schemas/v1.AutocompleteHighlight" }, "type": "array", "title": "Highlights", "description": "Matched fields with highlighted snippets." } }, "type": "object", "required": [ "id", "entity_type", "name", "registration_count", "score" ], "title": "AutocompleteSuggestion (v1)", "description": "A single autocomplete suggestion." }, "v1.BusinessDocketSearchRequest": { "properties": { "type": { "type": "string", "const": "Business", "title": "Type", "default": "Business" }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "ID of the business to search for." }, "options": { "items": { "$ref": "#/components/schemas/DocketSearchOptions" }, "type": "array", "minItems": 1, "title": "Options", "description": "Options controlling which types of docket searches to run. Defaults to both civil litigations and bankruptcy. Use ['Order.Litigations'] for civil dockets only, or ['Order.Bankruptcy'] for bankruptcy only.", "default": [ "Order.Litigations", "Order.Bankruptcy" ], "examples": [ [ "Order.Litigations" ], [ "Order.Bankruptcy" ], [ "Order.Litigations", "Order.Bankruptcy" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "business_id" ], "title": "BusinessDocketSearchRequest (v1)", "description": "Represents a docket business search request." }, "v1.BusinessLiensSearchRequest": { "properties": { "type": { "type": "string", "const": "Business", "title": "Type", "default": "Business" }, "business_id": { "type": "string", "format": "uuid", "title": "Business Id", "description": "The ID of the business the liens search task should be run against. Mutually exclusive with person_id." }, "search_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "Override States for Liens Search", "description": "This is required for individual searches. For business searches, specifies an override list of states for the liens search. If provided, the search will exclusively target liens within these states, irrespective of the business's registered states." }, { "type": "null", "title": "Search for liens only in domestic state", "description": "When set to `null`, the liens search will exclusively target the domestic state of the business for business searches. This is not supported for individual searches. A domestic state refers to the state within which the business has filed its articles of incorporation, and is recognized as its home state for legal and tax purposes. This is in contrast to any other states where the business might operate but is considered a foreign entity. \n\n\nThe search, therefore, focuses on liens within this domestic jurisdiction, aligning with the legal recognition and operational base of the business." } ], "title": "Search States" } }, "additionalProperties": false, "type": "object", "required": [ "business_id" ], "title": "BusinessLiensSearchRequest (v1)", "description": "Represents a request to initiate a liens search for a business." }, "v1.BusinessSearchBatchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the business search batch." }, "name": { "type": "string", "title": "Name", "description": "The name of the business search batch." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the business search batch." }, "progress": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Progress", "description": "Processing progress from 0.0 to 1.0. Null if not yet started.", "examples": [ 0.0, 0.45, 1.0 ] }, "completed_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Completed Count", "description": "Number of rows that have been processed. Null if not yet started." }, "total_count": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Total Count", "description": "Total number of rows to process. Null if not yet started." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The datetime the business search batch was created." }, "options": { "items": { "type": "string", "enum": [ "Order.WebsiteAnalysis", "Order.NaicsPrediction", "Order.Pep", "Order.Enhanced" ], "title": "BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features to enable during business search execution.", "default": [], "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [] }, "export_csv_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Csv Uri", "description": "GCS URI for the pre-computed CSV export. Available after batch completion." }, "export_jsonl_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Export Jsonl Uri", "description": "GCS URI for the pre-computed JSONL export. Available after batch completion." }, "report_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Report Version", "description": "Report schema version. Available after batch completion." }, "exports_generated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Exports Generated At", "description": "When the export artifacts above were generated. Null until the batch first exports. This moves forward whenever the exports are regenerated because late TIN verdicts changed the results, so compare it against the value you last downloaded to tell whether your copy is current." }, "tin_matching_pending_count": { "type": "integer", "minimum": 0, "title": "Tin Matching Pending Count", "description": "How many of this batch's searches have concluded still awaiting a TIN verification verdict from the IRS AND will be retried to get one. A positive count means the exports are provisional: those rows report a pending TIN status today, and the files and report will be regenerated once the verdicts land. Zero means nothing is left to retry, so the exports will not change again on their own — it does NOT mean every TIN was verified. Rows whose retries ran out, or whose program has TIN-match retries switched off, leave this count without an answer; `tin_matching_unresolved_count` reports those. A search that is still running is in neither count, because its TIN match has not been attempted to a conclusion yet — so on a batch that has not reached `COMPLETED`, both counts can read zero with verifications still to come.", "default": 0, "examples": [ 0, 12 ] }, "tin_matching_unresolved_count": { "type": "integer", "minimum": 0, "title": "Tin Matching Unresolved Count", "description": "How many of this batch's searches supplied a TIN, finished without a verification verdict, and will not be retried for one — the retry attempts were used up, the program has TIN-match retries switched off, the search was cancelled, or it was made against a sandbox application. These rows are final at a non-matched status: waiting longer will not change them, and re-submitting the search is the only way to try again. Counted alongside `tin_matching_pending_count` rather than folded into it, because a batch can settle (pending zero) with unresolved rows still in it. A search that has not finished is in neither count — nothing has been given up on yet — so both reading zero on a batch that is still running does not mean every TIN was verified.", "default": 0, "examples": [ 0, 3 ] }, "questionnaire": { "anyOf": [ { "$ref": "#/components/schemas/DataTestQuestionnaire" }, { "type": "null" } ], "description": "Data-test questionnaire answers submitted with the batch, if any." } }, "type": "object", "required": [ "id", "name", "state", "created_at" ], "title": "BusinessSearchBatchResponse (v1)", "description": "Represents a batch business search response.\n\nFor real-time progress updates during batch processing, subscribe to SSE events\non the /events endpoint and listen for SearchBatch.progress events.\n\nA batch's export artifacts are a point-in-time snapshot, stamped with\n``exports_generated_at``. Some TIN (EIN) verifications are still resolving\nagainst the IRS when that snapshot is taken, so a batch can finish with\nverdicts still outstanding — ``tin_matching_pending_count`` says how many.\nWhile that count is positive the exports are provisional: as each verdict\nlands the batch's files and report are regenerated in place, and\n``exports_generated_at`` moves forward. Subscribe to\n``SearchBatch.exports_refreshed`` on the /events endpoint, or the\n``SearchBatch.updated`` webhook, to be told when a regeneration lands rather\nthan polling for it.\n\nOnce ``tin_matching_pending_count`` reaches zero the exports have settled —\nbut that is a statement about the retrying, not about the verdicts. A search\ncan run out of retry attempts, or belong to a program that has TIN-match\nretries switched off, and it then leaves the pending count without ever\ngetting an answer. ``tin_matching_unresolved_count`` is how many such rows\nthe batch ended up with: they report a non-final TIN status in the exports\nand will not change again.\n\nNeither count includes a search that is still running, because such a row has\nnot attempted its TIN match to a conclusion yet. Both counts at zero\ntherefore means only \"nothing is awaiting a retry and nothing has been given\nup on\" — read together with ``state``, it means every TIN was verified on a\n``COMPLETED`` batch, and nothing more than \"no verdict has been missed yet\"\non one that is still ``PENDING`` or ``EXECUTING``." }, "v1.BusinessSearchBusinessResponse": { "properties": { "search": { "$ref": "#/components/schemas/v1.BusinessSearchResponse" }, "business": { "anyOf": [ { "$ref": "#/components/schemas/v1.BusinessResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "search", "business" ], "title": "BusinessSearchBusinessResponse (v1)", "description": "Represents a business search business response." }, "v1.BusinessSearchDocketSearchRequest": { "properties": { "type": { "type": "string", "const": "BusinessSearch", "title": "Type", "default": "BusinessSearch" }, "business_search_id": { "type": "string", "format": "uuid", "title": "Business Search Id", "description": "The ID of the completed business search the docket search task should be run against." }, "options": { "items": { "$ref": "#/components/schemas/DocketSearchOptions" }, "type": "array", "minItems": 1, "title": "Options", "description": "Options controlling which types of docket searches to run. Defaults to both civil litigations and bankruptcy. Use ['Order.Litigations'] for civil dockets only, or ['Order.Bankruptcy'] for bankruptcy only.", "default": [ "Order.Litigations", "Order.Bankruptcy" ], "examples": [ [ "Order.Litigations" ], [ "Order.Bankruptcy" ], [ "Order.Litigations", "Order.Bankruptcy" ] ] }, "additional_search_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.AdditionalDocketSearchEntityRequest" }, "type": "array" }, { "type": "null" } ], "title": "Additional Search Entities", "description": "A list of additional entities to be searched along with the business search in the docket search.", "examples": [ [ { "name": "John Doe", "type": "Person" } ], [ { "name": "Alt Name LLC", "type": "Business" } ] ] } }, "additionalProperties": false, "type": "object", "required": [ "business_search_id" ], "title": "BusinessSearchDocketSearchRequest (v1)", "description": "Represents a business search docket search request" }, "v1.BusinessSearchLiensSearchRequest": { "properties": { "type": { "type": "string", "const": "BusinessSearch", "title": "Type", "default": "BusinessSearch" }, "business_search_id": { "type": "string", "format": "uuid", "title": "Business Search Id", "description": "The ID of the business search the liens search task should be run against." }, "search_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "Override States for Liens Search", "description": "If provided, the search will exclusively target liens within these states, irrespective of the resolved business's registered states." }, { "type": "null", "title": "Search for liens only in domestic state", "description": "When set to `null`, the liens search will exclusively target the domestic state of the resolved business for business searches. " } ], "title": "Search States" }, "additional_search_entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.AdditionalLiensSearchEntityRequest" }, "type": "array" }, { "type": "null" } ], "title": "Additional Search Entities", "description": "A list of additional entities to be searched along with the business search in the liens search.", "examples": [ [ { "name": "John Doe", "search_states": [ "CA" ], "type": "Person" } ], [ { "name": "Alt Name LLC", "search_states": [ "NY", "CA" ], "type": "Business" } ] ] } }, "additionalProperties": false, "type": "object", "required": [ "business_search_id" ], "title": "BusinessSearchLiensSearchRequest (v1)", "description": "Represents a request to initiate a liens search for a business search." }, "v1.BusinessSearchRequest": { "properties": { "name": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Name", "description": "The name of the business to search for.", "examples": [ "White, Floyd and Cook" ] }, "address": { "type": "string", "maxLength": 500, "minLength": 2, "title": "Address", "description": "The address of the business to search for.", "examples": [ "155 Carla Circles Jordanfurt, OK 59066" ] }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names to include in the search.", "examples": [ [ "Nathan Harrington", "Alexander Wolfe" ] ] }, "website": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Website", "description": "The website to include in the search.", "examples": [ "https://www.figueroa.com/" ] }, "phone_number": { "anyOf": [ { "type": "string", "maxLength": 24 }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number to include in the search.", "examples": [ "436-502-9710" ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Email", "description": "The email to include in the search.", "examples": [ "zacharymoore@example.com" ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names to include in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "tin": { "anyOf": [ { "type": "string", "maxLength": 9, "minLength": 9 }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN to search for.", "examples": [ "732842774" ] }, "options": { "items": { "$ref": "#/components/schemas/BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features to enable during search execution.", "default": [], "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ] }, "business_token": { "type": "null", "title": "Business Token", "description": "Leave out; see the business-token form." } }, "additionalProperties": false, "type": "object", "required": [ "name", "address" ], "title": "Name and address (v1)", "description": "Search for a business by its name and address.\n\nSend the business's legal name and address, plus any optional details you\nhold. To search for a business an autocomplete suggestion names, send its\n`business_token` instead, in the business-token form." }, "v1.BusinessSearchStatusResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the business search." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the business search.", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Business Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "business_url": { "anyOf": [ { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Business Url", "description": "The API URL to retrieve the business details.", "examples": [ "https://api.baselayer.com/businesses/ae752082-1f7e-11ef-b572-1edb1b067314" ] }, "console_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Console Url", "description": "The URL to the business search details in the console.", "examples": [ "https://console.baselayer.com/search/c06777fe-1f7e-11ef-af7e-1edb1b067314" ] } }, "type": "object", "required": [ "id", "state", "console_url" ], "title": "BusinessSearchStatusResponse (v1)", "description": "Represents a business search status response." }, "v1.ConsortiumCheckAddress": { "properties": { "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street", "description": "Street line of the address.", "examples": [ "123 Main St" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City of the address.", "examples": [ "Springfield" ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation" }, { "type": "null" } ], "description": "State of the address.", "examples": [ "IL" ] }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip", "description": "ZIP code of the address.", "examples": [ "62704" ] } }, "additionalProperties": false, "type": "object", "title": "ConsortiumCheckAddress (v1)" }, "v1.ConsortiumCheckBatchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The batch's id, used to poll status and fetch results." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "Processing state of the batch." }, "progress": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Progress", "description": "Fraction of entries processed so far, in [0, 1].", "examples": [ 0.0, 0.5, 1.0 ] }, "completed_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completed Count", "description": "Number of entries processed so far.", "examples": [ 0, 50 ] }, "total_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Count", "description": "Total number of entries in the batch.", "examples": [ 100 ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the batch was accepted." } }, "type": "object", "required": [ "id", "state", "created_at" ], "title": "ConsortiumCheckBatchResponse (v1)", "description": "Returned when a batch is accepted and by the polling endpoint." }, "v1.ConsortiumCheckOfficerName": { "properties": { "first_name": { "type": "string", "title": "First Name", "description": "The officer's first name.", "examples": [ "Jane" ] }, "last_name": { "type": "string", "title": "Last Name", "description": "The officer's last name.", "examples": [ "Doe" ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation" }, { "type": "null" } ], "description": "State to scope the officer search to, if supplied.", "examples": [ "CA" ] } }, "additionalProperties": false, "type": "object", "required": [ "first_name", "last_name" ], "title": "ConsortiumCheckOfficerName (v1)" }, "v1.ConsortiumCheckRequest": { "properties": { "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The business's 9-digit EIN/tax id.", "examples": [ "12-3456789" ] }, "phones": { "items": { "type": "string" }, "type": "array", "title": "Phones", "description": "Business or owner phone numbers.", "examples": [ [ "+14155551234" ] ] }, "emails": { "items": { "type": "string" }, "type": "array", "title": "Emails", "description": "Business or owner email addresses.", "examples": [ [ "ap@acme.com" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The business's website.", "examples": [ "https://acme.com" ] }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Name", "description": "The business's legal or trade name.", "examples": [ "Acme Corp" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "An Osiris business id to match exclusions linked to it.", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "officers": { "items": { "$ref": "#/components/schemas/v1.ConsortiumCheckOfficerName" }, "type": "array", "title": "Officers", "description": "Officer/owner names to match." }, "address": { "anyOf": [ { "$ref": "#/components/schemas/v1.ConsortiumCheckAddress" }, { "type": "null" } ], "description": "The business's street address." } }, "additionalProperties": false, "type": "object", "title": "ConsortiumCheckRequest (v1)", "description": "Strict JSON body for the standalone consortium check endpoint." }, "v1.ConsortiumCheckResult": { "properties": { "matches": { "items": { "$ref": "#/components/schemas/v1.ConsortiumMatch" }, "type": "array", "title": "Matches", "description": "The matched consortium exclusion records, strongest first." }, "total_matches": { "type": "integer", "title": "Total Matches", "description": "The number of distinct exclusion records matched.", "examples": [ 0, 1, 2 ] } }, "type": "object", "required": [ "total_matches" ], "title": "ConsortiumCheckResult (v1)", "description": "Response for a standalone consortium check.\n\nMirrors the OFAC / PEP adhoc search envelope (``matches`` + ``total_matches``);\nonly the per-match shape (``ConsortiumMatch``) is consortium-specific. A\nno-match — including the unsupported name-only case — is simply an empty\n``matches`` with ``total_matches == 0``." }, "v1.ConsortiumMatch": { "properties": { "exclusion_id": { "type": "string", "format": "uuid", "title": "Exclusion Id", "description": "Identifier of the matched consortium exclusion record.", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "reported_on": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Reported On", "description": "Date the matching exclusion was submitted to the consortium.", "examples": [ "2023-08-01" ] }, "business_name": { "type": "string", "title": "Business Name", "description": "Legal name of the excluded business.", "examples": [ "Acme Corp" ] }, "doing_business_as": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doing Business As", "description": "Trade name the business operates under, if different.", "examples": [ "Acme" ] }, "business_address": { "type": "string", "title": "Business Address", "description": "Business address as reported with the exclusion.", "examples": [ "500 Market St, San Francisco, CA 94105" ] }, "entity_type": { "anyOf": [ { "$ref": "#/components/schemas/EntityType" }, { "type": "null" } ], "description": "Legal structure of the business, if reported.", "examples": [ "LLC" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "The business's 9-digit EIN/tax id.", "examples": [ "123456789" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Contact email reported with the exclusion.", "examples": [ "ap@acme.com" ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "Business website reported with the exclusion.", "examples": [ "https://acme.com" ] }, "primary_owner": { "$ref": "#/components/schemas/v1.ExclusionOwnerDetail", "description": "The primary owner reported on the exclusion." }, "secondary_owner": { "anyOf": [ { "$ref": "#/components/schemas/v1.ExclusionOwnerDetail" }, { "type": "null" } ], "description": "The secondary owner, present only when one was reported." }, "product_type": { "$ref": "#/components/schemas/ProductType", "description": "The product the defaulted/closed account was for.", "examples": [ "WC" ] }, "application_channel": { "anyOf": [ { "$ref": "#/components/schemas/ApplicationChannel" }, { "type": "null" } ], "description": "Channel the application came through, if reported.", "examples": [ "BR" ] }, "application_channel_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Channel Name", "description": "Free-text name of the application channel, if reported.", "examples": [ "partner-referral" ] }, "application_ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Ip Address", "description": "IP address recorded at application time, if reported.", "examples": [ "203.0.113.42" ] }, "application_date": { "type": "string", "format": "date", "title": "Application Date", "description": "Date the original application was submitted.", "examples": [ "2023-01-15" ] }, "opened_on": { "type": "string", "format": "date", "title": "Opened On", "description": "Date the account was opened.", "examples": [ "2023-02-01" ] }, "closed_on": { "type": "string", "format": "date", "title": "Closed On", "description": "Date the account was closed.", "examples": [ "2023-07-30" ] }, "matures_on": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Matures On", "description": "Maturity date of the account, if applicable.", "examples": [ "2026-02-01" ] }, "closure_status": { "$ref": "#/components/schemas/ClosureStatus", "description": "Status of the account at closure.", "examples": [ "WO" ] }, "closure_reason": { "$ref": "#/components/schemas/ClosureReason", "description": "Specific cause of closure.", "examples": [ "WPF" ] }, "first_payment_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "First Payment Default", "description": "Whether the borrower defaulted on the first payment.", "examples": [ true ] }, "term_in_months": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Term In Months", "description": "Term of the account in months, if applicable.", "examples": [ 36 ] }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Amount", "description": "Original principal/funded amount.", "examples": [ 50000.0 ] }, "charge_off_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Charge Off Amount", "description": "Amount charged off at closure, if any.", "examples": [ 42500.0 ] }, "payment_frequency": { "anyOf": [ { "$ref": "#/components/schemas/PaymentFrequency" }, { "type": "null" } ], "description": "Repayment frequency of the account, if reported.", "examples": [ "MY" ] }, "score": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Score", "description": "Match score in [0, 1] — the strongest signal on this record. New matches score 1.0 when an identifier matches or a name matches exactly after normalization. Only business names have trailing corporate suffixes stripped; officer names retain their full name. This is not a probability of entity identity. Historical records may retain fractional scores. Matches are returned sorted by identifier-before-name, then by this score." }, "matched_on": { "items": { "$ref": "#/components/schemas/v1.ConsortiumMatchedField" }, "type": "array", "minItems": 1, "title": "Matched On", "description": "The input identifiers that matched this record." } }, "type": "object", "required": [ "exclusion_id", "business_name", "business_address", "primary_owner", "product_type", "application_date", "opened_on", "closed_on", "closure_status", "closure_reason", "score", "matched_on" ], "title": "ConsortiumMatch (v1)", "description": "One matched consortium exclusion record, with the identifiers that hit it.\n\nExtends :class:`ExclusionMatchDetail`, so the entire anonymized fraud\npayload — business, owners, and loan/closure facts — is flat on the match\n(mirroring ``OFACMatch`` / ``PEPMatch``). A record matched via several\ninputs (e.g. EIN *and* phone) is still a single match; each contributing\ninput is listed in ``matched_on``." }, "v1.ConsortiumMatchedField": { "properties": { "type": { "$ref": "#/components/schemas/v1.ConsortiumMatchType", "description": "The identifier pass that produced the match.", "examples": [ "TIN" ] }, "value": { "type": "string", "title": "Value", "description": "The caller's input that matched this record — structured identifiers in normalized form (phone as E.164, EIN as 9 digits), and the website as the URL supplied. A website matches on its page (host, path and query, ignoring `www.`, the fragment and tracking parameters); an email address matches as a whole.", "examples": [ "123456789" ] } }, "type": "object", "required": [ "type", "value" ], "title": "ConsortiumMatchedField (v1)", "description": "One input identifier that matched an exclusion record." }, "v1.CreateCriminalCheckRequest": { "properties": { "check_type": { "$ref": "#/components/schemas/CriminalCheckType", "examples": [ "instant_criminal" ] }, "first_name": { "type": "string", "minLength": 2, "title": "First Name", "description": "The first name of the person", "examples": [ "John", "Jane" ] }, "last_name": { "type": "string", "minLength": 2, "title": "Last Name", "description": "The last name of the person", "examples": [ "Smith", "Doe" ] }, "date_of_birth": { "type": "string", "format": "date", "title": "Date Of Birth", "description": "The date of birth of the person. Cannot be in the future.", "examples": [ "1990-01-15" ] }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "The middle name of the person", "examples": [ "Mary Louise" ] }, "ssn": { "type": "string", "maxLength": 11, "minLength": 9, "pattern": "^\\d{3}-?\\d{2}-?\\d{4}$", "title": "Ssn", "description": "The social security number of the person", "examples": [ "123-45-6789" ] }, "phone_number": { "anyOf": [ { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, { "type": "null" } ], "title": "Phone Number", "description": "Phone number in E.164 format (US numbers start with +1).", "examples": [ "+14155552671" ] }, "primary_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Address", "description": "The primary address to search for criminal records", "examples": [ "123 Main St, Springfield, IL 62704" ] }, "additional_addresses": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Additional Addresses", "description": "A list of additional addresses to search", "examples": [ [ "456 Test Blvd, Anytown, GA 44556", "456 Oak Ave, Chicago, IL 60601" ] ] }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 64, "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the request. Limited to alphanumeric characters and hyphens.", "examples": [ "Check1234" ] }, "source_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array" }, { "type": "null" } ], "title": "Source States", "description": "A list of states criminal records must originate from. When supplied, records are filtered to the specified states only. Records without a source state are always included.", "examples": [ [ "CA", "IL" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "check_type", "first_name", "last_name", "date_of_birth", "ssn" ], "title": "CreateCriminalCheckRequest (v1)", "description": "Create a criminal check request." }, "v1.CreateOnboardingSessionRequest": { "properties": { "template_id": { "type": "string", "format": "uuid", "title": "Template Id", "description": "ID of the customer journey to run, as built and published in Console; it is the last part of the journey's Console URL. The session runs the latest published version, and a journey that was never published is rejected." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Your own identifier for the applicant or application, returned on the session, its results and its webhooks." } }, "additionalProperties": false, "type": "object", "required": [ "template_id" ], "title": "CreateOnboardingSessionRequest (v1)", "description": "Request to start an onboarding session for one applicant.\n\nCall it from your server; the applicant completes the flow at the\nreturned ``embed_url``." }, "v1.CreateOnboardingSessionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Onboarding session id. Use it to fetch results and to match `OnboardingSession` webhooks." }, "session_token": { "type": "string", "title": "Session Token", "description": "Secret token that lets the applicant's browser drive this session. Returned only once and already embedded in `embed_url`; treat it as a credential." }, "embed_url": { "type": "string", "title": "Embed Url", "description": "URL of the hosted flow for this session. Open it for the applicant or load it in an iframe." }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At", "description": "When `session_token`, and so `embed_url`, stops working." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." } }, "type": "object", "required": [ "id", "session_token", "embed_url", "expires_at" ], "title": "CreateOnboardingSessionResponse (v1)", "description": "A newly started onboarding session and the link the applicant opens." }, "v1.CreatePersonRequest": { "properties": { "first_name": { "type": "string", "maxLength": 255, "minLength": 2, "title": "First Name", "description": "The first name of the person", "examples": [ "John", "Jane" ] }, "last_name": { "type": "string", "maxLength": 255, "minLength": 2, "title": "Last Name", "description": "The last name of the person", "examples": [ "Doe", "Smith" ] }, "middle_name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Middle Name", "description": "The middle name of the person", "examples": [ "Michael", "James", "T" ] }, "phone_number": { "anyOf": [ { "type": "string", "maxLength": 30, "minLength": 12, "pattern": "^\\+(?:[1-9]\\d{0,2})(?:[ -]?\\d{1,4}){1,4}(?:\\s?(?:x|ext\\.?)\\s?\\d{1,10})?$" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number of the person. Area code is mandatory.", "examples": [ "+14013059855", "+1 707 456 7890 x784", "+44 207-183-8750 ext. 784" ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 5, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" }, { "type": "null" } ], "title": "Email", "description": "The email address of the person", "examples": [ "john.doe@example.com", "jane.smith@example.com" ] }, "date_of_birth": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date Of Birth", "description": "The date of birth of the person", "examples": [ "1990-01-15" ] }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/Gender" }, { "type": "null" } ], "description": "The gender of the person", "examples": [ "M", "F" ] }, "ssn": { "anyOf": [ { "type": "string", "maxLength": 9, "minLength": 9, "description": "The full social security number of the person", "examples": [ "123456789", "123-45-6789" ] }, { "type": "string", "maxLength": 4, "minLength": 4, "description": "The last four digits of the social security number of the person", "examples": [ "1234" ] } ], "title": "Ssn" }, "marital_status": { "anyOf": [ { "$ref": "#/components/schemas/MaritalStatus" }, { "type": "null" } ], "description": "The marital status of the person", "examples": [ "married", "single" ] }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suffix", "description": "The suffix of the person", "examples": [ "Jr.", "Sr." ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the person", "examples": [ "Mr.", "Mrs." ] } }, "additionalProperties": false, "type": "object", "required": [ "first_name", "last_name", "ssn" ], "title": "CreatePersonRequest (v1)" }, "v1.CriminalChargeResponse": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the charge, as reported on the record.", "examples": [ "SHOPLIFTING" ] }, "offense_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Offense Date", "description": "The date of the offense. When present, may be a partial date. offense_date_precision will always be present when offense_date is present.", "examples": [ "2025-01-01" ] }, "offense_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date of the offense.", "examples": [ "ONLY_YEAR", "ONLY_MONTH", "ONLY_DAY", "FULL" ] }, "legal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Code", "description": "The legal code of the charge.", "examples": [ "433.234" ] }, "type": { "anyOf": [ { "$ref": "#/components/schemas/ChargeType" }, { "type": "null" } ], "description": "The type of the charge.", "examples": [ "felony", "misdemeanor", "petty_offense", "unknown" ] }, "category": { "anyOf": [ { "$ref": "#/components/schemas/ChargeCategory" }, { "type": "null" } ], "description": "The category of the charge.", "examples": [ "Criminal Intent", "Drugs & Alcohol", "Fraud & Deception", "Homicide", "Security", "Sexual", "Statutory", "Theft & Property", "Vehicles & Traffic", "Violence", "unclassified" ] }, "subcategory": { "anyOf": [ { "$ref": "#/components/schemas/ChargeSubcategory" }, { "type": "null" } ], "description": "The subcategory of the charge.", "examples": [ "Accessory", "Conspiracy", "Court Orders", "Criminal Tools", "Obstruction", "Organized Crime", "Alcohol & Tobacco", "Driving under the Influence (DUI)", "Drugs-Marijuana Possession/Use", "Drugs-Possession/Use", "Drugs-Sale & Manufacture", "Bribery & Corruption", "Business & Tax", "Cyber Crimes", "Embezzlement", "Forgery", "Fraud", "Identity Theft & Impersonation", "Worthless Check", "Attempted Homicide", "Intentional Homicide", "Unintentional Killing", "Immigration", "Terrorism", "Treason", "Lewd Behavior", "Prostitution", "Sexual Abuse", "Animal Ordinances", "Custody & Support", "Fish & Game", "Gambling", "Miscellaneous Citations & Violations", "Public Nuisance", "Safety & Zoning", "Arson", "Burglary", "Petty Theft", "Possession of Stolen Property", "Robbery", "Theft", "Trespassing", "Vandalism & Mischief", "License & Registration", "Parking", "Speeding", "Unsafe Operation", "Vehicle Equipment", "Abduction & Restraint", "Animal Cruelty", "Assault & Battery", "Child & Elder Abuse", "Disorderly Behavior", "Harassment & Threats", "Weapons & Endangerment", "unclassified" ] }, "subsubcategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subsubcategory", "description": "The subsubcategory of the charge.", "examples": [ "SHOPLIFTING" ] }, "record_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Record Date", "description": "The date the charge was recorded. When present, may be a partial date. record_date_precision will always be present when record_date is present.", "examples": [ "2025-01-01" ] }, "record_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date the charge was recorded.", "examples": [ "ONLY_YEAR", "ONLY_MONTH", "ONLY_DAY", "FULL" ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "The city of the charge.", "examples": [ "Indian Hills" ] }, "county": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "County", "description": "The county of the charge.", "examples": [ "Jefferson" ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation" }, { "type": "null" } ], "description": "The state of the charge.", "examples": [ "CA" ] }, "sentences": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.SentenceResponse" }, "type": "array" }, { "type": "null" } ], "title": "Sentences", "description": "A list of sentences associated with the charge." }, "dispositions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.DispositionResponse" }, "type": "array" }, { "type": "null" } ], "title": "Dispositions", "description": "A list of dispositions associated with the charge." } }, "type": "object", "title": "CriminalChargeResponse (v1)" }, "v1.CriminalCheckAddressResponse": { "properties": { "street": { "type": "string", "title": "Street", "description": "Street name of the address.", "examples": [ "913 Hendrix Gardens Suite 492" ] }, "city": { "type": "string", "title": "City", "description": "City name of the address.", "examples": [ "Jasonfurt" ] }, "state": { "$ref": "#/components/schemas/StateAbbreviation", "description": "State 2 letter abbreviation of the address.", "examples": [ "VA" ] }, "zip": { "type": "string", "title": "Zip", "description": "Zip code of the address.", "examples": [ "19773" ] } }, "type": "object", "required": [ "street", "city", "state", "zip" ], "title": "CriminalCheckAddressResponse (v1)" }, "v1.CriminalCheckResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the criminal check.", "examples": [ "d8e260ba-9fa4-4182-93a8-d0fa398aeb72" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the criminal check was created.", "examples": [ "2026-10-29T05:44:48.143819" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The date and time when the criminal check was last updated.", "examples": [ "2026-10-29T05:44:48.143837" ] }, "first_name": { "type": "string", "title": "First Name", "description": "The first name of the person.", "examples": [ "John" ] }, "last_name": { "type": "string", "title": "Last Name", "description": "The last name of the person.", "examples": [ "Smith" ] }, "date_of_birth": { "type": "string", "format": "date", "title": "Date Of Birth", "description": "The date of birth of the person.", "examples": [ "1990-01-15" ] }, "ssn": { "type": "string", "title": "Ssn", "description": "The social security number of the person, masked up to the final four digits", "examples": [ "XXXXX1234" ] }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "The middle name of the person.", "examples": [ "Mary Louise" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number of the person in E.164 format.", "examples": [ "+14155552671" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email address of the person.", "examples": [ "john.doe@example.com" ] }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.CriminalCheckAddressResponse" }, { "type": "null" } ], "description": "The primary address of the person.", "examples": [ { "city": "Anytown", "state": "CA", "street": "123 Main St", "zip": "12345" } ] }, "additional_addresses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.CriminalCheckAddressResponse" }, "type": "array" }, { "type": "null" } ], "title": "Additional Addresses", "description": "A list of additional addresses of the person.", "examples": [ [ { "city": "Anytown", "state": "CA", "street": "456 Test Blvd", "zip": "12345" } ] ] }, "check_type": { "$ref": "#/components/schemas/CriminalCheckType", "description": "The type of criminal check that was run.", "examples": [ "instant_criminal" ] }, "results": { "items": { "$ref": "#/components/schemas/v1.CriminalRecordResponse" }, "type": "array", "title": "Results", "description": "Array of criminal records; empty when none are found." }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Reference Id", "description": "The reference ID associated with this request.", "examples": [ "Check1234" ] } }, "type": "object", "required": [ "id", "created_at", "first_name", "last_name", "date_of_birth", "ssn", "check_type", "results" ], "title": "CriminalCheckResponse (v1)" }, "v1.CriminalPersonResponse": { "properties": { "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name", "description": "The first name of the person.", "examples": [ "John" ] }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "Middle initial, name, or names.", "examples": [ "W" ] }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name", "description": "The last name of the person.", "examples": [ "Smith" ] }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suffix", "description": "The suffix of the person.", "examples": [ "Jr.", "Sr." ] }, "date_of_birth": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date Of Birth", "description": "The date of birth of the person. When present, may be a partial date. date_precision will always be present when date_of_birth is present.", "examples": [ "1990-01-15", "0001-05-15" ] }, "date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date of birth of the person.", "examples": [ "ONLY_YEAR", "ONLY_MONTH", "ONLY_DAY", "FULL" ] }, "inferred_date_of_birth": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Inferred Date Of Birth", "description": "A date of birth inferred from other similar records, when available. When present, will always be a full date and therefore has no accompanying date_precision field.", "examples": [ "1990-01-15" ] }, "doc_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Doc Number", "description": "Dept. of Corrections number." }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/Gender" }, { "type": "null" } ], "description": "The gender of the person.", "examples": [ "M" ] }, "height": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Height", "description": "The height of the person.", "examples": [ "601" ] }, "weight": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Weight", "description": "The weight of the person.", "examples": [ "180" ] }, "hair_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hair Color", "description": "The hair color of the person.", "examples": [ "BRN" ] }, "eye_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eye Color", "description": "The eye color of the person.", "examples": [ "HAZ" ] }, "skin_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Skin Color", "description": "The skin color of the person.", "examples": [ "wht" ] }, "race": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Race", "description": "The race of the person.", "examples": [ "W" ] }, "ethnicity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ethnicity", "description": "The ethnicity of the person.", "examples": [ "Hispanic-American" ] }, "physical_build": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physical Build", "description": "The physical build of the person.", "examples": [ "BROAD" ] }, "physical_marks": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physical Marks", "description": "The physical marks of the person.", "examples": [ "blue cross on outside left ankle" ] }, "photo_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Photo Urls", "description": "A list of photo URLs associated with the person." }, "name_aliases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Name Aliases", "description": "A list of name aliases associated with the person.", "examples": [ [ "Johnny Smith" ] ] }, "addresses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.CriminalCheckAddressResponse" }, "type": "array" }, { "type": "null" } ], "title": "Addresses", "description": "A list of addresses associated with the person.", "examples": [ [ { "city": "Anytown", "state": "CA", "street": "123 Main St", "zip": "12345" } ] ] } }, "type": "object", "title": "CriminalPersonResponse (v1)" }, "v1.CriminalRecordCaseResponse": { "properties": { "case_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Case Number", "description": "The case number assigned by the court", "examples": [ "2025-99999" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Case type as reported by the court." }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "description": "Case status as reported by the court." }, "file_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "File Date", "description": "Date the case was filed, as reported by the court. When present, may be a partial date. file_date_precision will always be present when file_date is present.", "examples": [ "2025-01-01" ] }, "file_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date the case was filed.", "examples": [ "FULL" ] }, "arresting_agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Arresting Agency", "description": "Name of the arresting agency", "examples": [ "Franklin County Sheriff" ] }, "arrest_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Arrest Date", "description": "Date of arrest. When present, may be a partial date. arrest_date_precision will always be present when arrest_date is present.", "examples": [ "2025-01-01" ] }, "arrest_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date of arrest.", "examples": [ "FULL" ] }, "court_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Name", "description": "Name of the charging court", "examples": [ "Franklin County Circuit Court" ] }, "court_county": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court County", "description": "County of the charging court", "examples": [ "Franklin" ] }, "identity_match_confidence_level": { "anyOf": [ { "$ref": "#/components/schemas/IdentityMatchConfidenceLevel" }, { "type": "null" } ], "description": "The confidence level of the identity match.", "examples": [ "high" ] }, "charges": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.CriminalChargeResponse" }, "type": "array" }, { "type": "null" } ], "title": "Charges", "description": "A list of charges associated with the case." } }, "type": "object", "title": "CriminalRecordCaseResponse (v1)" }, "v1.CriminalRecordResponse": { "properties": { "category": { "$ref": "#/components/schemas/RecordCategory", "description": "The category of the criminal record.", "examples": [ "arrest", "Criminal/traffic", "Warrant", "Sex Offender", "Patriot", "Registry", "unknown" ] }, "person": { "$ref": "#/components/schemas/v1.CriminalPersonResponse", "description": "A summary of the person associated with the criminal record", "examples": [ { "addresses": [ { "city": "Anytown", "state": "CA", "street": "123 Main St", "zip": "12345" } ], "date_of_birth": "1990-01-15", "date_precision": "FULL", "doc_number": "1234567890", "ethnicity": "Hispanic-American", "eye_color": "HAZ", "first_name": "John", "gender": "M", "hair_color": "BRN", "height": "601", "last_name": "Smith", "middle_name": "Michael", "name_aliases": [ "Mohn Jichael Smith" ], "race": "W", "weight": "180" } ] }, "source": { "$ref": "#/components/schemas/v1.CriminalRecordResultSourceResponse", "description": "The source of the criminal record." }, "cases": { "items": { "$ref": "#/components/schemas/v1.CriminalRecordCaseResponse" }, "type": "array", "title": "Cases", "description": "A list of cases associated with the criminal record." } }, "type": "object", "required": [ "category", "person", "source", "cases" ], "title": "CriminalRecordResponse (v1)" }, "v1.CriminalRecordResultSourceResponse": { "properties": { "category": { "$ref": "#/components/schemas/SourceCategory", "description": "The category of the source.", "examples": [ "arrest", "court", "criminal registry", "DOC", "warrant", "sex offender registry", "domestic watchlist", "foreign watchlist", "healthcare registry", "healthcare sanctions", "financial registry", "financial sanctions", "other registry", "other sanctions", "PEP registry", "unknown" ] }, "name": { "type": "string", "title": "Name", "description": "A human readable name of the source.", "examples": [ "KY Franklin County Inmates" ] }, "county": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "County", "description": "The name of the county from which the record originated.", "examples": [ "Franklin" ] }, "county_fips_code": { "anyOf": [ { "type": "string", "maxLength": 5, "minLength": 5 }, { "type": "null" } ], "title": "County Fips Code", "description": "5-digit county FIPS code; present for county checks.", "examples": [ "17031" ] }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "maxLength": 2, "minLength": 2 }, { "type": "null" } ], "description": "Two-letter US state code from which the record originated.", "examples": [ "CA" ] } }, "type": "object", "required": [ "category", "name" ], "title": "CriminalRecordResultSourceResponse (v1)" }, "v1.DispositionResponse": { "properties": { "disposition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposition", "description": "Disposition description as provided by the court.", "examples": [ "GLT" ] }, "disposition_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Disposition Date", "description": "Date of disposition. When present, may be a partial date. disposition_date_precision will always be present when disposition_date is present.", "examples": [ "2025-01-01" ] }, "disposition_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date of disposition.", "examples": [ "FULL" ] }, "disposition_type": { "$ref": "#/components/schemas/DispositionType", "examples": [ "Conviction", "Dismissed", "Invalid", "Merged", "Pending", "Transferred", "Warrant", "Unclassified" ] } }, "type": "object", "required": [ "disposition_type" ], "title": "DispositionResponse (v1)" }, "v1.DocketDetailResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket update request" }, "docket_id": { "type": "string", "format": "uuid", "title": "Docket Id", "description": "ID of the docket the search was performed for" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the update request" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Any errors that occurred during the docket search request." }, "docket": { "anyOf": [ { "$ref": "#/components/schemas/v1.DocketResponse" }, { "type": "null" } ], "description": "The docket associated with the update request" } }, "type": "object", "required": [ "id", "docket_id", "state" ], "title": "DocketDetailResponse (v1)", "description": "Represents a docket detail response." }, "v1.DocketDetailState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket update request" }, "docket_id": { "type": "string", "format": "uuid", "title": "Docket Id", "description": "ID of the docket the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the update request" } }, "type": "object", "required": [ "id", "docket_id", "state" ], "title": "DocketDetailState (v1)", "description": "Represents a docket detail state." }, "v1.DocketExhibitState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "ID of the docket exhibit document request" }, "docket_exhibit_id": { "type": "string", "format": "uuid", "title": "Docket Exhibit Id", "description": "ID of the docket exhibit the search was performed for" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "State of the document search request" } }, "type": "object", "required": [ "id", "docket_exhibit_id", "state" ], "title": "DocketExhibitState (v1)", "description": "Represents a docket exhibit state." }, "v1.DocketSearchState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this docket search request." }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business the search was performed for." }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person the search was performed for." }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search the docket search was performed for" }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the docket search request." } }, "type": "object", "required": [ "id", "state" ], "title": "DocketSearchState (v1)", "description": "Represents a docket search state." }, "v1.EmployeeVerificationRequest": { "properties": { "person_name": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Person Name", "description": "Full name of the person to verify." }, "business_name": { "type": "string", "maxLength": 512, "minLength": 1, "title": "Business Name", "description": "Name of the business to check against." }, "business_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Address", "description": "Business address for disambiguation." }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 10, "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names for the business (e.g., DBA names)." } }, "additionalProperties": false, "type": "object", "required": [ "person_name", "business_name" ], "title": "EmployeeVerificationRequest (v1)" }, "v1.ExclusionOwnerDetail": { "properties": { "first_name": { "type": "string", "title": "First Name", "description": "Owner's first name.", "examples": [ "Jane" ] }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "Owner's middle name, if reported.", "examples": [ "Q" ] }, "last_name": { "type": "string", "title": "Last Name", "description": "Owner's last name.", "examples": [ "Doe" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "Owner's phone number, normalized to E.164.", "examples": [ "+15551234567" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "Owner's address as reported with the exclusion.", "examples": [ "123 Main St, Springfield, IL 62704" ] } }, "type": "object", "required": [ "first_name", "last_name" ], "title": "ExclusionOwnerDetail (v1)", "description": "One owner (primary or secondary) on a matched exclusion record.\n\nBuilt from the owner columns on the exclusion row itself, which are the\nsame source the ingestion processor derives the ``ExclusionOwner`` rows\nfrom — so this is available on every record without depending on whether\nthe processor has run or eager-loaded the owner relationship." }, "v1.ExclusionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the exclusion record.", "examples": [ "49dd8b8c-ca86-42d6-9fe5-362681a22dd5" ] }, "name": { "type": "string", "title": "Name", "description": "Legal name of the business.", "examples": [ "Acme Corp" ] }, "address": { "type": "string", "title": "Address", "description": "Full business address.", "examples": [ "123 Main St, City, ST 12345" ] }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tin", "description": "Tax identification number.", "examples": [ "123456789" ] }, "product_type": { "$ref": "#/components/schemas/ProductType", "description": "Type of financial product." }, "application_date": { "type": "string", "format": "date", "title": "Application Date", "description": "Date when application was submitted.", "examples": [ "2026-07-31" ] }, "opened_on": { "type": "string", "format": "date", "title": "Opened On", "description": "Date when account was opened.", "examples": [ "2026-08-30" ] }, "closed_on": { "type": "string", "format": "date", "title": "Closed On", "description": "Date when account was closed.", "examples": [ "2026-09-29" ] }, "closure_status": { "$ref": "#/components/schemas/ClosureStatus", "description": "What happened to the money at closure." }, "closure_reason": { "$ref": "#/components/schemas/ClosureReason", "description": "Specific cause of closure." }, "owner_first_name": { "type": "string", "title": "Owner First Name", "description": "Primary owner's first name.", "examples": [ "John" ] }, "owner_last_name": { "type": "string", "title": "Owner Last Name", "description": "Primary owner's last name.", "examples": [ "Doe" ] }, "additional_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Notes", "description": "Additional notes about the exclusion.", "examples": [ "Customer filed for bankruptcy on 2023-05-15" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Date and time when the exclusion record was created.", "examples": [ "2026-10-29T05:44:48.106922" ] } }, "type": "object", "required": [ "id", "name", "address", "tin", "product_type", "application_date", "opened_on", "closed_on", "closure_status", "closure_reason", "owner_first_name", "owner_last_name", "created_at" ], "title": "ExclusionResponse (v1)", "description": "Response model for exclusion data.\n\nThis model defines the structure for exclusion-related API responses." }, "v1.InternationalBusinessSearchRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 1 }, { "type": "null" } ], "title": "Name", "description": "The name of the business to search for. Required (together with `address`) unless `filing_number` is provided.", "examples": [ "White, Floyd and Cook" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 2 }, { "type": "null" } ], "title": "Address", "description": "The address of the business to search for. Required (together with `name`) unless `filing_number` is provided.", "examples": [ "1 Parliament St, London SW1A 2JR, United Kingdom" ] }, "iso2_country_code": { "type": "string", "enum": [ "AU", "AT", "BH", "BE", "BA", "BR", "BN", "KH", "CA", "CN", "CO", "HR", "CW", "CY", "CZ", "DK", "DO", "EE", "FI", "FR", "GF", "PF", "GE", "DE", "GI", "GR", "GP", "GG", "HK", "IS", "IE", "IM", "IL", "IT", "JP", "LV", "LI", "LT", "LU", "MY", "MH", "MQ", "YT", "ME", "NL", "NC", "NZ", "NO", "OM", "PK", "PA", "PE", "PL", "PT", "QA", "RE", "RO", "RU", "BL", "PM", "WS", "SG", "SK", "SI", "SB", "ES", "SE", "CH", "TW", "TT", "UG", "GB", "UY", "VI", "VU", "WF" ], "description": "The ISO 2 country code of the business to search for.", "examples": [ "GB" ] }, "filing_number": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Filing Number", "description": "The company registration (filing) number at the country's registry. When provided, the registry is searched by this number first; a `name` (if also provided) is used as a fallback when no company matches the number. A `filing_number` with `iso2_country_code` is a complete request on its own. Name and address may each be supplied independently. Provided inputs contribute to KYB/Risk scores; omitted name or address inputs are excluded from matching and scoring.", "examples": [ "09517735" ] }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names to include in the search.", "examples": [ [ "Nathan Harrington", "Alexander Wolfe" ] ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "The website to include in the search.", "examples": [ "https://www.figueroa.com/" ] }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number to include in the search.", "examples": [ "436-502-9710" ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "The email to include in the search.", "examples": [ "zacharymoore@example.com" ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names to include in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ] }, "options": { "items": { "$ref": "#/components/schemas/InternationalBusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional, separately-billed add-ons to enable for this search.", "examples": [ [ "Order.Enhanced" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "iso2_country_code" ], "title": "InternationalBusinessSearchRequest (v1)", "description": "Represents an international business search request." }, "v1.InternationalCountryResponse": { "properties": { "iso2_country_code": { "type": "string", "enum": [ "AU", "AT", "BH", "BE", "BA", "BR", "BN", "KH", "CA", "CN", "CO", "HR", "CW", "CY", "CZ", "DK", "DO", "EE", "FI", "FR", "GF", "PF", "GE", "DE", "GI", "GR", "GP", "GG", "HK", "IS", "IE", "IM", "IL", "IT", "JP", "LV", "LI", "LT", "LU", "MY", "MH", "MQ", "YT", "ME", "NL", "NC", "NZ", "NO", "OM", "PK", "PA", "PE", "PL", "PT", "QA", "RE", "RO", "RU", "BL", "PM", "WS", "SG", "SK", "SI", "SB", "ES", "SE", "CH", "TW", "TT", "UG", "GB", "UY", "VI", "VU", "WF" ], "description": "The ISO 3166-1 alpha-2 code to send as `iso2_country_code` on `POST /international/searches`.", "examples": [ "GB" ] }, "name": { "type": "string", "title": "Name", "description": "The jurisdiction's display name.", "examples": [ "United Kingdom" ] }, "supports_lite_profile": { "type": "boolean", "title": "Supports Lite Profile", "description": "Whether a search without the `ENHANCED` option returns a profile in this jurisdiction.", "examples": [ true ] }, "supports_enhanced_profile": { "type": "boolean", "title": "Supports Enhanced Profile", "description": "Whether the `ENHANCED` option (officers, shareholders and beneficial owners) is available in this jurisdiction.", "examples": [ true ] } }, "type": "object", "required": [ "iso2_country_code", "name", "supports_lite_profile", "supports_enhanced_profile" ], "title": "InternationalCountryResponse (v1)", "description": "A jurisdiction an international search can target, and which profiles\nare offered there.\n\n``GET /international/countries`` returns one per country\n``POST /international/searches`` accepts, so a client builds its country\npicker and enhanced-profile option from the API instead of a copy." }, "v1.InternationalRegistrationResponse": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The registered name of the business.", "examples": [ "KYCKR UK LIMITED" ] }, "alternative_names": { "items": { "type": "string" }, "type": "array", "title": "Alternative Names", "description": "A list of alternative names (e.g. trading names and former registered names) the registry holds for the business.", "examples": [ [ "Ramos, Garcia and Good" ] ] }, "filing_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Number", "description": "The registry filing number. Pass it as `filing_number` to `POST /international/searches` to search exactly this company.", "examples": [ "11655290" ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "The business's address as held by the registry.", "examples": [ "Kemp House, 160 City Road, London, United Kingdom, EC1V 2NX" ] }, "standing": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Standing", "description": "The registry's own status wording (e.g. 'Active', 'Registered', 'In Liquidation').", "examples": [ "Active" ] }, "legal_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Form", "description": "The registry's legal form / legal structure for the business.", "examples": [ "Private limited company" ] }, "registry_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registry Type", "description": "Registry-provided entity or registry type where distinct from legal form.", "examples": [ "Registered society" ] }, "registration_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registration Type", "description": "Registry-provided registration type, e.g. Federal, Extra-Provincial, or Registered society.", "examples": [ "Federal" ] }, "incorporation_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Incorporation Date", "description": "The date the business was incorporated or registered.", "examples": [ "2018-11-01" ] }, "registration_authority": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registration Authority", "description": "Registry authority name, e.g. Companies House, United Kingdom.", "examples": [ "Companies House, United Kingdom" ] }, "registration_authority_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Registration Authority Code", "description": "Registry authority code where provided, e.g. CA-ON or CA-FE.", "examples": [ "CA-ON" ] } }, "type": "object", "title": "InternationalRegistrationResponse (v1)", "description": "A business's registration (filing) at an international registry.\n\nA raw registry match from ``GET /international/registrations`` — not a\nrecord in our system. The fields speak the same vocabulary as the\n``business`` an international search returns (`InternationalBusiness`);\npass a result's `filing_number` (with the country) to\n``POST /international/searches`` to run a lite or enhanced search for\nexactly this company." }, "v1.LienFilingAssignedBusinessDebtorPartyRequest": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "organization_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Organization Name", "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ] }, { "type": "null", "title": "No Organization Name", "description": "No organization name is provided for the party." } ], "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/BusinessStructure", "title": "Organization Type", "description": "The type of organization involved in the lien filing, if applicable." }, { "type": "null", "title": "No Organization Type", "description": "No organization type is provided for the party." } ], "title": "Organization Type" }, "type": { "type": "string", "const": "ORGANIZATION", "title": "Organization Party Type", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person." }, "capacity": { "$ref": "#/components/schemas/LienPartyDebtorCapacity", "title": "Lien Debtor Capacity", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "default": "NONE_OF_THE_ABOVE" } }, "type": "object", "required": [ "type" ], "title": "LienFilingAssignedBusinessDebtorPartyRequest (v1)", "description": "This request model is specifically utilized for updating the mailing address\ninformation of a designated debtor party. It facilitates the modification\nof address details to ensure accurate and current records." }, "v1.LienFilingAssignedPersonDebtorPartyRequest": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "suffix": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Suffix", "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ] }, { "type": "null", "title": "No Suffix", "description": "No suffix is provided for the individual." } ], "title": "Suffix" }, "last_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Last Name", "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ] }, { "type": "null", "title": "No Last Name", "description": "No last name is provided for the individual." } ], "title": "Last Name" }, "first_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual First Name", "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ] }, { "type": "null", "title": "No First Name", "description": "No first name is provided for the individual." } ], "title": "First Name" }, "middle_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Middle Name", "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ] }, { "type": "null", "title": "No Middle Name", "description": "No middle name is provided for the individual." } ], "title": "Middle Name" }, "type": { "type": "string", "const": "INDIVIDUAL", "title": "Individual Party Type", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity." }, "capacity": { "$ref": "#/components/schemas/LienPartyDebtorCapacity", "title": "Lien Debtor Capacity", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "default": "NONE_OF_THE_ABOVE" } }, "type": "object", "required": [ "type" ], "title": "LienFilingAssignedPersonDebtorPartyRequest (v1)", "description": "This request model is specifically utilized for updating the mailing address\ninformation of a designated person debtor party. It facilitates the modification\nof address details to ensure accurate and current records." }, "v1.LienFilingCollateralStatementAttachmentsRequest": { "properties": { "collateral_statement_designation": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingCollateralStatementDesignation", "title": "Collateral Statement Designation", "description": "The designation of the collateral statement, indicating the nature of the collateral as either having no special designation, being managed within a trust arrangement, or administered by the personal representative of a deceased individual." }, { "type": "null", "title": "Collateral Statement Designation Omitted", "description": "When updating the field with `null`, it will respect the existing server value for the `collateral_statement_designation` field of the filing document, causing no changes to this field." } ], "title": "Collateral Statement Designation" }, "type": { "type": "string", "const": "ATTACHMENTS", "title": "Collateral Description Type", "description": "This structure represents attachments as collateral statements. Attachments are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing.", "default": "ATTACHMENTS" } }, "type": "object", "required": [ "type" ], "title": "LienFilingCollateralStatementAttachmentsRequest (v1)", "description": "This model is used to represent the attachments as collateral statements when\ncreating or updating a filing submission resource. The attachments are managed\nthrough separate attachment management routes specific to lien filings." }, "v1.LienFilingIndividualDebtorParty": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "capacity": { "$ref": "#/components/schemas/LienPartyDebtorCapacity", "title": "Lien Debtor Capacity", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "default": "NONE_OF_THE_ABOVE" }, "suffix": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Suffix", "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ] }, { "type": "null", "title": "No Suffix", "description": "No suffix is provided for the individual." } ], "title": "Suffix" }, "last_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Last Name", "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ] }, { "type": "null", "title": "No Last Name", "description": "No last name is provided for the individual." } ], "title": "Last Name" }, "first_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual First Name", "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ] }, { "type": "null", "title": "No First Name", "description": "No first name is provided for the individual." } ], "title": "First Name" }, "middle_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Middle Name", "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ] }, { "type": "null", "title": "No Middle Name", "description": "No middle name is provided for the individual." } ], "title": "Middle Name" }, "type": { "type": "string", "const": "INDIVIDUAL", "title": "Individual Party Type", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity." }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "title": "Lien Party ID", "description": "The stable identifier of an existing draft party. Echo this value when replacing a draft party list so the existing party is updated instead of recreated." }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type" ], "title": "LienFilingIndividualDebtorParty (v1)", "description": "Represents an individual debtor party involved in a lien filing. This model\nis designed to represent individuals who are debtors in the context of a lien,\nincluding specific details relevant to their role as a debtor party." }, "v1.LienFilingIndividualSecuredParty": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "masked": { "anyOf": [ { "type": "boolean", "title": "Masked", "description": "When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492)." }, { "type": "null", "title": "Not Masked", "description": "The secured party is not masked when filing a lien." } ], "title": "Masked" }, "is_assignor": { "anyOf": [ { "type": "boolean", "title": "Is Assignor", "description": "Whether the secured party is the assignor of the lien." }, { "type": "null", "title": "Assignor Not Specified", "description": "The assignor status of the secured party is not specified." } ], "title": "Is Assignor" }, "suffix": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Suffix", "description": "The suffix of the individual involved in the lien filing, if applicable.", "examples": [ "Jr.", "Sr.", "III" ] }, { "type": "null", "title": "No Suffix", "description": "No suffix is provided for the individual." } ], "title": "Suffix" }, "last_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Last Name", "description": "The last name of the individual involved in the lien filing, if applicable.", "examples": [ "Doe", "Smith", "Johnson" ] }, { "type": "null", "title": "No Last Name", "description": "No last name is provided for the individual." } ], "title": "Last Name" }, "first_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual First Name", "description": "The first name of the individual involved in the lien filing, if applicable.", "examples": [ "John", "Jane", "Alex" ] }, { "type": "null", "title": "No First Name", "description": "No first name is provided for the individual." } ], "title": "First Name" }, "middle_name": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Individual Middle Name", "description": "The middle name of the individual involved in the lien filing, if applicable.", "examples": [ "Anne", "Michael", "Luis" ] }, { "type": "null", "title": "No Middle Name", "description": "No middle name is provided for the individual." } ], "title": "Middle Name" }, "type": { "type": "string", "const": "INDIVIDUAL", "title": "Individual Party Type", "description": "Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity." }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "title": "Lien Party ID", "description": "The stable identifier of an existing draft party. Echo this value when replacing a draft party list so the existing party is updated instead of recreated." }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type" ], "title": "LienFilingIndividualSecuredParty (v1)", "description": "Represents an individual secured party involved in a lien filing. This model\nis designed to specifically represent individuals that are secured parties\nwithin the context of a lien. It captures additional details pertinent\nto the role of a secured party." }, "v1.LienFilingOrganizationDebtorParty": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "capacity": { "$ref": "#/components/schemas/LienPartyDebtorCapacity", "title": "Lien Debtor Capacity", "description": "The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien.", "default": "NONE_OF_THE_ABOVE" }, "organization_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Organization Name", "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ] }, { "type": "null", "title": "No Organization Name", "description": "No organization name is provided for the party." } ], "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/BusinessStructure", "title": "Organization Type", "description": "The type of organization involved in the lien filing, if applicable." }, { "type": "null", "title": "No Organization Type", "description": "No organization type is provided for the party." } ], "title": "Organization Type" }, "type": { "type": "string", "const": "ORGANIZATION", "title": "Organization Party Type", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person." }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "title": "Lien Party ID", "description": "The stable identifier of an existing draft party. Echo this value when replacing a draft party list so the existing party is updated instead of recreated." }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type" ], "title": "LienFilingOrganizationDebtorParty (v1)", "description": "Describes an organization that is a debtor in a lien filing. This model\nis tailored for organizations acting as debtors in lien contexts, including\nspecific details relevant to their debtor status." }, "v1.LienFilingOrganizationSecuredParty": { "properties": { "mailing_address": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Mailing Address", "description": "The mailing address for the lien filing party, excluding city, state, and postal code.", "examples": [ "123 Main St", "456 Elm St Apt 101", "789 Pine St NW Suite 500" ] }, { "type": "null", "title": "No Mailing Address", "description": "No mailing address is provided for the party." } ], "title": "Mailing Address" }, "city": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "City", "description": "The city of the lien filing party's mailing address.", "examples": [ "Springfield", "Metropolis", "Gotham" ] }, { "type": "null", "title": "No City", "description": "No city is provided for the party." } ], "title": "City" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "State", "description": "The state abbreviation of the lien filing party's mailing address.", "examples": [ "AL", "CA", "NY" ] }, { "type": "null", "title": "No State", "description": "No state is provided for the party." } ], "title": "State" }, "postal_code": { "anyOf": [ { "type": "string", "maxLength": 16, "title": "Postal Code", "description": "The postal code of the lien filing party's mailing address.", "examples": [ "62701", "90210", "10001" ] }, { "type": "null", "title": "No Postal Code", "description": "No postal code is provided for the party." } ], "title": "Postal Code" }, "masked": { "anyOf": [ { "type": "boolean", "title": "Masked", "description": "When true, this secured party is filed under a nominee so its name stays off the public record. Settable when creating a filing and while it remains a Draft. On the organization's secured-party preference, this is the default applied to the secured party synthesized when a new UCC-1 draft is created. A UCC-3 that introduces a masked secured party — by adding one, assigning to one, or editing one in — is billed for masking once per filing. Once the filing leaves Draft the value is frozen, and a PATCH that changes it is refused with a 409 (code 492)." }, { "type": "null", "title": "Not Masked", "description": "The secured party is not masked when filing a lien." } ], "title": "Masked" }, "is_assignor": { "anyOf": [ { "type": "boolean", "title": "Is Assignor", "description": "Whether the secured party is the assignor of the lien." }, { "type": "null", "title": "Assignor Not Specified", "description": "The assignor status of the secured party is not specified." } ], "title": "Is Assignor" }, "organization_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Organization Name", "description": "The name of the organization involved in the lien filing.", "examples": [ "Acme Inc", "Globex Corporation", "Initech LLC" ] }, { "type": "null", "title": "No Organization Name", "description": "No organization name is provided for the party." } ], "title": "Organization Name" }, "organization_type": { "anyOf": [ { "$ref": "#/components/schemas/BusinessStructure", "title": "Organization Type", "description": "The type of organization involved in the lien filing, if applicable." }, { "type": "null", "title": "No Organization Type", "description": "No organization type is provided for the party." } ], "title": "Organization Type" }, "type": { "type": "string", "const": "ORGANIZATION", "title": "Organization Party Type", "description": "Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person." }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "title": "Lien Party ID", "description": "The stable identifier of an existing draft party. Echo this value when replacing a draft party list so the existing party is updated instead of recreated." }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "type" ], "title": "LienFilingOrganizationSecuredParty (v1)", "description": "Describes an organization acting as a secured party in a lien filing. This model\nis tailored to encapsulate organizations with a secured interest in the context of a lien,\ndetailing aspects relevant to their secured party status." }, "v1.LienFilingSubmissionCreateStandaloneUCC1Request": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC1", "title": "Filing Type", "description": "Initial financing statement, which is the first filing of a lien.", "default": "UCC1" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation for the jurisdiction where the lien is to be filed." }, { "type": "null", "title": "No Jurisdiction State provided.", "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state." } ], "title": "State" }, "jurisdiction_county": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Jurisdiction County", "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located." }, { "type": "null", "title": "No Jurisdiction County provided.", "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required." } ], "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" } } }, "type": "array", "title": "Debtors", "description": "An enumeration of debtors implicated in the lien filing process. For an anchored filing, omit the debtor associated with the business or person in the URL because it is supplied as the assigned debtor. For a standalone filing, include every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Debtors Provided", "description": "No debtors are provided for the lien filing." } ], "title": "Debtors" }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Secured Parties Provided", "description": "No secured parties are provided for the lien filing." } ], "title": "Secured Parties" }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsRequest" }, { "type": "null", "title": "No Collateral Statements Provided", "description": "No collateral statements are provided for the lien filing." } ], "title": "Collateral Statements", "description": "This field permits the provision of collateral statements either in plain text format or through one or more document attachments. This flexibility enhances the presentation of detailed information or evidence pertaining to the lien's collateral. \n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "default": { "collateral_statement_designation": "NONE", "type": "ATTACHMENTS" }, "examples": [ { "collateral_statement_designation": "NONE", "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "collateral_statement_designation": "NONE", "type": "ATTACHMENTS" } ] }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeNameDesignation", "title": "Alternative Name Designation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally." }, { "type": "null", "title": "No Alternative Name Designation", "description": "No alternative name designation is provided for the lien filing." } ], "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeType", "title": "Alternative Filing Type", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable." }, { "type": "null", "title": "No Alternative Filing Type", "description": "No alternative filing type is provided for the lien filing." } ], "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "anyOf": [ { "type": "number", "maximum": 10000000000.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Principal Indebted Amount", "description": "The principal indebted amount in the lien filing submission." }, { "type": "null", "title": "No Principal Indebted Amount provided.", "description": "No principal indebted amount has been provided for the lien filing submission." } ], "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "type": "boolean", "title": "Documentary Tax Stamp Required", "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp." }, { "type": "null", "title": "No Documentary Tax Stamp Provided", "description": "No documentary tax stamp is provided for the lien filing submission." } ], "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingTaxExemptReason", "title": "Tax Exempt Reason", "description": "The tax exempt reason for the lien filing submission." }, { "type": "null", "title": "No Tax Exempt Reason provided.", "description": "No tax exempt reason has been provided for the lien filing submission." } ], "title": "Tax Exempt Reason" } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionCreateStandaloneUCC1Request (v1)", "description": "Request schema shared by standalone UCC-1 draft creation.\n\nStandalone filings have no assigned debtor. Every debtor is supplied in\n``debtors``, so assigned-debtor fields are intentionally absent from this\nmodel and are rejected by the inherited ``extra=\"forbid\"`` configuration." }, "v1.LienFilingSubmissionCreateUCC1Request": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC1", "title": "Filing Type", "description": "Initial financing statement, which is the first filing of a lien.", "default": "UCC1" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation for the jurisdiction where the lien is to be filed." }, { "type": "null", "title": "No Jurisdiction State provided.", "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state." } ], "title": "State" }, "jurisdiction_county": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Jurisdiction County", "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located." }, { "type": "null", "title": "No Jurisdiction County provided.", "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required." } ], "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" } } }, "type": "array", "title": "Debtors", "description": "An enumeration of debtors implicated in the lien filing process. For an anchored filing, omit the debtor associated with the business or person in the URL because it is supplied as the assigned debtor. For a standalone filing, include every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Debtors Provided", "description": "No debtors are provided for the lien filing." } ], "title": "Debtors" }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Secured Parties Provided", "description": "No secured parties are provided for the lien filing." } ], "title": "Secured Parties" }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsRequest" }, { "type": "null", "title": "No Collateral Statements Provided", "description": "No collateral statements are provided for the lien filing." } ], "title": "Collateral Statements", "description": "This field permits the provision of collateral statements either in plain text format or through one or more document attachments. This flexibility enhances the presentation of detailed information or evidence pertaining to the lien's collateral. \n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "default": { "collateral_statement_designation": "NONE", "type": "ATTACHMENTS" }, "examples": [ { "collateral_statement_designation": "NONE", "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "collateral_statement_designation": "NONE", "type": "ATTACHMENTS" } ] }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeNameDesignation", "title": "Alternative Name Designation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally." }, { "type": "null", "title": "No Alternative Name Designation", "description": "No alternative name designation is provided for the lien filing." } ], "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeType", "title": "Alternative Filing Type", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable." }, { "type": "null", "title": "No Alternative Filing Type", "description": "No alternative filing type is provided for the lien filing." } ], "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "anyOf": [ { "type": "number", "maximum": 10000000000.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Principal Indebted Amount", "description": "The principal indebted amount in the lien filing submission." }, { "type": "null", "title": "No Principal Indebted Amount provided.", "description": "No principal indebted amount has been provided for the lien filing submission." } ], "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "type": "boolean", "title": "Documentary Tax Stamp Required", "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp." }, { "type": "null", "title": "No Documentary Tax Stamp Provided", "description": "No documentary tax stamp is provided for the lien filing submission." } ], "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingTaxExemptReason", "title": "Tax Exempt Reason", "description": "The tax exempt reason for the lien filing submission." }, { "type": "null", "title": "No Tax Exempt Reason provided.", "description": "No tax exempt reason has been provided for the lien filing submission." } ], "title": "Tax Exempt Reason" }, "assigned_business_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest", "title": "Business Debtor Mailing Address Update", "description": "Optional field to update the mailing address for the business debtor associated with this lien filing. Use this to specify a new address if different from the one on record.", "deprecated": true }, { "type": "null", "title": "No Update to Business Debtor Mailing Address", "description": "If not provided, the existing mailing address for the business debtor will remain unchanged.", "deprecated": true } ], "title": "Assigned Business Debtor" }, "assigned_debtor": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyRequest" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyRequest", "ORGANIZATION": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest" } } }, { "type": "null", "title": "No Update to Debtor Mailing Address", "description": "If not provided, the existing mailing address for the debtor will remain unchanged." } ], "title": "Assigned Debtor" } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionCreateUCC1Request (v1)", "description": "Request schema for creating a UCC-1 draft anchored to a KYB entity." }, "v1.LienFilingSubmissionCreateUCC3Request": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC3", "title": "Filing Type", "description": "Amendment or continuation of a previously filed financing statement.", "default": "UCC3" }, "amendment_action": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3TerminationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3ContinuationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AssignmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DebtorAmendmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3CollateralAmendmentAction" }, { "type": "null", "title": "Amendment Action Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field." } ], "title": "Amendment Action", "description": "The action to be taken for the UCC-3 filing." }, "authorizing_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AuthorizingPartyDebtor" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AuthorizingPartySecuredParty" }, { "type": "null", "title": "Authorizing Party Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `authorizing_party` field of the filing document, causing no changes to this field." } ], "title": "Authorizing Party", "description": "The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party." } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionCreateUCC3Request (v1)", "description": "This structure represents the schema for creating a lien filing submission\nrequest, specifically for UCC-3 filings." }, "v1.LienFilingSubmissionImportRequest": { "properties": { "state": { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation of the jurisdiction the lien is filed in.", "examples": [ "IL" ] }, "filing_number": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Lien Filing Number", "description": "The filing number assigned by the filing office. Both the initial financing statement and any of its amendments are accepted; an amendment resolves to the initial financing statement it amends.", "examples": [ "P98172" ] }, "filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the imported filing (only filer's reference).", "examples": [ "Acme Inc — 2023 equipment lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name defaults to the filing number." } ], "title": "Filing Name" } }, "additionalProperties": false, "type": "object", "required": [ "state", "filing_number" ], "title": "LienFilingSubmissionImportRequest (v1)", "description": "Request schema for importing a lien that already exists in the public\nrecord, identified by the state and filing number of its initial financing\nstatement.\n\nImporting does not file anything: it records the organization's claim over\na filing Baselayer already holds in its public corpus, and the filing's\nstatus, parties and amendment history keep tracking that corpus." }, "v1.LienFilingSubmissionImportedResponse": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "id": { "type": "string", "format": "uuid", "title": "Lien Filing Submission ID", "description": "The unique identifier for the lien filing submission." }, "filing_status": { "$ref": "#/components/schemas/LienFilingSubmissionStatus", "title": "Lien Filing Submission Status", "description": "The current state of the lien filing submission." }, "filing_number": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Lien Filing Number", "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ] }, { "type": "null", "title": "No Filing Number assigned yet.", "description": "This field is set to `null` until the lien filing has been officially recorded." } ], "title": "Filing Number" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date", "title": "Filing Date", "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ] }, { "type": "null", "title": "No Filing Date assigned yet.", "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet." } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "type": "string", "format": "date", "title": "Lapse Date", "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ] }, { "type": "null", "title": "No Lapse Date assigned yet.", "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet." } ], "title": "Lapse Date" }, "has_submission_document": { "type": "boolean", "title": "Has Submission Document", "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "default": false }, "has_downloadable_document": { "type": "boolean", "title": "Has Downloadable Document", "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "default": false }, "origin": { "$ref": "#/components/schemas/LienFilingOrigin", "title": "Lien Filing Origin", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "default": "filed_via_baselayer" }, "filing_type": { "type": "string", "const": "UCC1", "title": "Filing Type", "description": "Initial financing statement, which is the filing an imported lien is identified by.", "default": "UCC1" }, "state": { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation of the jurisdiction the lien is filed in.", "examples": [ "IL" ] }, "status": { "$ref": "#/components/schemas/LienFilingStatus", "title": "Lien Status", "description": "The lien's standing in the public record, derived from its amendment history and lapse date (UCC §9-515).", "examples": [ "Active" ] }, "imported_unverified": { "type": "boolean", "title": "Unverified Import", "description": "Whether this filing is held from the details the caller supplied rather than verified against the public record. Its status, dates and parties are the caller's own claim, estimated under UCC §9-515 where the public record would otherwise answer.", "default": false, "examples": [ false ] }, "debtors": { "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "type": "array", "title": "Debtors", "description": "The debtors recorded against the lien in the public record." }, "secured_parties": { "items": { "$ref": "#/components/schemas/v1.LienPartyResponse" }, "type": "array", "title": "Secured Parties", "description": "The secured parties recorded against the lien in the public record." }, "amendments": { "items": { "$ref": "#/components/schemas/v1.LienAmendmentResponse" }, "type": "array", "title": "Amendments", "description": "The continuations, terminations, assignments and other amendments recorded against the lien in the public record." } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "LienFilingSubmissionImportedResponse (v1)", "description": "Represents a lien filing an organization imported from the public record.\n\nBaselayer holds no submission of its own for these filings, so everything\ndescribing the lien — its status, parties and amendment history — is derived\nfrom the public corpus at read time rather than from an editable draft." }, "v1.LienFilingSubmissionUCC3Response": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC3", "title": "Filing Type", "description": "Amendment or continuation of a previously filed financing statement.", "default": "UCC3" }, "amendment_action": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3TerminationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3ContinuationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AssignmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DebtorAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentActionResponse" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3CollateralAmendmentActionResponse" }, { "type": "null", "title": "Amendment Action Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field." } ], "title": "Amendment Action", "description": "The action to be taken for the UCC-3 filing." }, "authorizing_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse" }, { "type": "null", "title": "Authorizing Party Not Set Yet", "description": "When `null`, the authorizing party has not been set yet." } ], "title": "Authorizing Party", "description": "The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party." }, "id": { "type": "string", "format": "uuid", "title": "Lien Filing Submission ID", "description": "The unique identifier for the lien filing submission." }, "filing_status": { "$ref": "#/components/schemas/LienFilingSubmissionStatus", "title": "Lien Filing Submission Status", "description": "The current state of the lien filing submission." }, "filing_number": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Lien Filing Number", "description": "The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions.", "examples": [ "UCC1-1234567890" ] }, { "type": "null", "title": "No Filing Number assigned yet.", "description": "This field is set to `null` until the lien filing has been officially recorded." } ], "title": "Filing Number" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date", "title": "Filing Date", "description": "The date when the lien filing was submitted to the jurisdiction.", "examples": [ "2023-01-01" ] }, { "type": "null", "title": "No Filing Date assigned yet.", "description": "No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet." } ], "title": "Filing Date" }, "lapse_date": { "anyOf": [ { "type": "string", "format": "date", "title": "Lapse Date", "description": "The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. After a Filed continuation against this filing, this is the renewed date.", "examples": [ "2024-04-20" ] }, { "type": "null", "title": "No Lapse Date assigned yet.", "description": "No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet." } ], "title": "Lapse Date" }, "has_submission_document": { "type": "boolean", "title": "Has Submission Document", "description": "Whether a PDF copy of the latest successful submission is available. This is separate from the official filed document.", "default": false }, "has_downloadable_document": { "type": "boolean", "title": "Has Downloadable Document", "description": "Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction.", "default": false }, "origin": { "$ref": "#/components/schemas/LienFilingOrigin", "title": "Lien Filing Origin", "description": "How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record.", "default": "filed_via_baselayer" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation for the jurisdiction where the amendment is to be filed. It is the jurisdiction of the filing being amended, copied when the amendment is created through `POST /lien_submissions/{filing_id}/amend`, and is not recomputed afterwards." }, { "type": "null", "title": "No Jurisdiction State provided.", "description": "The filing being amended carried no jurisdiction state, so the amendment has none either." } ], "title": "State" }, "amending_filing": { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response", "title": "Amending Filing", "description": "The filing that is being amended." } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionUCC3Response (v1)" }, "v1.LienFilingSubmissionUpdateUCC1Request": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC1", "title": "Filing Type", "description": "Initial financing statement, which is the first filing of a lien." }, "state": { "anyOf": [ { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation for the jurisdiction where the lien is to be filed." }, { "type": "null", "title": "No Jurisdiction State provided.", "description": "No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state." } ], "title": "State" }, "jurisdiction_county": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Jurisdiction County", "description": "The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located." }, { "type": "null", "title": "No Jurisdiction County provided.", "description": "No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required." } ], "title": "Jurisdiction County" }, "debtors": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" } } }, "type": "array", "title": "Debtors", "description": "An enumeration of debtors implicated in the lien filing process. For an anchored filing, omit the debtor associated with the business or person in the URL because it is supplied as the assigned debtor. For a standalone filing, include every debtor in this list.", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Debtors Provided", "description": "No debtors are provided for the lien filing." } ], "title": "Debtors" }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "A list of secured parties involved in the lien filing.", "examples": [ [ { "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "No Secured Parties Provided", "description": "No secured parties are provided for the lien filing." } ], "title": "Secured Parties" }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsRequest" }, { "type": "null", "title": "No Collateral Statements provided", "description": "No collateral statements have been provided for the lien filing update endpoint. The collateral statements will remain unchanged." } ], "title": "Collateral Statements", "description": "This field permits the provision of collateral statements either in plain text format or through one or more document attachments. This flexibility enhances the presentation of detailed information or evidence pertaining to the lien's collateral.\n\n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "examples": [ { "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "type": "ATTACHMENTS" } ] }, "alternative_name_designation": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeNameDesignation", "title": "Alternative Name Designation", "description": "Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally." }, { "type": "null", "title": "No Alternative Name Designation", "description": "No alternative name designation is provided for the lien filing." } ], "title": "Alternative Name Designation" }, "alternative_filing_type": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingAlternativeType", "title": "Alternative Filing Type", "description": "Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable." }, { "type": "null", "title": "No Alternative Filing Type", "description": "No alternative filing type is provided for the lien filing." } ], "title": "Alternative Filing Type" }, "principal_indebted_amount": { "anyOf": [ { "anyOf": [ { "type": "number", "maximum": 10000000000.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } ], "title": "Principal Indebted Amount", "description": "The principal indebted amount in the lien filing submission." }, { "type": "null", "title": "No Principal Indebted Amount provided.", "description": "No principal indebted amount has been provided for the lien filing submission." } ], "title": "Principal Indebted Amount" }, "documentary_tax_stamp_required": { "anyOf": [ { "type": "boolean", "title": "Documentary Tax Stamp Required", "description": "Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp." }, { "type": "null", "title": "No Documentary Tax Stamp Provided", "description": "No documentary tax stamp is provided for the lien filing submission." } ], "title": "Documentary Tax Stamp Required" }, "tax_exempt_reason": { "anyOf": [ { "$ref": "#/components/schemas/LienFilingTaxExemptReason", "title": "Tax Exempt Reason", "description": "The tax exempt reason for the lien filing submission." }, { "type": "null", "title": "No Tax Exempt Reason provided.", "description": "No tax exempt reason has been provided for the lien filing submission." } ], "title": "Tax Exempt Reason" }, "assigned_business_debtor": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest", "title": "Business Debtor Mailing Address Update", "description": "Optional field to update the mailing address for the business debtor associated with this lien filing. Use this to specify a new address if different from the one on record.", "deprecated": true }, { "type": "null", "title": "No Update to Business Debtor Mailing Address", "description": "If not provided, the existing mailing address for the business debtor will remain unchanged.", "deprecated": true } ], "title": "Assigned Business Debtor" }, "assigned_debtor": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest" }, { "$ref": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyRequest" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingAssignedPersonDebtorPartyRequest", "ORGANIZATION": "#/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyRequest" } } }, { "type": "null", "title": "No Update to Debtor Mailing Address", "description": "If not provided, the existing mailing address for the debtor will remain unchanged." } ], "title": "Assigned Debtor" } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionUpdateUCC1Request (v1)", "description": "The `LienFilingSubmissionUpdateRequest` object is designed for updating\nan existing lien filing submission.\n\nIt enables modifications to specific fields such as the collateral\ndescription, secured parties, and the submission filing name.\n\nThis functionality is essential for incorporating new or altered\ninformation after the initial creation of a lien filing submission,\nensuring that updates remain aligned with the original submission's\nrequirements while providing the necessary flexibility for changes." }, "v1.LienFilingSubmissionUpdateUCC3Request": { "properties": { "reference_data": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Reference Data", "description": "Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA).", "examples": [ "Filing for a 1967 Ford Mustang", "Case #12345XYZ", "Debtor: John Doe" ] }, { "type": "null", "title": "No Reference Data", "description": "No reference data is provided for the lien filing." } ], "title": "Reference Data" }, "submission_filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing (only filer's reference).", "examples": [ "My Lien Filing", "Springfield Property Lien", "2023 Equipment Lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name will be automatically generated based on the debtor's name and the type of filing." } ], "title": "Submission Filing Name" }, "search_to_reflect": { "anyOf": [ { "type": "boolean", "title": "Search to Reflect", "description": "When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." }, { "type": "null", "title": "No Search to Reflect", "description": "When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office." } ], "title": "Search To Reflect" }, "email_contact": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Lien Filing Email Contact", "description": "This email will receive all correspondence concerning this lien filing." }, { "type": "null", "title": "No Email Contact provided.", "description": "No email contact has been provided for the lien filing submission." } ], "title": "Email Contact" }, "real_estate_info": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingRealEstateInfo" }, { "$ref": "#/components/schemas/v1.LienFilingNoRealEstateInfo" }, { "type": "null", "title": "Real Estate Information Omitted", "description": "The real estate information will not be updated." } ], "title": "Real Estate Information", "description": "The real estate information associated with the lien filing submission." }, "miscellaneous_info": { "anyOf": [ { "type": "string", "maxLength": 256, "title": "Miscellaneous Information", "description": "Miscellaneous information associated with the lien filing submission." }, { "type": "null", "title": "No Miscellaneous Information provided.", "description": "No miscellaneous information has been provided for the lien filing submission." } ], "title": "Miscellaneous Info" }, "filing_type": { "type": "string", "const": "UCC3", "title": "Filing Type", "description": "Amendment or continuation of a previously filed financing statement." }, "amendment_action": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3TerminationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3ContinuationAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AssignmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DebtorAmendmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentAction" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3CollateralAmendmentAction" }, { "type": "null", "title": "Amendment Action Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field." } ], "title": "Amendment Action", "description": "The action to be taken for the UCC-3 filing." }, "authorizing_party": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AuthorizingPartyDebtor" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3AuthorizingPartySecuredParty" }, { "type": "null", "title": "Authorizing Party Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `authorizing_party` field of the filing document, causing no changes to this field." } ], "title": "Authorizing Party", "description": "The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party." } }, "additionalProperties": false, "type": "object", "required": [ "filing_type" ], "title": "LienFilingSubmissionUpdateUCC3Request (v1)", "description": "This structure represents the schema for updating a lien filing submission\nrequest, specifically for UCC-3 filings." }, "v1.LienFilingUCC3AddDebtorAmendment": { "properties": { "type": { "type": "string", "const": "ADD", "title": "Add Debtor", "description": "Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement.", "default": "ADD" }, "debtors": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" } } }, "type": "array", "title": "Debtors", "description": "An enumeration of debtors implicated in the lien filing process. It is imperative to omit the debtor correlated with the business profile against which the lien is being filed. ", "examples": [ [ { "capacity": "ESTATE", "city": "Springfield", "mailing_address": "123 Main St", "organization_name": "Acme Inc", "organization_type": "COOPERATIVE", "postal_code": "62701", "state": "IL", "type": "ORGANIZATION" } ] ] }, { "type": "null", "title": "Debtors Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `debtors` field of the filing document, causing no changes to this field." } ], "title": "Debtors" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3AddDebtorAmendment (v1)", "description": "Represents an amendment to add a debtor in a UCC-3 filing.\n\nThis model is used to add a new debtor to an existing financing statement.\nIt includes details about the debtor being added to the UCC-3 amendment." }, "v1.LienFilingUCC3AddSecuredPartyAmendment": { "properties": { "type": { "type": "string", "const": "ADD", "title": "Add Debtor", "description": "Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement.", "default": "ADD" }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "An enumeration of secured parties implicated in the lien filing process." }, { "type": "null", "title": "Secured Parties Omitted", "description": "When updating the record with `Null`, it will respect the existing server value for the `secured_parties` field of the filing document, causing no changes to this field." } ], "title": "Secured Parties" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3AddSecuredPartyAmendment (v1)", "description": "Represents an amendment to add a secured party in a UCC-3 filing.\n\nThis model is used to add a new secured party to an existing financing statement.\nIt includes details about the secured party being added to the UCC-3 amendment." }, "v1.LienFilingUCC3AmendingDebtor": { "properties": { "amending_debtor_id": { "type": "string", "format": "uuid", "title": "Amending Debtor ID", "description": "The ID of the debtor to be amended. This can be either an organization or an individual debtor." }, "new_debtor": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualDebtorParty" } ], "title": "New Debtor", "description": "The new debtor information. This can be either an organization or an individual debtor.", "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualDebtorParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationDebtorParty" } } } }, "type": "object", "required": [ "amending_debtor_id", "new_debtor" ], "title": "LienFilingUCC3AmendingDebtor (v1)", "description": "Represents a debtor being amended in a UCC-3 filing.\n\nSpecifies the details of a debtor being modified in a UCC-3 filing.\nThis encompasses the original debtor's identifier and the updated\ninformation. UCC-3 filings serve to amend previously submitted\nUniform Commercial Code financing statements." }, "v1.LienFilingUCC3AmendingSecuredParty": { "properties": { "amending_secured_party_id": { "type": "string", "format": "uuid", "title": "Amending Secured Party ID", "description": "The ID of the secured party to be amended." }, "new_secured_party": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "title": "New Secured Party", "description": "The new secured party information. This can be either an organization or an individual secured party.", "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } } }, "type": "object", "required": [ "amending_secured_party_id", "new_secured_party" ], "title": "LienFilingUCC3AmendingSecuredParty (v1)", "description": "Defines a secured party undergoing amendment in a UCC-3 filing.\n\nThis class encapsulates the information for a secured party being modified\nin a UCC-3 (Uniform Commercial Code - Amendment) filing. It contains the\nidentifier of the secured party from the original filing, along with the\nnew or updated secured party details." }, "v1.LienFilingUCC3AssignmentAction": { "properties": { "type": { "type": "string", "const": "ASSIGNMENT", "title": "Assignment", "description": "Indicates that this is an assignment action for a UCC-3 filing. An assignment is used to transfer some or all of the secured party's rights under the financing statement to another party.", "default": "ASSIGNMENT" }, "assignment": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3PartialAssignment" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3FullAssignment" } ], "title": "Assigment", "description": "Specifies the details of the assignment action. This can be either a partial assignment, where only some rights are transferred, or a full assignment, where all rights are transferred to the new secured party.", "discriminator": { "propertyName": "type", "mapping": { "FULL": "#/components/schemas/v1.LienFilingUCC3FullAssignment", "PARTIAL": "#/components/schemas/v1.LienFilingUCC3PartialAssignment" } } } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3AssignmentAction (v1)", "description": "Represents a UCC-3 assignment filing.\n\nThis schema models the assignment action for a UCC-3 filing,\nwhich is used to assign all or a part of a secured party's rights\nunder a financing statement to another party." }, "v1.LienFilingUCC3AuthorizingPartyDebtor": { "properties": { "role": { "type": "string", "const": "Debtor", "title": "Authorizing Party is a Debtor", "description": "Indicates that the authorizing party for this UCC-3 filing is a debtor. This is used when a debtor is authorizing changes to the financing statement, such as in cases of termination or certain types of amendments.", "default": "Debtor" }, "id": { "type": "string", "format": "uuid", "title": "Authorizing Party ID", "description": "The ID of the authorizing party (which can be a debtor, or a secured party, defined by the type).\n\n**NOTE**: If the ID of the party is a debtor but the type is `LienPartyRole.SecuredParty` or any other value other than `LienPartyRole.Debtor`, then submission will fail validation. Same validation exists if the ID of the party is a secured party but the type is `LienPartyRole.Debtor`." } }, "type": "object", "required": [ "id" ], "title": "LienFilingUCC3AuthorizingPartyDebtor (v1)", "description": "Represents an authorizing debtor in a UCC-3 filing which may also be an assignor,\nif the amendment action is an assignment." }, "v1.LienFilingUCC3AuthorizingPartySecuredParty": { "properties": { "role": { "type": "string", "const": "Secured Party", "title": "Authorizing Party is a Secured Party", "description": "Indicates that the authorizing party for this UCC-3 filing is a secured party. This is used when a secured party is authorizing changes to the financing statement, such as in cases of continuation, assignment, or certain types of amendments.", "default": "Secured Party" }, "id": { "type": "string", "format": "uuid", "title": "Authorizing Party ID", "description": "The ID of the authorizing party (which can be a debtor, or a secured party, defined by the type).\n\n**NOTE**: If the ID of the party is a debtor but the type is `LienPartyRole.SecuredParty` or any other value other than `LienPartyRole.Debtor`, then submission will fail validation. Same validation exists if the ID of the party is a secured party but the type is `LienPartyRole.Debtor`." } }, "type": "object", "required": [ "id" ], "title": "LienFilingUCC3AuthorizingPartySecuredParty (v1)", "description": "Represents an authorizing secured party in a UCC-3 filing which may also be an assignee,\nif the amendment action is an assignment." }, "v1.LienFilingUCC3CollateralAmendmentAction": { "properties": { "type": { "type": "string", "const": "COLLATERAL_AMENDMENT", "title": "Collateral Amendment", "description": "Indicates that this is a collateral amendment action for a UCC-3 filing. A collateral amendment is used to add, delete, or modify information about the collateral described in the financing statement.", "default": "COLLATERAL_AMENDMENT" }, "collateral_amendment_type": { "$ref": "#/components/schemas/LienFilingCollateralAmendmentType", "title": "Amendment Type", "description": "The type of amendment to be performed." }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsRequest" }, { "type": "null", "title": "Collateral Statements Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `collateral_statements` field of the filing document, causing no changes to this field." } ], "title": "Collateral Statements", "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.\n\n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "examples": [ { "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "collateral_statement_designation": "TRUST", "type": "ATTACHMENTS" } ] } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3CollateralAmendmentAction (v1)", "description": "Represents a UCC-3 collateral amendment filing.\n\nThis schema defines the structure for a collateral amendment action in a UCC-3 filing.\nIt is used to add, delete, or modify information about the collateral\ndescribed in a previously filed financing statement." }, "v1.LienFilingUCC3DebtorAmendmentAction": { "properties": { "type": { "type": "string", "const": "DEBTOR_AMENDMENT", "title": "Debtor Amendment", "description": "Indicates that this is a debtor amendment action for a UCC-3 filing. A debtor amendment is used to add, delete, or modify information about a debtor in the financing statement.", "default": "DEBTOR_AMENDMENT" }, "amendment": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AddDebtorAmendment" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3EditDebtorAmendment" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DeleteDebtorAmendment" }, { "type": "null", "title": "Debtor Amendment Action Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `action` field of the filing document, causing no changes to this field." } ], "title": "Debtor Amendment Action", "description": "Specifies the type of debtor amendment action to be performed. This can be adding a new debtor, editing an existing debtor's information, or deleting a debtor from the financing statement." } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3DebtorAmendmentAction (v1)", "description": "Represents a UCC-3 debtor amendment filing.\n\nRepresents a debtor amendment action for a UCC-3 filing.\nThis action is used to add, delete, or modify information about a debtor\nin a previously filed financing statement." }, "v1.LienFilingUCC3DeleteDebtorAmendment": { "properties": { "type": { "type": "string", "const": "DELETE", "title": "Delete Debtor", "description": "Indicates that this is a delete debtor action for a UCC-3 filing. A delete debtor action is used to delete an existing debtor in the financing statement.", "default": "DELETE" }, "deleted_debtor_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Deleted Debtor IDs", "description": "A list of IDs of the debtors to be deleted in the UCC-3 filing." }, { "type": "null", "title": "Deleted Debtor IDs Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `deleted_debtor_ids` field of the filing document, causing no changes to this field." } ], "title": "Deleted Debtor Ids" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3DeleteDebtorAmendment (v1)", "description": "Defines a UCC-3 delete debtor amendment filing.\n\nSpecifies a delete debtor amendment action for a UCC-3 filing.\nThis action is used to remove an existing debtor from a previously filed financing statement." }, "v1.LienFilingUCC3DeleteSecuredPartyAmendment": { "properties": { "type": { "type": "string", "const": "DELETE", "title": "Delete Secured Party", "description": "Indicates that this is a delete secured party action for a UCC-3 filing. A delete secured party action is used to delete an existing secured party in the financing statement.", "default": "DELETE" }, "deleted_secured_party_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Deleted Secured Party IDs", "description": "A list of IDs of the secured parties to be deleted in the UCC-3 filing." }, { "type": "null", "title": "Deleted Secured Party IDs Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `deleted_secured_party_ids` field of the filing document, causing no changes to this field." } ], "title": "Deleted Secured Party Ids" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3DeleteSecuredPartyAmendment (v1)", "description": "Represents a UCC-3 delete secured party amendment filing.\n\nThis schema defines the structure for a delete secured party amendment action in a UCC-3 filing.\nIt is used to remove an existing secured party from a previously filed financing statement.\nThe schema includes specific fields for identifying and deleting secured party information." }, "v1.LienFilingUCC3EditDebtorAmendment": { "properties": { "type": { "type": "string", "const": "EDIT", "title": "Edit Debtor", "description": "Indicates that this is an edit debtor action for a UCC-3 filing. An edit debtor action is used to edit an existing debtor in the financing statement.", "default": "EDIT" }, "amending_debtors": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.LienFilingUCC3AmendingDebtor" }, "type": "array", "title": "Amending Debtors", "description": "A list of debtors to be amended in the UCC-3 filing. Each entry contains the identifier of the debtor in the original filing and the new debtor information." }, { "type": "null", "title": "Amending Debtors Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amending_debtors` field of the filing document, causing no changes to this field." } ], "title": "Amending Debtors" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3EditDebtorAmendment (v1)", "description": "Defines a UCC-3 edit debtor amendment filing.\n\nSpecifies an edit debtor amendment action for a UCC-3 filing.\nThis action is used to modify information about an existing debtor\nin a previously filed financing statement." }, "v1.LienFilingUCC3EditSecuredPartyAmendment": { "properties": { "type": { "type": "string", "const": "EDIT", "title": "Edit Secured Party", "description": "Indicates that this is an edit secured party action for a UCC-3 filing. An edit secured party action is used to edit an existing secured party in the financing statement.", "default": "EDIT" }, "amending_secured_parties": { "anyOf": [ { "items": { "$ref": "#/components/schemas/v1.LienFilingUCC3AmendingSecuredParty" }, "type": "array", "title": "Amending Secured Parties", "description": "A list of secured parties to be amended in the UCC-3 filing. Each entry contains the position of the secured party in the original filing and the new secured party information." }, { "type": "null", "title": "Amending Secured Parties Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amending_secured_parties` field of the filing document, causing no changes to this field." } ], "title": "Amending Secured Parties" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3EditSecuredPartyAmendment (v1)", "description": "Represents a UCC-3 edit secured party amendment filing.\n\nRepresents an edit secured party amendment action for a UCC-3 filing.\nThis action is used to modify information about an existing secured party\nin a previously filed financing statement. It includes specific fields\nfor updating secured party details." }, "v1.LienFilingUCC3FullAssignment": { "properties": { "type": { "type": "string", "const": "FULL", "title": "Partial Assignment", "description": "Indicates a full assignment of the lien filing.\n\nIn a full assignment:\n- The entire interest in the collateral is transferred to a new secured party. \n- The original secured party relinquishes all rights to the collateral. \n- All future actions related to the financing statement will be handled by the new secured party." }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "An enumeration of secured parties implicated in the lien filing process." }, { "type": "null", "title": "Secured Parties Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `secured_parties` field of the filing document, causing no changes to this field." } ], "title": "Secured Parties" } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3FullAssignment (v1)", "description": "Represents a full assignment in a UCC-3 filing.\n\nA full assignment indicates that the entire interest in the collateral\nis transferred to a new secured party. The original secured party\nrelinquishes all rights to the collateral, and all future actions\nrelated to the financing statement will be handled by the new secured party." }, "v1.LienFilingUCC3PartialAssignment": { "properties": { "type": { "type": "string", "const": "PARTIAL", "title": "Partial Assignment", "description": "Indicates a partial assignment of the lien filing.\n\nIn a partial assignment:\n- Only a portion of the interest in the collateral is transferred to a new secured party. \n- The original secured party retains some rights to the collateral. \n- Both the original and new secured parties may have rights to take actions related to the financing statement, but only for their respective portions of the collateral." }, "secured_parties": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" }, { "$ref": "#/components/schemas/v1.LienFilingIndividualSecuredParty" } ], "discriminator": { "propertyName": "type", "mapping": { "INDIVIDUAL": "#/components/schemas/v1.LienFilingIndividualSecuredParty", "ORGANIZATION": "#/components/schemas/v1.LienFilingOrganizationSecuredParty" } } }, "type": "array", "title": "Secured Parties", "description": "An enumeration of secured parties implicated in the lien filing process." }, { "type": "null", "title": "Secured Parties Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `secured_parties` field of the filing document, causing no changes to this field." } ], "title": "Secured Parties" }, "collateral_statements": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementText" }, { "$ref": "#/components/schemas/v1.LienFilingCollateralStatementAttachmentsRequest" }, { "type": "null", "title": "Collateral Statements Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `collateral_statements` field of the filing document, causing no changes to this field." } ], "title": "Collateral Statements", "description": "This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented.\n\n> **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type=\"ATTACHMENTS\"` and use the appropriate attachment management endpoints.", "examples": [ { "text": "Commercial real estate located at 123 Business Blvd, Tech City, TX", "type": "TEXT" }, { "collateral_statement_designation": "TRUST", "type": "ATTACHMENTS" } ] } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3PartialAssignment (v1)", "description": "Represents a partial assignment in a UCC-3 filing.\n\nA partial assignment transfers only a portion of the interest in\nthe collateral to a new secured party. The original secured party retains\nsome rights to the collateral, and both parties may have rights to take\nactions related to the financing statement for their respective portions of\nthe collateral." }, "v1.LienFilingUCC3SecuredPartyAmendmentAction": { "properties": { "type": { "type": "string", "const": "SECURED_PARTY_AMENDMENT", "title": "Secured Party Amendment", "description": "Indicates that this is a secured party amendment action for a UCC-3 filing. A secured party amendment is used to add, delete, or modify information about a secured party in the financing statement.", "default": "SECURED_PARTY_AMENDMENT" }, "amendment": { "anyOf": [ { "$ref": "#/components/schemas/v1.LienFilingUCC3AddSecuredPartyAmendment" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3EditSecuredPartyAmendment" }, { "$ref": "#/components/schemas/v1.LienFilingUCC3DeleteSecuredPartyAmendment" }, { "type": "null", "title": "Secured Party Amendment Action Omitted", "description": "When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field." } ], "title": "Secured Party Amendment Action", "description": "Specifies the type of secured party amendment action to be performed. This can be adding a new secured party, editing an existing secured party's information, or deleting a secured party from the financing statement." } }, "type": "object", "required": [ "type" ], "title": "LienFilingUCC3SecuredPartyAmendmentAction (v1)", "description": "Represents a UCC-3 secured party amendment filing.\n\nThis schema defines the structure for a secured party amendment action in a UCC-3 filing.\nIt is used to add, delete, or modify information about a secured party\nin a previously filed financing statement." }, "v1.LienInitialFilingLookupRequest": { "properties": { "state": { "$ref": "#/components/schemas/StateAbbreviation", "title": "Jurisdiction State", "description": "The state abbreviation of the jurisdiction the initial financing statement is filed in.", "examples": [ "IL" ] }, "filing_number": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Initial File Number", "description": "The filing number the filing office assigned the initial financing statement (UCC-1) being amended.", "examples": [ "P98172" ] }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Initial File Date", "description": "The date the initial financing statement was filed. Optional for lookup; required when allow_unverified is true. Cannot be in the future and cannot predate the revised UCC Article 9 effective date (2001-07-01).", "examples": [ "2023-04-20" ] }, "filing_name": { "anyOf": [ { "type": "string", "maxLength": 128, "title": "Filing Name", "description": "A custom name for the filing record this lookup creates, when it creates one (only filer's reference).", "examples": [ "Acme Inc — 2023 equipment lien" ] }, { "type": "null", "title": "No Filing Name provided.", "description": "The filing name defaults to the filing number." } ], "title": "Filing Name" }, "allow_unverified": { "type": "boolean", "title": "Allow an Unverified Filing", "description": "When the filing cannot be found in Baselayer or the public record, whether to hold it anyway as an unverified imported filing built from the details supplied here. Off by default so an exploratory search creates nothing; set it only after the filer confirms the initial filing could not be verified.", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "state", "filing_number" ], "title": "LienInitialFilingLookupRequest (v1)", "description": "Request schema for resolving the initial financing statement a UCC-3\namends, from the details the filer copies off the UCC-1 (ENG-6940).\n\nThe pair a jurisdiction identifies a lien by — state and filing number —\ndrives the lookup; an optional file date cross-checks the match. Details are\nvalidated here with the same rules the console applies inline, so the\namend flow cannot be entered with data the lookup never saw." }, "v1.LienInitialFilingLookupResponse": { "properties": { "outcome": { "$ref": "#/components/schemas/LienInitialFilingLookupOutcome", "title": "Lookup Outcome", "description": "Which kind of record the lookup resolved the initial financing statement to, or `not_found` when nothing matched and no unverified filing was requested.", "examples": [ "imported" ] }, "created": { "type": "boolean", "title": "Created", "description": "Whether this lookup created the returned filing record, as opposed to resolving one the organization already held." }, "warnings": { "items": { "$ref": "#/components/schemas/LienInitialFilingLookupWarning" }, "type": "array", "title": "Warnings", "description": "Non-blocking flags about the match: a file date that disagrees with the matched filing (`filing_date_mismatch`), a file date past the filing's lapse date (`filing_date_after_lapse_date`), a filing that no longer stands (`filing_not_active`), or an unverified import whose filing has since appeared in the public record (`public_record_available`)." }, "filing": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/v1.LienFilingSubmissionUCC1Response" }, { "$ref": "#/components/schemas/v1.LienFilingSubmissionImportedResponse" } ] }, { "type": "null", "title": "No Filing Resolved", "description": "Nothing matched and no unverified filing was requested; no record was created." } ], "title": "Resolved Filing", "description": "The filing the UCC-3 amendment can target: the organization's own submission when it filed the initial financing statement through Baselayer, or its imported filing record otherwise." } }, "type": "object", "required": [ "outcome", "created", "warnings" ], "title": "LienInitialFilingLookupResponse (v1)", "description": "How the initial-filing lookup resolved, and the record a UCC-3 can now\nbe created against via ``POST /lien_submissions/{filing_id}/amend``." }, "v1.LiensSearchState": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The identifier of this liens search response." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the liens search request." }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred during the liens search request.", "examples": [ "TimeoutError: The Liens Search could not be completed." ] }, "last_updated_at": { "type": "string", "format": "date", "title": "Last Updated At", "description": "The date the lien search result was last updated.", "examples": [ "2024-06-01" ] }, "searched_states": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "States Specified for Liens Search", "description": "Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.", "examples": [ [ "CA", "GA" ] ] }, { "type": "null", "title": "Liens Search Limited to Domestic State", "description": "Indicates that the liens search was limited to the domestic state of the business. A domestic state is defined as the state where the business filed its articles of incorporation and is considered its legal home state for tax purposes. This contrasts with any other states where the business might operate as a foreign entity. The search was thus focused on liens within this domestic jurisdiction, in line with the business's legal recognition and operational base." } ], "title": "Searched States" }, "person_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Person Id", "description": "The identifier of the person associated with these lien filings.", "examples": [ "d6890508-aaad-464d-aff4-7bc0aa910006" ] }, "business_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Id", "description": "The identifier of the business associated with these lien filings.", "examples": [ "dbbb560d-2990-4af7-888c-5cc5b2d29d60" ] }, "business_search_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Business Search Id", "description": "The identifier of the business search associated with these lien filings.", "examples": [ "14360571-3fa5-4996-9288-6277350ca3c7" ] } }, "type": "object", "required": [ "id", "state", "last_updated_at" ], "title": "LiensSearchState (v1)", "description": "Represents the status of a liens search request. This includes the unique\nidentifier of the request, the current state of the request,\nand any errors that occurred during the request." }, "v1.OFACBatchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "OFAC Batch ID", "description": "The unique identifier of the OFAC batch.", "examples": [ "abb310ac-2e5d-4189-892b-23393c057970" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the ofac batch file", "examples": [ "ofac_batch_1.csv" ] }, "similarity_threshold": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Similarity Threshold", "description": "The similarity threshold for the OFAC search", "examples": [ 0.9, 0.95, 0.99 ] }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current processing state of the ofac batch", "examples": [ "COMPLETED" ] }, "entities_count": { "type": "integer", "title": "Entities Count", "description": "Total number of entities in the batch", "examples": [ 100 ] }, "valid_entities_count": { "type": "integer", "title": "Valid Entities Count", "description": "Total number of valid entities in the batch", "examples": [ 100 ] }, "entities_with_match_count": { "type": "integer", "title": "Entities With Match Count", "description": "Total number of entities with a match in the batch", "examples": [ 10 ] }, "invalid_entities_count": { "type": "integer", "title": "Invalid Entities Count", "description": "Total number of invalid entities in the batch", "examples": [ 10 ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the ofac batch was created", "examples": [ "2026-10-29T05:44:48.219668" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "When the ofac batch was updated", "examples": [ "2026-10-29T05:44:48.219684" ] } }, "type": "object", "required": [ "id", "name", "similarity_threshold", "state", "entities_count", "valid_entities_count", "entities_with_match_count", "invalid_entities_count", "created_at" ], "title": "OFACBatchResponse (v1)" }, "v1.OFACMatch": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the OFAC entity.", "examples": [ "al zawahiri dr ayman", "banco nacional de cuba" ] }, "alternative_names": { "items": { "type": "string" }, "type": "array", "title": "Alternative Names", "description": "The alternative names of the OFAC entity.", "default": [], "examples": [ [ "al zawahiri dr ayman" ] ] }, "addresses": { "items": { "type": "string" }, "type": "array", "title": "Addresses", "description": "The addresses associated with the OFAC entity.", "default": [], "examples": [ [ "123 Main St, Anytown, USA", "456 Elm St, Anytown, USA" ] ] }, "similarity_score": { "type": "number", "title": "Similarity Score", "description": "The similarity score of the OFAC entity.", "examples": [ 0.9, 0.95, 0.99 ] }, "program": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Program", "description": "The program of the OFAC entity.", "examples": [ "sdgt", "cuba" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the OFAC entity.", "examples": [ "operational and military leader of jihad group" ] }, "remarks": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remarks", "description": "Additional remarks about the OFAC entity.", "examples": [ "Designated under Executive Order 13224" ] } }, "type": "object", "required": [ "name", "similarity_score" ], "title": "OFACMatch (v1)", "description": "Model for individual OFAC match results.\n\nThis model defines the structure for individual OFAC match data." }, "v1.OFACSearchRequest": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "The name to search for in the OFAC database" }, "similarity_threshold": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Similarity Threshold", "description": "Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.", "default": 0.9 }, "limit": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Limit", "description": "The number of results to return. Max 50. Defaults to 1.", "default": 1 } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "OFACSearchRequest (v1)" }, "v1.OFACSearchResponse": { "properties": { "matches": { "items": { "$ref": "#/components/schemas/v1.OFACMatch" }, "type": "array", "title": "Matches", "description": "The list of OFAC matches." }, "total_matches": { "type": "integer", "title": "Total Matches", "description": "The total number of matches found.", "examples": [ 1, 2, 3 ] } }, "type": "object", "required": [ "matches", "total_matches" ], "title": "OFACSearchResponse (v1)", "description": "Response model for OFAC search results.\n\nThis model defines the structure for OFAC search API responses." }, "v1.OnboardingDecisionView": { "properties": { "decision": { "$ref": "#/components/schemas/ManualOnboardingDecision", "description": "Manual decision applied to the session." }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason", "description": "Reviewer's note on the decision, if any." }, "reject_reason": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingRejectReason" }, { "type": "null" } ], "description": "Why the session was rejected." }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/v1.ActedBy" }, { "type": "null" } ], "description": "Who made the decision; null on decisions recorded before the decider was stamped." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "Decision creation timestamp." } }, "type": "object", "required": [ "decision" ], "title": "OnboardingDecisionView (v1)", "description": "The latest manual review decision recorded on the session." }, "v1.OnboardingSessionReadResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Onboarding session id." }, "state": { "$ref": "#/components/schemas/ResumableWorkflowState", "description": "Lifecycle state of the resumable workflow." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id from session creation." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "The effective verdict: your reviewer's decision when one was made, otherwise what the checks concluded; null until the session completes." }, "terminal_reason": { "anyOf": [ { "$ref": "#/components/schemas/v1.IdentitySubmissionTerminalReasonResponse" }, { "type": "null" } ], "description": "Typed state and detail when the session ended in FAILED; null otherwise." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "When the session was started." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the session reached a terminal state; null until then." }, "individual_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Individual Ref", "description": "Your pairwise reference to the verified individual, stable across re-verification; the handle for credential minting. Null until approved: a session held for review gets it when a reviewer approves it. That approval is announced by `OnboardingSession.updated`." }, "business_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Ref", "description": "Your pairwise reference to the verified business. Null until approved, and when no business was verified." } }, "type": "object", "required": [ "id", "state" ], "title": "OnboardingSessionReadResponse (v1)", "description": "``GET /onboarding/sessions/{session_id}``: the session's state, plus its outcome\nfor a customer. An API key reads it without the fields the public spec\nhides; the applicant's embed reads the state alone." }, "v1.OnboardingSessionResultsResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Onboarding session id." }, "verdict": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingVerdict" }, { "type": "null" } ], "description": "Resolved onboarding verdict: the manual decision when one was made, otherwise the automated verdict from delivery." }, "manual_decision": { "anyOf": [ { "$ref": "#/components/schemas/v1.OnboardingDecisionView" }, { "type": "null" } ], "description": "Latest manual decision, when present." }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "Session creation timestamp." }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At", "description": "When the session reached terminal state." }, "reference_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference Id", "description": "Caller-supplied correlation id." }, "template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Name", "description": "Onboarding template the session ran." }, "template_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Version", "description": "Published template version the session minted from; null for draft/test sessions." }, "uploaded_document_count": { "type": "integer", "title": "Uploaded Document Count", "description": "Number of documents uploaded to the session, including uploads the applicant later replaced, so it can exceed `inputs.documents`.", "default": 0 }, "active_checks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Active Checks", "description": "Verification checks (KYC, KYB) the session's flow included, or null when unknown. Tells a check the template did not include apart from one that ran and produced no result." }, "findings": { "items": { "$ref": "#/components/schemas/OnboardingFinding" }, "type": "array", "title": "Findings", "description": "Findings recorded when the session completed: the issues that hold a session for review, plus informational evidence flags (website corroboration, officer match)." }, "inputs": { "$ref": "#/components/schemas/OnboardingInputs", "description": "What the applicant submitted during the session." }, "individual": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingIndividual" }, { "type": "null" } ], "description": "Confirmed identity of the individual; null when the session confirmed no identity." }, "business": { "anyOf": [ { "$ref": "#/components/schemas/OnboardingBusiness" }, { "type": "null" } ], "description": "Asserted + KYB-resolved business identity; null when the session collected no business." }, "owners": { "items": { "$ref": "#/components/schemas/OnboardingOwner" }, "type": "array", "title": "Owners", "description": "Beneficial owners the applicant entered, each with their per-owner KYC result, in entry order." }, "results": { "$ref": "#/components/schemas/OnboardingResults", "description": "Outcome of the session's verification checks, led by the overall verification level." } }, "type": "object", "required": [ "id", "inputs", "results" ], "title": "OnboardingSessionResultsResponse (v1)", "description": "The outcome of a completed onboarding session.\n\nThe verdict and review history, around four sections frozen when the\nsession completed: ``inputs`` (what the applicant submitted),\n``individual`` (their confirmed identity), ``business`` (the business and its\nverification), and ``results`` (the checks' outcomes)." }, "v1.PEPMatch": { "properties": { "name": { "type": "string", "title": "Name", "description": "The primary name of the PEP entity.", "examples": [ "John Doe", "Acme Corporation" ] }, "alternative_names": { "items": { "type": "string" }, "type": "array", "title": "Alternative Names", "description": "Alternative names associated with the PEP entity.", "default": [], "examples": [ [ "Johnny D.", "Acme Inc." ] ] }, "addresses": { "items": { "type": "string" }, "type": "array", "title": "Addresses", "description": "Addresses associated with the PEP entity.", "default": [], "examples": [ [ "123 Main St, Anytown", "456 Business Ave, Metropolis" ] ] }, "similarity_score": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Similarity Score", "description": "The similarity score between the search term and the matched entity name/aliases.", "examples": [ 0.9, 0.95, 1.0 ] }, "record_type": { "anyOf": [ { "$ref": "#/components/schemas/PEPRecordType" }, { "type": "null" } ], "description": "Type of the record (e.g., PERSON, ORGANIZATION).", "examples": [ "PERSON", "ORGANIZATION" ] }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/Gender" }, { "type": "null" } ], "description": "Gender of the person.", "examples": [ "M", "F" ] }, "date_of_birth": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date Of Birth", "description": "Date of birth for individuals.", "examples": [ "1980-01-15" ] }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name", "description": "First name of the person, when broken out by the source.", "examples": [ "John" ] }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name", "description": "Middle name of the person, when broken out by the source.", "examples": [ "Fitzgerald" ] }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name", "description": "Last name of the person, when broken out by the source.", "examples": [ "Doe" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Honorific title of the person.", "examples": [ "Dr." ] }, "classification": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Classification", "description": "PEP tier classification from the source dataset.", "examples": [ "National government (current)" ] }, "political_party": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Political Party", "description": "Political party affiliation.", "examples": [ "Independent" ] }, "birth_place": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Birth Place", "description": "Place (or country) of birth.", "examples": [ "Springfield, Illinois" ] }, "death_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Death Date", "description": "Date of death, if the person is deceased.", "examples": [ "2021-06-04" ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes", "description": "Free-text notes or biography from the source dataset." }, "wikidata_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wikidata Id", "description": "Public Wikidata QID of the person, useful for disambiguation.", "examples": [ "Q7747" ] }, "positions": { "items": { "$ref": "#/components/schemas/PEPPosition" }, "type": "array", "title": "Positions", "description": "Positions (occupancies) held by the person." }, "risks": { "items": { "$ref": "#/components/schemas/PEPRiskCategory" }, "type": "array", "title": "Risks", "description": "Associated risk categories.", "default": [], "examples": [ [ "GOVERNMENT_EXECUTIVE", "GOVERNMENT_FINANCIAL" ] ] }, "associated_countries": { "items": { "$ref": "#/components/schemas/ISO2CountryCode" }, "type": "array", "title": "Associated Countries", "description": "ISO2 country codes associated with the entity.", "default": [], "examples": [ [ "US", "GB" ] ] }, "emails": { "items": { "type": "string" }, "type": "array", "title": "Emails", "description": "Email addresses associated with the entity.", "default": [], "examples": [ [ "john.doe@example.com" ] ] }, "phone_numbers": { "items": { "type": "string" }, "type": "array", "title": "Phone Numbers", "description": "Phone numbers associated with the entity.", "default": [], "examples": [ [ "+1-215-555-1234" ] ] }, "websites": { "items": { "type": "string" }, "type": "array", "title": "Websites", "description": "Websites associated with the entity.", "default": [], "examples": [ [ "https://www.acme.com" ] ] }, "source_links": { "items": { "type": "string" }, "type": "array", "title": "Source Links", "description": "Links to source information.", "default": [], "examples": [ [ "https://news.example.com/article/123" ] ] } }, "type": "object", "required": [ "name", "similarity_score" ], "title": "PEPMatch (v1)", "description": "Response model for a single PEP match.\n\nThis model defines the structure for individual PEP match data." }, "v1.PEPSearchRequest": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "The name to search for in the PEP database" }, "similarity_threshold": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Similarity Threshold", "description": "Similarity threshold for the search (0.0 to 1.0). Defaults to 0.9.", "default": 0.9 }, "limit": { "type": "integer", "maximum": 50, "minimum": 1, "title": "Limit", "description": "The number of results to return. Max 50. Defaults to 1.", "default": 1 } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "PEPSearchRequest (v1)", "description": "Request model for PEP search operations.\n\nThis model defines the structure for PEP search API requests." }, "v1.PEPSearchResponse": { "properties": { "matches": { "items": { "$ref": "#/components/schemas/v1.PEPMatch" }, "type": "array", "title": "Matches", "description": "The list of PEP matches.", "default": [] }, "total_matches": { "type": "integer", "title": "Total Matches", "description": "The total number of PEP matches.", "examples": [ 1, 2, 3 ] } }, "type": "object", "required": [ "total_matches" ], "title": "PEPSearchResponse (v1)", "description": "Response model for PEP search operations.\n\nThis model defines the structure for PEP search API responses." }, "v1.PatchFederatedOrganizationRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 100, "minLength": 3 }, { "type": "null" } ], "title": "Name" }, "external_id": { "anyOf": [ { "type": "string", "maxLength": 120, "minLength": 3 }, { "type": "null" } ], "title": "External Id" } }, "additionalProperties": false, "type": "object", "title": "PatchFederatedOrganizationRequest (v1)", "description": "Request model for patching an organization's name and/or external_id." }, "v1.PersonDocketSearchRequest": { "properties": { "type": { "type": "string", "const": "Person", "title": "Type", "default": "Person" }, "person_id": { "type": "string", "format": "uuid", "title": "Person Id", "description": "ID of the person to search for." }, "options": { "items": { "$ref": "#/components/schemas/DocketSearchOptions" }, "type": "array", "minItems": 1, "title": "Options", "description": "Options controlling which types of docket searches to run. Defaults to both civil litigations and bankruptcy. Use ['Order.Litigations'] for civil dockets only, or ['Order.Bankruptcy'] for bankruptcy only.", "default": [ "Order.Litigations", "Order.Bankruptcy" ], "examples": [ [ "Order.Litigations" ], [ "Order.Bankruptcy" ], [ "Order.Litigations", "Order.Bankruptcy" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "person_id" ], "title": "PersonDocketSearchRequest (v1)", "description": "Represents a docket person search request." }, "v1.PersonLiensSearchRequest": { "properties": { "type": { "type": "string", "const": "Person", "title": "Type", "default": "Person" }, "person_id": { "type": "string", "format": "uuid", "title": "Person Id", "description": "The ID of the person the liens search task should be run against." }, "search_states": { "items": { "$ref": "#/components/schemas/StateAbbreviation" }, "type": "array", "title": "Search States", "description": "The states to search for liens in." } }, "additionalProperties": false, "type": "object", "required": [ "person_id", "search_states" ], "title": "PersonLiensSearchRequest (v1)", "description": "Represents a request to initiate a liens search for a person." }, "v1.PersonSearchRequest": { "properties": { "first_name": { "type": "string", "maxLength": 255, "minLength": 2, "title": "First Name", "description": "The first name of the person to search for.", "examples": [ "John", "Jane" ] }, "last_name": { "type": "string", "maxLength": 255, "minLength": 2, "title": "Last Name", "description": "The last name of the person to search for.", "examples": [ "Doe", "Smith" ] }, "ssn": { "anyOf": [ { "type": "string", "maxLength": 9, "minLength": 9, "description": "The full social security number of the person to search for.", "examples": [ "123456789", "123-45-6789" ] }, { "type": "string", "maxLength": 4, "minLength": 4, "description": "The last four digits of the social security number of the person to search for.", "examples": [ "1234" ] } ], "title": "Ssn" }, "middle_name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Middle Name", "description": "The middle name of the person to search for.", "examples": [ "Michael", "James", "T" ] }, "phone_number": { "anyOf": [ { "type": "string", "maxLength": 30, "minLength": 12, "pattern": "^\\+(?:[1-9]\\d{0,2})(?:[ -]?\\d{1,4}){1,4}(?:\\s?(?:x|ext\\.?)\\s?\\d{1,10})?$" }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number of the person to search for. Area code is mandatory.", "examples": [ "+14013059855", "+1 707 456 7890 x784", "+44 207-183-8750 ext. 784" ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 5, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" }, { "type": "null" } ], "title": "Email", "description": "The email address of the person to search for.", "examples": [ "john.doe@example.com", "jane.smith@example.com" ] }, "date_of_birth": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Date Of Birth", "description": "The date of birth of the person to search for.", "examples": [ "1990-01-15" ] }, "gender": { "anyOf": [ { "$ref": "#/components/schemas/Gender" }, { "type": "null" } ], "description": "The gender of the person to search for.", "examples": [ "M", "F" ] }, "address": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Address", "description": "The address of the person to search for. The state provided in this address will be used for the liens search, if selected.", "examples": [ "123 Main St, Anytown, CA 12345" ] }, "marital_status": { "anyOf": [ { "$ref": "#/components/schemas/MaritalStatus" }, { "type": "null" } ], "description": "The marital status of the person to search for.", "examples": [ "married", "single" ] }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suffix", "description": "The suffix of the person to search for.", "examples": [ "Jr.", "Sr." ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "The title of the person to search for.", "examples": [ "Mr.", "Mrs." ] }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ] }, "options": { "items": { "$ref": "#/components/schemas/PersonSearchOptions" }, "type": "array", "minItems": 1, "title": "Options", "description": "Options controlling which searches to run. At least one is required. Use ['Order.Litigations'] for civil dockets only, ['Order.Bankruptcy'] for bankruptcy only, or both for combined docket search.", "examples": [ [ "Order.Litigations" ], [ "Order.Bankruptcy" ], [ "Order.Litigations", "Order.Bankruptcy" ] ] } }, "additionalProperties": false, "type": "object", "required": [ "first_name", "last_name", "ssn", "options" ], "title": "PersonSearchRequest (v1)", "description": "Represents a person search request." }, "v1.PersonSearchStatusResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the search." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The current state of the search.", "examples": [ "COMPLETED" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Any errors that occurred.", "examples": [ "RuntimeError The Search could not be completed." ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ "IRS Validation is unavailable." ] }, "person": { "$ref": "#/components/schemas/v1.PersonResponse", "description": "The person being searched for." } }, "type": "object", "required": [ "id", "state", "person" ], "title": "PersonSearchStatusResponse (v1)", "description": "Represents a search status response." }, "v1.PortfolioItemSnapshotDiffResponse": { "properties": { "from_snapshot": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse", "description": "The source snapshot for the diff." }, "to_snapshot": { "$ref": "#/components/schemas/v1.PortfolioItemSnapshotResponse", "description": "The target snapshot for the diff." }, "json_patch": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AddOperation" }, { "$ref": "#/components/schemas/RemoveOperation" }, { "$ref": "#/components/schemas/ReplaceOperation" }, { "$ref": "#/components/schemas/MoveOperation" }, { "$ref": "#/components/schemas/CopyOperation" }, { "$ref": "#/components/schemas/CheckOperation" } ], "discriminator": { "propertyName": "op", "mapping": { "add": "#/components/schemas/AddOperation", "copy": "#/components/schemas/CopyOperation", "move": "#/components/schemas/MoveOperation", "remove": "#/components/schemas/RemoveOperation", "replace": "#/components/schemas/ReplaceOperation", "test": "#/components/schemas/CheckOperation" } } }, "type": "array", "title": "Json Patch", "description": "The diff in JSON Patch format." }, "changes": { "items": { "$ref": "#/components/schemas/v1.DiffChangeResponse" }, "type": "array", "title": "Changes", "description": "The human-readable changes extracted from the diff." } }, "type": "object", "required": [ "from_snapshot", "to_snapshot", "json_patch", "changes" ], "title": "PortfolioItemSnapshotDiffResponse (v1)", "description": "Represents a portfolio item snapshot diff response." }, "v1.PreIdentifiedBusinessSearchRequest": { "properties": { "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "The officer names to include in the search.", "examples": [ [ "Nathan Harrington", "Alexander Wolfe" ] ] }, "website": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Website", "description": "The website to include in the search.", "examples": [ "https://www.figueroa.com/" ] }, "phone_number": { "anyOf": [ { "type": "string", "maxLength": 24 }, { "type": "null" } ], "title": "Phone Number", "description": "The phone number to include in the search.", "examples": [ "436-502-9710" ] }, "email": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Email", "description": "The email to include in the search.", "examples": [ "zacharymoore@example.com" ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "The alternative names to include in the search.", "examples": [ [ "Joe's Pizza", "Joe's Pizzeria" ] ] }, "tin": { "anyOf": [ { "type": "string", "maxLength": 9, "minLength": 9 }, { "type": "null" } ], "title": "Tin", "description": "The TIN/EIN to search for.", "examples": [ "732842774" ] }, "options": { "items": { "$ref": "#/components/schemas/BusinessSearchOptions" }, "type": "array", "title": "Options", "description": "Optional features to enable during search execution.", "default": [], "examples": [ [ "Order.WebsiteAnalysis" ] ] }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the search request.", "examples": [ "Search1234" ] }, "business_token": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Business Token", "description": "An autocomplete suggestion's `token`, passed back verbatim. It replaces `name` and `address`: the search runs for the business the suggestion names and records its name and filed address. A token is bound to the organization whose session received the suggestion and is good for fifteen minutes; one from another organization is refused (422, code 3040), one past its expiry too (422, code 3042).", "examples": [ "AwICAgICAgICAgICAgbWyUlKV8H908y8yFynwrKjtdHv67GNcd2H4Pt4-3R_dX8eN20E6j1HjcHoiPU2f2le2dXT-7RWFQ" ] } }, "additionalProperties": false, "type": "object", "required": [ "business_token" ], "title": "Business token (v1)", "description": "Search for the business an autocomplete suggestion names.\n\nSend the suggestion's `business_token` in place of `name` and `address`:\nthe search is recorded with the business's name and the filed address the\nsuggestion showed, or its state when it has none on file. When the query\nnamed a person, exactly one officer of the business matched the name, and\nyou send no `officer_names`, that officer is the search's officer; a name\nthat fits two officers names neither. Sending `name` or `address` beside a\ntoken is refused (422)." }, "v1.PrefillRegistrationResponse": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the registration.", "examples": [ "Garcia, Hernandez and Woods" ] }, "issue_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Issue Date", "description": "The date the registration was issued.", "examples": [ "2024-01-01" ] }, "state": { "$ref": "#/components/schemas/StateAbbreviation", "description": "The state in which the registration was filed.", "examples": [ "AZ" ] }, "file_number": { "type": "string", "title": "File Number", "description": "The filing number of the registration.", "examples": [ "867124" ] }, "primary_address": { "anyOf": [ { "$ref": "#/components/schemas/v1.AddressSummaryResponse" }, { "type": "null" } ], "description": "The primary address of the registration, if available." }, "officers": { "items": { "type": "string" }, "type": "array", "title": "Officers", "description": "The officers associated with the registration.", "default": [], "examples": [ [ "Tyler Johnson", "John Doe" ] ] }, "alternative_names": { "items": { "type": "string" }, "type": "array", "title": "Alternative Names", "description": "The alternative names associated with the registration.", "default": [] }, "similarity_score": { "type": "number", "title": "Similarity Score", "description": "The similarity score of the registration." }, "business_name_match": { "anyOf": [ { "$ref": "#/components/schemas/MatchType" }, { "type": "null" } ], "description": "The match type between the input business name and the registration name.", "examples": [ "EXACT" ] } }, "type": "object", "required": [ "name", "state", "file_number", "similarity_score" ], "title": "PrefillRegistrationResponse (v1)" }, "v1.SentenceResponse": { "properties": { "conviction_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Conviction Date", "description": "Date of conviction. When present, may be a partial date. conviction_date_precision will always be present when conviction_date is present.", "examples": [ "2025-01-01" ] }, "conviction_date_precision": { "anyOf": [ { "$ref": "#/components/schemas/DatePrecision" }, { "type": "null" } ], "description": "The precision of the date of conviction.", "examples": [ "FULL" ] }, "details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Details", "description": "Description of the sentence.", "examples": [ "fine, 1D" ] } }, "type": "object", "title": "SentenceResponse (v1)" }, "v1.SignedURLResponse": { "properties": { "url": { "type": "string", "title": "Url", "description": "Short-lived GCS signed URL of the object. Any Content-Disposition the redirect would have carried is baked into the URL's query parameters." }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename", "description": "Filename the object downloads as, when the endpoint serves attachments; null for inline media." } }, "type": "object", "required": [ "url" ], "title": "SignedURLResponse (v1)", "description": "The signed URL behind a redirecting download endpoint, as data.\n\nBrowser XHR callers request this (``?redirect=false``) because following\nthe redirect cross-origin to GCS subjects the request's auth and tenancy\nheaders to the bucket's CORS policy; handed the URL instead, the client\nloads it bare — an ````, a navigation, or a header-less fetch —\nwhich no bucket header allow-list has to anticipate." }, "v1.TINVerificationRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "title": "Name", "description": "The name of the business to verify.", "examples": [ "Acme Corporation" ] }, "tin": { "type": "string", "maxLength": 9, "minLength": 9, "title": "Tin", "description": "The TIN/EIN to verify.", "examples": [ "123456789" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Address", "description": "The address of the business to verify.", "examples": [ "123 Main St, Anytown, USA" ] } }, "additionalProperties": false, "type": "object", "required": [ "name", "tin" ], "title": "TINVerificationRequest (v1)", "description": "Request model for TIN verification operations.\n\nThis model defines the structure for TIN verification API requests." }, "v1.TINVerificationResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "The unique identifier of the TIN verification request.", "examples": [ "d2682fdb-46fe-429c-8111-dee6db9d0eb3" ] }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key", "description": "The Idempotency-Key header the request that created this resource carried, if any." }, "state": { "$ref": "#/components/schemas/TaskState", "description": "The status of the TIN verification request.", "examples": [ "COMPLETED" ] }, "name": { "type": "string", "title": "Name", "description": "The name inputted in the search.", "examples": [ "Acme Corporation" ] }, "tin": { "type": "string", "maxLength": 9, "minLength": 9, "title": "Tin", "description": "The TIN inputted in the search.", "examples": [ "123456789" ] }, "address": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Address", "description": "The address inputted in the search.", "examples": [ "123 Main St, Anytown, USA" ] }, "tin_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tin Matched", "description": "Indicates whether the inputted TIN/EIN was a match, per the IRS.", "examples": [ true ] }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Any warnings that occurred.", "default": [], "examples": [ [ "IRS Validation is unavailable." ] ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date and time when the TIN verification request was created.", "examples": [ "2026-10-29T05:44:48.448457" ] }, "tin_match_type": { "anyOf": [ { "$ref": "#/components/schemas/IRSTINMatchType" }, { "type": "null" } ], "description": "The type of match that occurred.", "examples": [ "SSN" ] } }, "type": "object", "required": [ "id", "state", "name", "tin", "created_at" ], "title": "TINVerificationResponse (v1)", "description": "Response model for TIN verification data.\n\nThis model defines the structure for TIN verification API responses." }, "v1.WatchlistSearchMatch": { "properties": { "name": { "type": "string", "title": "Name", "description": "The matched entity's primary name.", "examples": [ "banco nacional de cuba" ] }, "similarity_score": { "type": "number", "title": "Similarity Score", "description": "Similarity of the match to the query name (0.0–1.0).", "examples": [ 0.95, 1.0 ] }, "details": { "additionalProperties": true, "type": "object", "title": "Details", "description": "Provider-specific fields for the match. Shape varies by watchlist source." } }, "type": "object", "required": [ "name", "similarity_score" ], "title": "WatchlistSearchMatch (v1)", "description": "A single matched entity within one watchlist." }, "v1.WatchlistSearchResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/v1.WatchlistSourceResult" }, "type": "array", "title": "Results", "description": "Per-source results, one entry per requested watchlist." }, "total_matches": { "type": "integer", "title": "Total Matches", "description": "Total matches returned across all searched watchlists.", "examples": [ 0, 5 ] } }, "type": "object", "required": [ "results", "total_matches" ], "title": "WatchlistSearchResponse (v1)", "description": "Response for a multi-watchlist name search, grouped by source.\n\nIncludes one ``WatchlistSourceResult`` per requested source — including\nsources with zero matches — so callers can confirm which lists were\nsearched." }, "v1.WatchlistSourceResult": { "properties": { "source": { "$ref": "#/components/schemas/WatchlistSearchSource", "description": "The watchlist these matches came from.", "examples": [ "OFAC" ] }, "matches": { "items": { "$ref": "#/components/schemas/v1.WatchlistSearchMatch" }, "type": "array", "title": "Matches", "description": "Matches found in this watchlist, highest similarity first." }, "count": { "type": "integer", "title": "Count", "description": "The number of matches returned for this watchlist (capped by the request's `limit`).", "examples": [ 0, 3 ] } }, "type": "object", "required": [ "source", "count" ], "title": "WatchlistSourceResult (v1)", "description": "Results for a single watchlist source." }, "v1.WebPresenceRequest": { "properties": { "options": { "items": { "$ref": "#/components/schemas/v1.WebPresenceRequestOptions" }, "type": "array", "title": "Options", "description": "The options for the web presence request. Defaults to Order.NaicsPrediction and Order.WebsiteAnalysis if not provided.", "examples": [ [ "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull" ] ] }, "name": { "type": "string", "title": "Name", "description": "The name of the business to search for." }, "address": { "type": "string", "title": "Address", "description": "The address of the business." }, "iso2_country_code": { "anyOf": [ { "$ref": "#/components/schemas/ISO2CountryCode" }, { "type": "null" } ], "description": "The ISO 2 country code of the business. Omit it for a US business. US territories (PR, VI, GU, AS) are treated as US; any other code runs the international analysis.", "examples": [ "US" ] }, "alternative_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 10, "uniqueItems": true }, { "type": "null" } ], "title": "Alternative Names", "description": "Alternative names for the business (e.g., DBA names)", "examples": [ "Orginal Ray's Pizza", "Ray's Famous Pizza" ] }, "officer_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Officer Names", "description": "List of business officers' names." }, "website": { "anyOf": [ { "type": "string", "maxLength": 2083 }, { "type": "null" } ], "title": "Website", "description": "The website URL associated with the business." }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number", "description": "A phone number associated with the business." }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "An email address associated with the business." }, "reference_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Reference Id", "description": "An optional reference ID to associate with the web presence request.", "examples": [ "WebPresence1234" ] }, "social_profiles": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InputSocialProfile" }, "type": "array", "maxItems": 10 }, { "type": "null" } ], "title": "Social Profiles", "description": "Social media profiles associated with the business." } }, "additionalProperties": false, "type": "object", "required": [ "name", "address" ], "title": "WebPresenceRequest (v1)" }, "v1.LienFilingImportBatchResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Import Batch ID", "description": "The batch's id, used to poll status and fetch per-row results." }, "name": { "type": "string", "title": "Name", "description": "The name of the batch, taken from the uploaded file.", "examples": [ "q3-portfolio-liens.csv" ] }, "state": { "$ref": "#/components/schemas/TaskState", "title": "State", "description": "Processing state of the batch.", "examples": [ "PENDING" ] }, "total_count": { "type": "integer", "title": "Total Count", "description": "Rows read from the uploaded CSV, excluding blank lines.", "examples": [ 100 ] }, "imported_count": { "type": "integer", "title": "Imported Count", "description": "Rows that resolved against the public record and produced a newly imported filing.", "default": 0, "examples": [ 80 ] }, "already_imported_count": { "type": "integer", "title": "Already Imported Count", "description": "Rows naming a lien the organization had already imported; the existing filing is kept.", "default": 0, "examples": [ 15 ] }, "not_found_count": { "type": "integer", "title": "Not Found Count", "description": "Rows whose state and filing number matched nothing in the public record.", "default": 0, "examples": [ 4 ] }, "invalid_row_count": { "type": "integer", "title": "Invalid Row Count", "description": "Rows rejected before resolution (unparseable state, blank filing number, and the like).", "default": 0, "examples": [ 1 ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error", "description": "Why the batch last failed, as a human-readable message. Set when the state is FAILED; a batch that failed once and succeeded on a resume can still carry the message from that attempt, so read it alongside the state rather than as a failure signal on its own.", "examples": [ "The uploaded CSV could not be read from storage." ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the batch was accepted." }, "completed_count": { "type": "integer", "title": "Completed Count", "description": "Rows processed so far, whatever their outcome — the sum of the four outcome counts.", "readOnly": true, "examples": [ 0, 50 ] }, "progress": { "type": "number", "title": "Progress", "description": "Fraction of the uploaded rows processed so far, in [0, 1].", "readOnly": true, "examples": [ 0.0, 0.5, 1.0 ] } }, "type": "object", "required": [ "id", "name", "state", "total_count", "created_at", "completed_count", "progress" ], "title": "LienFilingImportBatchResponse (v1)", "description": "A bulk lien import (ENG-6884) — returned when one is accepted, by the\npolling endpoint, and as the payload of its completion/failure webhooks.\n\nThe four outcome counts partition the rows processed so far: every completed\nrow is exactly one of imported / already imported / not found / invalid." }, "v1.ConsortiumMatchType": { "type": "string", "enum": [ "TIN", "PHONE", "EMAIL", "WEBSITE", "BUSINESS_NAME", "OFFICER", "ADDRESS", "BUSINESS_ID" ], "title": "ConsortiumMatchType", "description": "The identifier pass that produced a hit.\n\nBusiness-name and officer matches are distinct types (not a single ``name``)\nso a hit's ``matched_value`` is always the input that actually matched — an\nofficer hit on a clean business reads as OFFICER(\"John Doe\"), never as the\napplicant's unrelated business name." }, "v1.VerificationSortField": { "type": "string", "enum": [ "created_at", "updated_at" ], "title": "VerificationSortField", "description": "What the verifications list sorts by." }, "v1.WebPresenceRequestOptions": { "type": "string", "enum": [ "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull", "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.DirectoryListing" ] } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" } } } }