openapi: 3.2.0 info: title: Fama External Interface Public API description: Public endpoints. version: dev servers: - url: https://public-api-sandbox.fama.io description: Sandbox server for testing security: - bearerAuth: [] tags: - name: PublicAPI description: endpoints intended for direct use paths: /behavior_kit/{behavior_kit_uuid}: get: tags: - PublicAPI summary: Get Behavior Kit description: Retrieve details for a specific behavior kit by behavior kit UUID, including its name, lookback period, image display setting, configured behaviors, and keyword groups. operationId: _get_behavior_kit_behavior_kit__behavior_kit_uuid__get parameters: - required: true schema: type: string format: uuid title: Behavior Kit Uuid name: behavior_kit_uuid in: path description: The UUID of the behavior kit to retrieve. examples: sample: summary: Sample behavior kit UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: object title: BehaviorKit required: - uuid - name - display_images properties: uuid: type: string format: uuid title: Uuid description: The UUID of the behavior kit. name: type: string title: Name description: The behavior kit name. lookback_months: type: integer title: Lookback Months description: The number of months included in the behavior kit lookback period. display_images: type: boolean title: Display Images description: Indicates whether images are displayed for the behavior kit. behaviors: type: array title: Behaviors description: The behaviors configured for the behavior kit. items: type: string default: [] keyword_groups: type: array title: Keyword Groups description: The keyword groups configured for the behavior kit. items: type: object title: KeywordGroup required: - name properties: name: type: string title: Name description: The keyword group name. include_exact: type: array title: Include Exact description: Exact keywords included in the keyword group. items: type: string default: [] include_fuzzy: type: array title: Include Fuzzy description: Fuzzy-match keywords included in the keyword group. items: type: string default: [] exclude_exact: type: array title: Exclude Exact description: Exact keywords excluded from the keyword group. items: type: string default: [] exclude_fuzzy: type: array title: Exclude Fuzzy description: Fuzzy-match keywords excluded from the keyword group. items: type: string default: [] default: [] examples: behaviorKit: summary: Behavior kit details value: uuid: 123e4567-e89b-12d3-a456-426614174000 name: Example Behavior Kit lookback_months: 84 display_images: true behaviors: - adverse - community keyword_groups: - name: Example Keyword Group include_exact: - example keyword include_fuzzy: - related keyword exclude_exact: - excluded keyword exclude_fuzzy: - excluded related keyword '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidBehaviorKitUuid: summary: Invalid behavior kit UUID value: detail: - loc: - path - behavior_kit_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get behavior kit details code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/behavior_kit/123e4567-e89b-12d3-a456-426614174000 \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /check_type/{check_type_uuid}: get: tags: - PublicAPI summary: Get Check Type description: Retrieve details for a specific check type by check type UUID, including its name, report type, lookback period, SLA, item types, item sources, and configured behaviors. operationId: _get_check_type_check_type__check_type_uuid__get parameters: - required: true schema: type: string format: uuid title: Check Type Uuid name: check_type_uuid in: path responses: '200': description: Successful Response content: application/json: schema: type: object title: CheckType required: - check_type_uuid - name - lookback_months - sla_hours - report_type properties: check_type_uuid: type: string format: uuid title: Check Type Uuid name: type: string title: Name item_types: type: array title: Item Types items: type: string default: [] item_sources: type: array title: Item Sources items: type: string default: [] behaviors: type: array title: Behaviors items: type: string default: [] lookback_months: type: integer title: Lookback Months sla_hours: type: integer title: Sla Hours report_type: type: string title: Report Type '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type /company/{company_uuid}: get: tags: - PublicAPI summary: Get Company description: Retrieve company details by company UUID. Use this endpoint to confirm the company name and parent company relationship before requesting checks or reviewing check status records. operationId: _get_company_company__company_uuid__get parameters: - required: true schema: type: string format: uuid title: Company Uuid name: company_uuid in: path description: The UUID of the company to retrieve. examples: sample: summary: Sample company UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: object title: CompanyDetail required: - company_uuid - name properties: company_uuid: type: string format: uuid title: Company Uuid description: The UUID of the company. parent_company_uuid: type: string format: uuid title: Parent Company Uuid description: The UUID of the parent company, when the company belongs to a parent company. name: type: string title: Name description: The company name. examples: company: summary: Company details value: company_uuid: 123e4567-e89b-12d3-a456-426614174000 parent_company_uuid: 987e6543-e21b-12d3-a456-426614174999 name: Example Company '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidCompanyUuid: summary: Invalid company UUID value: detail: - loc: - path - company_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get company details code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/company/123e4567-e89b-12d3-a456-426614174000 \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /company/{company_uuid}/check: post: tags: - PublicAPI summary: Request Check operationId: _request_check_company__company_uuid__check_post parameters: - required: true schema: type: string format: uuid title: Company Uuid name: company_uuid in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CheckResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Submit a new check request, validate the required request fields, and follow the next steps to monitor status and retrieve report data. get: tags: - PublicAPI summary: Check Status operationId: _check_status_company__company_uuid__check_get parameters: - required: true schema: type: string format: uuid title: Company Uuid name: company_uuid in: path - description: Only checks created after specified date and time in UTC required: false schema: type: string format: date-time title: Created At Gt description: Only checks created after specified date and time in UTC name: created_at_gt in: query - description: Only checks created before specified date and time in UTC required: false schema: type: string format: date-time title: Created At Lt description: Only checks created before specified date and time in UTC name: created_at_lt in: query - description: Search by name required: false schema: type: string maxLength: 50 title: Search description: Search by name name: search in: query - description: Filter by Status required: false schema: allOf: - $ref: '#/components/schemas/fama_interfaces__workflow_dal__Status' description: Filter by Status name: status in: query - description: Which page to fetch, default=1 required: false schema: type: integer title: Page description: Which page to fetch, default=1 default: 1 name: page in: query - description: Number of items per page, default=50 required: false schema: type: integer title: Size description: Number of items per page, default=50 default: 50 max: 50 min: 1 name: size in: query responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/CheckStatus' type: array title: Response Check Status Company Company Uuid Check Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Retrieve check status records for a company, filter results by date, name, status, or pagination, and use report UUIDs to fetch report data. /me: get: tags: - PublicAPI summary: Get Me description: Retrieve information for the authenticated API user. Use this endpoint to confirm that your bearer token is valid and associated with an active user. operationId: _get_me_me_get parameters: [] responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type x-readme: code-samples: - language: curl name: Get authenticated user code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/me \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /my_behavior_kits: get: tags: - PublicAPI summary: Get My Behavior Kits description: Retrieve the behavior kits available to the authenticated user. If your user has access to multiple companies, pass `company_uuid` to return behavior kits for a specific company. operationId: _get_my_behavior_kits_my_behavior_kits_get parameters: - description: The UUID of the company to retrieve behavior kits for. Use this parameter when the authenticated user has access to multiple companies. required: false schema: type: string format: uuid title: Company Uuid description: The UUID of the company to retrieve behavior kits for. name: company_uuid in: query examples: sample: summary: Sample company UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: array title: Response Get My Behavior Kits items: type: object title: BehaviorKit required: - uuid - name - display_images properties: uuid: type: string format: uuid title: Uuid description: The UUID of the behavior kit. name: type: string title: Name description: The behavior kit name. lookback_months: type: integer title: Lookback Months description: The number of months included in the behavior kit lookback period. display_images: type: boolean title: Display Images description: Indicates whether images are displayed for the behavior kit. behaviors: type: array title: Behaviors description: The behaviors configured for the behavior kit. items: type: string default: [] keyword_groups: type: array title: Keyword Groups description: The keyword groups configured for the behavior kit. items: type: object title: KeywordGroup required: - name properties: name: type: string title: Name description: The keyword group name. include_exact: type: array title: Include Exact description: Exact keywords included in the keyword group. items: type: string default: [] include_fuzzy: type: array title: Include Fuzzy description: Fuzzy-match keywords included in the keyword group. items: type: string default: [] exclude_exact: type: array title: Exclude Exact description: Exact keywords excluded from the keyword group. items: type: string default: [] exclude_fuzzy: type: array title: Exclude Fuzzy description: Fuzzy-match keywords excluded from the keyword group. items: type: string default: [] default: [] examples: behaviorKits: summary: Available behavior kits value: - uuid: 123e4567-e89b-12d3-a456-426614174001 name: Example Behavior Kit lookback_months: 84 display_images: true behaviors: - adverse - community keyword_groups: - name: Example Keyword Group include_exact: - example keyword include_fuzzy: - related keyword exclude_exact: - excluded keyword exclude_fuzzy: - excluded related keyword '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidCompanyUuid: summary: Invalid company UUID value: detail: - loc: - query - company_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get available behavior kits code: "curl --request GET \\\n --url 'https://public-api-sandbox.fama.io/my_behavior_kits?company_uuid=123e4567-e89b-12d3-a456-426614174000' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /my_check_types: get: tags: - PublicAPI summary: Get My Check Types description: Retrieve the check types available to the authenticated user. If your user has access to multiple companies, pass `company_uuid` to return check types for a specific company. operationId: _get_my_check_types_my_check_types_get parameters: - description: The UUID of the company to retrieve check types for. Use this parameter when the authenticated user has access to multiple companies. required: false schema: type: string format: uuid title: Company Uuid description: The UUID of the company to retrieve check types for. name: company_uuid in: query examples: sample: summary: Sample company UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: array title: Response Get My Check Types items: type: object title: BasicInfo required: - uuid - name properties: uuid: type: string format: uuid title: Uuid description: The UUID of the check type. name: type: string title: Name description: The check type name. examples: checkTypes: summary: Available check types value: - uuid: 123e4567-e89b-12d3-a456-426614174001 name: Check Type Name - uuid: 123e4567-e89b-12d3-a456-426614174002 name: Another Check Type Name '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidCompanyUuid: summary: Invalid company UUID value: detail: - loc: - query - company_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get available check types code: "curl --request GET \\\n --url 'https://public-api-sandbox.fama.io/my_check_types?company_uuid=123e4567-e89b-12d3-a456-426614174000' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/pdf: get: tags: - PublicAPI summary: Download Report Pdf description: Download the PDF for a report by report UUID. A successful request returns a redirect response for the report PDF. operationId: _download_report_pdf_report__report_uuid__pdf_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report PDF to download. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '307': description: Successful response. Follow the redirect in the `Location` header to download the report PDF. This response does not return a JSON body. headers: Location: description: Redirect URL for the report PDF. schema: type: string format: uri examples: pdfRedirect: summary: PDF redirect URL value: https://example.com/report.pdf '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Request report PDF code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/pdf \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/person: get: tags: - PublicAPI summary: Get Person description: Retrieve the person details associated with a report by report UUID, including names, emails, addresses, jobs, degrees, identifications, and phone numbers. operationId: _get_person_report__report_uuid__person_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report associated with the person to retrieve. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: object title: Person required: - emails - names properties: person_uuid: type: string format: uuid title: Person Uuid description: The UUID of the person. birth_date: type: string title: Birth Date description: The person's birth date. addresses: type: array title: Addresses description: Addresses associated with the person. items: type: object title: Address required: - country properties: line1: type: string maxLength: 255 title: Line1 description: The first line of the address. default: '' line2: type: string maxLength: 255 title: Line2 description: The second line of the address. default: '' city: type: string maxLength: 255 title: City description: The address city. default: '' state: type: string maxLength: 255 title: State description: The address state or region. default: '' zip: type: string maxLength: 255 title: Zip description: The address postal code. default: '' country: type: string maxLength: 255 title: Country description: The address country. start_date: type: string format: date title: Start Date description: The date the person started using this address. end_date: type: string format: date title: End Date description: The date the person stopped using this address. default: [] degrees: type: array title: Degrees description: Education records associated with the person. items: type: object title: Degree required: - name - educator - country properties: name: type: string maxLength: 255 title: Name description: The degree name. educator: type: string maxLength: 255 title: Educator description: The school or institution that issued the degree. country: type: string maxLength: 255 title: Country description: The country where the degree was issued. start_date: type: string title: Start Date description: The degree start date. end_date: type: string title: End Date description: The degree end date. default: [] emails: type: array minItems: 1 title: Emails description: Email addresses associated with the person. items: type: object title: Email required: - address properties: address: type: string format: email title: Address description: The person's email address. email_type: type: string enum: - PERSONAL - PROFESSIONAL title: EmailType description: The email address type. default: PERSONAL identifications: type: array title: Identifications description: Identification records associated with the person. items: type: object title: Identification properties: unique_id: type: string maxLength: 255 title: Unique Id description: An identification value, such as an SSN or criminal record identifier. default: '' description: type: string maxLength: 255 title: Description description: A description of the identification record. default: '' start_date: type: string format: date title: Start Date description: The identification start date. end_date: type: string format: date title: End Date description: The identification end date. default: [] jobs: type: array title: Jobs description: Employment records associated with the person. items: type: object title: Job required: - title - employer - country properties: title: type: string maxLength: 255 title: Title description: The job title. employer: type: string maxLength: 255 title: Employer description: The employer name. country: type: string maxLength: 255 title: Country description: The country where the job was located. start_date: type: string title: Start Date description: The job start date. end_date: type: string title: End Date description: The job end date. default: [] names: type: array minItems: 1 title: Names description: Names associated with the person. items: type: object title: Name required: - first_name - last_name properties: prefix: type: string maxLength: 255 title: Prefix description: The name prefix. default: '' first_name: type: string maxLength: 255 title: First Name description: The person's first name. middle_name: type: string maxLength: 255 title: Middle Name description: The person's middle name. default: '' last_name: type: string maxLength: 255 title: Last Name description: The person's last name. suffix: type: string maxLength: 255 title: Suffix description: The name suffix. default: '' name_type: type: string enum: - ALIAS - MAIN title: NameType description: The name type. default: MAIN phones: type: array title: Phones description: Phone numbers associated with the person. items: type: object title: Phone required: - raw_number properties: raw_number: type: string maxLength: 255 title: Raw Number description: The phone number. start_date: type: string format: date title: Start Date description: The date the person started using this phone number. end_date: type: string format: date title: End Date description: The date the person stopped using this phone number. phone_type: type: string enum: - PERSONAL - PROFESSIONAL title: PhoneType description: The phone number type. default: PERSONAL default: [] examples: person: summary: Person details value: person_uuid: 123e4567-e89b-12d3-a456-426614174001 birth_date: '1990-01-01' names: - prefix: '' first_name: Jane middle_name: A last_name: Doe suffix: '' name_type: MAIN emails: - address: jane.doe@example.com email_type: PERSONAL addresses: - line1: 123 Main Street line2: '' city: Los Angeles state: CA zip: '90001' country: US start_date: '2020-01-01' end_date: '2024-01-01' degrees: - name: Bachelor of Arts educator: Example University country: US start_date: '2008-09-01' end_date: '2012-05-31' identifications: - unique_id: example-id description: Example identification record start_date: '2020-01-01' end_date: '2024-01-01' jobs: - title: Example Job Title employer: Example Employer country: US start_date: '2021-01-01' end_date: '2024-01-01' phones: - raw_number: '+15555550100' start_date: '2020-01-01' end_date: '2024-01-01' phone_type: PERSONAL '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get person details code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/person \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/posts: get: tags: - PublicAPI summary: Get Posts description: Retrieve posts associated with a report by report UUID. Use pagination parameters to page through post results and review each post's URL, text, type, keywords, and behaviors. operationId: _get_posts_report__report_uuid__posts_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report associated with the posts to retrieve. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 - description: Which page to fetch. Defaults to `1`. required: false schema: type: integer title: Page description: Which page to fetch. Defaults to `1`. default: 1 name: page in: query examples: firstPage: summary: First page value: 1 - description: Number of items per page. Defaults to `50`. required: false schema: type: integer title: Size description: Number of items per page. Defaults to `50`. default: 50 name: size in: query examples: defaultSize: summary: Default page size value: 50 responses: '200': description: Successful Response content: application/json: schema: type: object title: XPage[Post] required: - data - offset - size properties: data: type: array title: Data description: The posts returned for the current page. items: type: object title: Post required: - url - text - type properties: url: type: string title: Url description: The URL associated with the post. text: type: string title: Text description: The text content of the post. type: type: string title: Type description: The post type. keywords: type: array title: Keywords description: Keywords matched in the post. items: type: string default: [] behaviors: type: array title: Behaviors description: Behaviors associated with the post. items: type: string default: [] offset: type: integer title: Offset description: The result offset for the current page. size: type: integer title: Size description: The number of post records returned in the current page. next: type: integer title: Next description: The next page value, when more post records are available. examples: posts: summary: Paginated post results value: data: - url: https://example.com/posts/1 text: Example post text type: post keywords: - example keyword behaviors: - adverse - url: https://example.com/posts/2 text: Another example post text type: post keywords: [] behaviors: - community offset: 0 size: 50 next: 2 '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get report posts code: "curl --request GET \\\n --url 'https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/posts?page=1&size=50' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/profiles: get: tags: - PublicAPI summary: Get Profiles description: Retrieve social profile URLs associated with a report by report UUID. Use pagination parameters to page through profile results. operationId: _get_profiles_report__report_uuid__profiles_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report associated with the profiles to retrieve. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 - description: Which page to fetch. Defaults to `1`. required: false schema: type: integer title: Page description: Which page to fetch. Defaults to `1`. default: 1 name: page in: query examples: firstPage: summary: First page value: 1 - description: Number of items per page. Defaults to `50`. required: false schema: type: integer title: Size description: Number of items per page. Defaults to `50`. default: 50 name: size in: query examples: defaultSize: summary: Default page size value: 50 responses: '200': description: Successful Response content: application/json: schema: type: object title: XPage[Profile] required: - data - offset - size properties: data: type: array title: Data description: The profiles returned for the current page. items: type: object title: Profile required: - url properties: url: type: string title: Url description: The profile URL associated with the report. offset: type: integer title: Offset description: The result offset for the current page. size: type: integer title: Size description: The number of profile records returned in the current page. next: type: integer title: Next description: The next page value, when more profile records are available. examples: profiles: summary: Paginated profile results value: data: - url: https://www.linkedin.com/in/example-profile - url: https://twitter.com/example_profile offset: 0 size: 50 next: 2 '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get report profiles code: "curl --request GET \\\n --url 'https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/profiles?page=1&size=50' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/summary: get: tags: - PublicAPI summary: Get Summary description: Retrieve aggregate summary counts for a completed report by report UUID. Use this endpoint to get totals for posts, web content, adverse findings, community findings, keywords, and overall results. operationId: _get_summary_report__report_uuid__summary_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report to summarize. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Successful Response content: application/json: schema: type: object title: ReportSummary required: - posts - web_content - adverse - community - keywords - total properties: posts: type: integer title: Posts description: Total number of posts included in the report summary. web_content: type: integer title: Web Content description: Total number of web content items included in the report summary. adverse: type: integer title: Adverse description: Total number of adverse findings in the report summary. community: type: integer title: Community description: Total number of community findings in the report summary. keywords: type: integer title: Keywords description: Total number of keyword findings in the report summary. total: type: integer title: Total description: Overall total count across the summarized report results. examples: summary: summary: Report summary value: posts: 42 web_content: 18 adverse: 3 community: 2 keywords: 7 total: 60 '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get report summary code: "curl --request GET \\\n --url https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/summary \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" /report/{report_uuid}/web_content: get: tags: - PublicAPI summary: Get Web Content description: Retrieve web content associated with a report by report UUID. Use pagination parameters to page through web content results and review each item's URL, title, content, and behaviors. operationId: _get_web_content_report__report_uuid__web_content_get parameters: - required: true schema: type: string format: uuid title: Report Uuid name: report_uuid in: path description: The UUID of the report associated with the web content to retrieve. examples: sample: summary: Sample report UUID value: 123e4567-e89b-12d3-a456-426614174000 - description: Which page to fetch. Defaults to `1`. required: false schema: type: integer title: Page description: Which page to fetch. Defaults to `1`. default: 1 name: page in: query examples: firstPage: summary: First page value: 1 - description: Number of items per page. Defaults to `50`. required: false schema: type: integer title: Size description: Number of items per page. Defaults to `50`. default: 50 name: size in: query examples: defaultSize: summary: Default page size value: 50 responses: '200': description: Successful Response content: application/json: schema: type: object title: XPage[WebContent] required: - data - offset - size properties: data: type: array title: Data description: The web content items returned for the current page. items: type: object title: WebContent required: - url - title - content properties: url: type: string title: Url description: The URL associated with the web content item. title: type: string title: Title description: The title of the web content item. content: type: string title: Content description: The text content extracted from the web content item. behaviors: type: array title: Behaviors description: Behaviors associated with the web content item. items: type: string default: [] offset: type: integer title: Offset description: The result offset for the current page. size: type: integer title: Size description: The number of web content records returned in the current page. next: type: integer title: Next description: The next page value, when more web content records are available. examples: webContent: summary: Paginated web content results value: data: - url: https://example.com/articles/1 title: Example article title content: Example web content text. behaviors: - adverse - url: https://example.com/articles/2 title: Another example article title content: Another example web content text. behaviors: - community offset: 0 size: 50 next: 2 '422': description: Validation Error content: application/json: schema: type: object title: HTTPValidationError properties: detail: type: array title: Detail items: type: object title: ValidationError required: - loc - msg - type properties: loc: type: array title: Location items: oneOf: - type: string - type: integer msg: type: string title: Message type: type: string title: Error Type examples: invalidReportUuid: summary: Invalid report UUID value: detail: - loc: - path - report_uuid msg: value is not a valid uuid type: type_error.uuid x-readme: code-samples: - language: curl name: Get report web content code: "curl --request GET \\\n --url 'https://public-api-sandbox.fama.io/report/123e4567-e89b-12d3-a456-426614174000/web_content?page=1&size=50' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'" components: schemas: CheckRequest: properties: person: $ref: '#/components/schemas/external_interface__public_api__interfaces__Person' check_types: items: $ref: '#/components/schemas/external_interface__public_api__interfaces__CheckTypeRequest' type: array minItems: 1 title: Check Types profiles: items: type: string type: array title: Profiles default: [] rerun_from_parent_uuid: type: string format: uuid title: Rerun From Parent Uuid qa: type: boolean title: Qa recur: $ref: '#/components/schemas/RecurSchedule' type: object required: - person - check_types title: CheckRequest fama_interfaces__workflow_dal__Status: type: string enum: - TO_DO - IN_PROGRESS - DONE - FAILED - TIMEOUT - CANCELLED title: Status description: An enumeration. InstantFitFields: properties: job_title: type: string maxLength: 255 title: Job Title default: None job_requisition_number: type: string maxLength: 255 title: Job Requisition Number reference: type: string maxLength: 255 title: Reference assignment: type: string maxLength: 255 title: Assignment writing_sample: type: string title: Writing Sample type: object required: - job_requisition_number title: InstantFitFields ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ScheduleType: type: string enum: - cron - interval - other title: ScheduleType description: An enumeration. EmailType: type: string enum: - PERSONAL - PROFESSIONAL title: EmailType description: An enumeration. CheckStatus: properties: report_uuid: type: string format: uuid title: Report Uuid client_report_id: type: string title: Client Report Id name: type: string title: Name company_uuid: type: string format: uuid title: Company Uuid parent_company_uuid: type: string format: uuid title: Parent Company Uuid check_type_uuid: type: string format: uuid title: Check Type Uuid behavior_kit_uuid: type: string format: uuid title: Behavior Kit Uuid status: $ref: '#/components/schemas/fama_interfaces__workflow_dal__Status' created_at: type: string format: date-time title: Created At finished_at: type: string format: date-time title: Finished At type: object required: - report_uuid - client_report_id - name - company_uuid - check_type_uuid - status - created_at title: CheckStatus Address: properties: line1: type: string maxLength: 255 title: Line1 default: '' line2: type: string maxLength: 255 title: Line2 default: '' city: type: string maxLength: 255 title: City default: '' state: type: string maxLength: 255 title: State default: '' zip: type: string maxLength: 255 title: Zip default: '' country: type: string maxLength: 255 title: Country start_date: type: string format: date title: Start Date end_date: type: string format: date title: End Date type: object required: - country title: Address HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError NameType: type: string enum: - ALIAS - MAIN title: NameType description: An enumeration. MisconductFields: properties: custom_id: type: string maxLength: 255 title: Custom Id assessment_id: type: string maxLength: 255 title: Assessment Id job_title: type: string maxLength: 255 title: Job Title type: object title: MisconductFields external_interface__public_api__interfaces__Person: properties: person_uuid: type: string format: uuid title: Person Uuid birth_date: type: string title: Birth Date addresses: items: $ref: '#/components/schemas/Address' type: array title: Addresses default: [] degrees: items: $ref: '#/components/schemas/external_interface__public_api__interfaces__Degree' type: array title: Degrees default: [] emails: items: $ref: '#/components/schemas/external_interface__public_api__interfaces__Email' type: array minItems: 1 title: Emails identifications: items: $ref: '#/components/schemas/Identification' type: array title: Identifications default: [] jobs: items: $ref: '#/components/schemas/external_interface__public_api__interfaces__Job' type: array title: Jobs default: [] names: items: $ref: '#/components/schemas/Name' type: array minItems: 1 title: Names phones: items: $ref: '#/components/schemas/external_interface__public_api__interfaces__Phone' type: array title: Phones default: [] type: object required: - emails - names title: Person external_interface__public_api__interfaces__Phone: properties: raw_number: type: string maxLength: 255 title: Raw Number start_date: type: string format: date title: Start Date end_date: type: string format: date title: End Date phone_type: allOf: - $ref: '#/components/schemas/PhoneType' default: PERSONAL type: object required: - raw_number title: Phone external_interface__public_api__interfaces__CheckTypeRequest: properties: check_type_uuid: type: string format: uuid title: Check Type Uuid behavior_kit_uuid: type: string format: uuid title: Behavior Kit Uuid custom_fields: anyOf: - $ref: '#/components/schemas/MisconductFields' - $ref: '#/components/schemas/InstantFitFields' title: Custom Fields default: {} type: object required: - check_type_uuid title: CheckTypeRequest external_interface__public_api__interfaces__Degree: properties: name: type: string maxLength: 255 title: Name educator: type: string maxLength: 255 title: Educator country: type: string maxLength: 255 title: Country start_date: type: string title: Start Date end_date: type: string title: End Date type: object required: - name - educator - country title: Degree RecurSchedule: properties: schedule_type: $ref: '#/components/schemas/ScheduleType' schedule_value: type: string title: Schedule Value type: object required: - schedule_type - schedule_value title: RecurSchedule external_interface__public_api__interfaces__Job: properties: title: type: string maxLength: 255 title: Title employer: type: string maxLength: 255 title: Employer country: type: string maxLength: 255 title: Country start_date: type: string title: Start Date end_date: type: string title: End Date type: object required: - title - employer - country title: Job CheckResponse: properties: report_uuid: type: string format: uuid title: Report Uuid message: type: string title: Message type: object required: - report_uuid - message title: CheckResponse PhoneType: type: string enum: - PERSONAL - PROFESSIONAL title: PhoneType description: An enumeration. Identification: properties: unique_id: type: string maxLength: 255 title: Unique Id description: SSN, criminal record, etc default: '' description: type: string maxLength: 255 title: Description default: '' start_date: type: string format: date title: Start Date end_date: type: string format: date title: End Date type: object title: Identification external_interface__public_api__interfaces__Email: properties: address: type: string format: email title: Address email_type: allOf: - $ref: '#/components/schemas/EmailType' default: PERSONAL type: object required: - address title: Email Name: properties: prefix: type: string maxLength: 255 title: Prefix default: '' first_name: type: string maxLength: 255 title: First Name middle_name: type: string maxLength: 255 title: Middle Name default: '' last_name: type: string maxLength: 255 title: Last Name suffix: type: string maxLength: 255 title: Suffix default: '' name_type: allOf: - $ref: '#/components/schemas/NameType' default: MAIN type: object required: - first_name - last_name title: Name securitySchemes: bearerAuth: type: http scheme: bearer x-provenance: method: searched source: https://developer.fama.io/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developer.fama.io/reference/_check_status_company__company_uuid__check_get.md - https://developer.fama.io/reference/_download_report_pdf_report__report_uuid__pdf_get.md - https://developer.fama.io/reference/_get_behavior_kit_behavior_kit__behavior_kit_uuid__get.md - https://developer.fama.io/reference/_get_check_type_check_type__check_type_uuid__get.md - https://developer.fama.io/reference/_get_company_company__company_uuid__get.md - https://developer.fama.io/reference/_get_me_me_get.md - https://developer.fama.io/reference/_get_my_behavior_kits_my_behavior_kits_get.md - https://developer.fama.io/reference/_get_my_check_types_my_check_types_get.md - https://developer.fama.io/reference/_get_my_companies_my_companies_get.md - https://developer.fama.io/reference/_get_person_report__report_uuid__person_get.md - https://developer.fama.io/reference/_get_posts_report__report_uuid__posts_get.md - https://developer.fama.io/reference/_get_profiles_report__report_uuid__profiles_get.md - https://developer.fama.io/reference/_get_summary_report__report_uuid__summary_get.md - https://developer.fama.io/reference/_get_web_content_report__report_uuid__web_content_get.md - https://developer.fama.io/reference/_request_check_company__company_uuid__check_post.md merge: pages: 15 deduped: 16 conflicts_kept_first: 0