> ## Documentation Index > Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Person Search ## OpenAPI ````yaml /api-reference/openapi.json get /person_searches/{id} openapi: 3.1.0 info: title: baselayer-api-service version: 0.1.0 servers: - url: https://api.baselayer.com/ security: [] paths: /person_searches/{id}: get: tags: - Person Search summary: Get Person Search operationId: get_person_search_person_searches__id__get 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' security: - APIKeyHeader: [] components: schemas: v1.PersonSearchResponse: properties: id: type: string format: uuid title: Id description: The unique identifier of the search. 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-08-31T10:31:07.839963' updated_at: anyOf: - format: date-time type: string - type: 'null' title: Updated At description: >- The datetime the search was updated at (generally when the search completed). examples: - '2026-08-31T10:31:07.839973' 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. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TaskState: enum: - PENDING - EXECUTING - COMPLETED - FAILED - CANCELLED title: TaskState type: string v1.PersonResponse: properties: id: description: The unique identifier of the person examples: - 3605eec5-940f-4d54-9d48-da1cffe940ac 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: - type: string format: date - 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 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 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.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: - type: string format: date - 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.LienFilingResponse: description: |- Contains detailed information about a lien filing, including the filing number, type, date, status, and associated business and search request. The 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.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.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.BankruptcyType: enum: - Chapter 7 - Chapter 9 - Chapter 11 - Chapter 12 - Chapter 13 - Chapter 15 title: BankruptcyType type: string 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.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: - type: string format: date - 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.MatchType: enum: - NO_MATCH - SIMILAR - EXACT title: MatchType type: string v1.BusinessOrPersonType: enum: - Business - Person title: BusinessOrPersonType type: string v1.DocketMatchConfidenceResponse: description: |- How likely a docket involves the search subject: a confidence level plus 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.RiskLevel: enum: - high - medium - low - no_risk title: RiskLevel type: string v1.NormalizedDocketStatus: enum: - open - closed title: NormalizedDocketStatus 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.LienPartyResponse: description: >- Represents an entity involved in a lien as either a debtor or a secured party. This 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. A computed property that returns the role of the lien party. Note: 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.LienAmendmentResponse: description: |- Represents a change or update to a lien filing, such as a continuation, termination, 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.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 recorded in a UCC filing. Each statement details the specific assets secured by the lien and is sorted by a 'sort_order' to maintain the 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.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.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.ConfidenceLevel: enum: - high - medium - low title: ConfidenceLevel type: string v1.DocketAddressMatchType: description: |- Court-venue-vs-subject-state signal for docket match_confidence. Distinct from `AddressMatchType` (KYB/international address comparison, above) — 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 match_confidence. enum: - CONSISTENT - INCONSISTENT - UNKNOWN title: DocketDateMatchType type: string v1.LienPartyRole: description: |- Enum class delineating the role of parties in a lien transaction as defined by the UCC. enum: - Debtor - Secured Party - Record Owner title: LienPartyRole type: string v1.AddressSummaryResponse: description: |- Response model for address summary data. This 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.AddressRDI: enum: - Residential - Commercial title: AddressRDI type: string v1.USPSDeliveryType: description: |- Enum representing the different types of USPS delivery points. Used 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 securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ````