--- updatedAt: 2026-08-04T02:55:09.000Z agentTools: projectIndex: https://docs.aiprise.com/llms.txt --- # Get business verification url Endpoint used to get business verification url. Initializes the onboarding SDK & creates a business profile internally. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "AiPrise APIs", "description": "AiPrise API documentation", "version": "1.0" }, "servers": [ { "url": "https://api-sandbox.aiprise.com/api/v1/", "description": "Sandbox server" }, { "url": "https://api.aiprise.com/api/v1/", "description": "Production server" } ], "tags": [ { "name": "KYB > Verification (Profile-Based)", "description": "Run verification against a business profile." } ], "paths": { "/verify/get_business_verification_url": { "post": { "tags": [ "KYB > Verification (Profile-Based)" ], "summary": "Get business verification url", "description": "Endpoint used to get business verification url. Initializes the onboarding SDK & creates a business profile internally.", "requestBody": { "description": "Business verification request with redirect URL", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessVerificationUrlRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BusinessVerificationUrlRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BusinessVerificationUrlRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessVerificationUrlResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BusinessVerificationUrlResponse" } } } }, "400": { "description": "Bad Request" } }, "callbacks": { "result": { "{$request.body#/callback_url}": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfile" } } } }, "responses": { "200": { "description": "OK" } } } } } } } } }, "components": { "schemas": { "Address": { "type": "object", "properties": { "address_street_1": { "type": "string", "example": "222 Palm Street", "description": "Address street 1" }, "address_street_2": { "type": "string", "example": null, "description": "Address street 2" }, "address_city": { "type": "string", "example": "Santa Monica", "description": "Address city" }, "address_state": { "type": "string", "example": "CA", "description": "Address state or region" }, "address_zip_code": { "type": "string", "example": "93251", "description": "Address zip code" }, "address_country": { "type": "string", "example": "US", "description": "2-letter address country code" } } }, "ExtractedAddress": { "type": "object", "properties": { "full_address": { "type": "string", "example": "222 Palm Street, Santa Monica, CA - 93251, US" }, "parsed_address": { "type": "object", "properties": { "address_street_1": { "type": "string", "example": "222 Palm Street", "description": "Address street 1" }, "address_street_2": { "type": "string", "example": null, "description": "Address street 2" }, "address_city": { "type": "string", "example": "Santa Monica", "description": "Address city" }, "address_state": { "type": "string", "example": "CA", "description": "Address state or region" }, "address_zip_code": { "type": "string", "example": "93251", "description": "Address zip code" }, "address_country": { "type": "string", "example": "US", "description": "2-letter address country code" }, "address_type": { "type": "string", "example": "home", "description": "Address type" } } }, "source": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "file_number": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } } } }, "description": "Source information for the address", "properties": { "type": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "file_number": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } } } }, "additional_info": { "type": "object", "description": "Additional information about the address (risk indicators, deliverability, etc.)", "additionalProperties": {} } } }, "OutputIdentity": { "type": "object", "properties": { "identity_country_code": { "type": "string", "example": "US", "description": "A 2-letter ISO country code of the identity number or identity document being submitted." }, "identity_number_type": { "$ref": "#/components/schemas/IdentityNumberType" }, "identity_number": { "type": "string", "example": null, "description": "The identity number associated with the person of type identity_number_type." }, "identity_document_type": { "$ref": "#/components/schemas/IdentityDocumentType" }, "identity_document_front": { "type": "string", "example": "S3_URL", "description": "A S3 url of the front of identity document." }, "identity_document_back": { "type": "string", "example": "S3_URL", "description": "A S3 url of the back of identity document." } } }, "IdentityDocumentType": { "type": "string", "nullable": true, "example": null, "enum": [ "PASSPORT", "DRIVER_LICENSE", "NATIONAL_ID", "PAN_CARD", "ID_CARD", "VOTER_ID_CARD", "RESIDENT_CARD", "GHANA_CARD", "GHANA_SSNIT_CARD", "KENYA_ALIEN_CARD", "COLOMBIA_PPT" ], "description": "An identity document type. Only one of identity_number or identity_document_type must be provided." }, "IdentityNumberType": { "type": "string", "nullable": true, "example": null, "enum": [ "SSN9", "SSN4", "DRIVER_LICENSE", "PASSPORT", "NATIONAL_ID", "VOTER_ID", "BVN", "NIN", "NIN_SLIP", "SSNIT", "TAX_ID", "KENYA_KRA_PIN", "ALIEN_CARD", "RESIDENT_ID", "COLOMBIA_PPT_NUMBER", "GHANA_CARD_NUMBER" ], "description": "The type of identity number being submitted. Only one of identity_number_type and identity_document_type must be filled." }, "BusinessAdditionalInfo": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIndividualAdditionalInfo" }, "description": "A list of additional information." }, "BusinessIndividualAdditionalInfo": { "type": "object", "properties": { "additional_info_type": { "$ref": "#/components/schemas/BusinessAdditionalInfoType" }, "additional_info_data": { "oneOf": [ { "type": "string", "description": "The additional data as a string." }, { "type": "object", "additionalProperties": {}, "description": "The additional data as an object. For file-based types, may include file_data, file_name, file_uuid, and document_input_title.", "properties": { "file_data": { "type": "string", "description": "The file content as base64 or S3 URL." }, "file_name": { "type": "string", "description": "The name of the file." }, "file_uuid": { "type": "string", "description": "The unique identifier of the file." }, "document_input_title": { "type": "string", "nullable": true, "description": "An optional unique identifier for the document input, if provided during document check." } } } ] } } }, "BusinessVerificationUrlRequest": { "type": "object", "required": [ "redirect_uri", "template_id" ], "properties": { "redirect_uri": { "type": "string", "description": "Controls how the onboarding widget signals completion. Pass a reserved keyword — `iframe`, `popup`, `popup_close`, `manual_close`, `react_native`, `flutter`, `ios`, or `android` — to have the widget post the `AiPriseVerification:Complete` message to your host app, or pass a URL to redirect the browser on completion (the session id is appended as `verification_session_id` for KYC or `business_onboarding_session_id` for KYB). See [Redirect modes](https://docs.aiprise.com/docs/template-configuration) for the full list of behaviors." }, "template_id": { "type": "string", "example": "b7daff11-9d1c-4916-bf5a-96e3041a9625", "description": "Every verification must have a template id associated with it. This is Provided to you by AiPrise." }, "business_profile_id": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000", "description": "The business profile id to associate with the verification session." }, "client_reference_id": { "type": "string", "example": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810", "description": "An id you want to associate with your request." }, "client_reference_data": { "type": "object", "description": "A JSON you want to associate with your request." }, "callback_url": { "type": "string", "example": "https://yourwebsite.com/aiprise-callback" }, "events_callback_url": { "type": "string", "example": "https://yourwebsite.com/aiprise-callback" }, "associated_email": { "type": "string", "example": "user@example.com", "description": "Email address to associate with the session for later resumption." }, "business_data": { "$ref": "#/components/schemas/BusinessDataWithPrefillData" }, "additional_info": { "$ref": "#/components/schemas/BusinessAdditionalInfo" }, "theme_options": { "$ref": "#/components/schemas/ThemeOptions" }, "verification_options": { "$ref": "#/components/schemas/VerificationOptions" }, "ui_options": { "$ref": "#/components/schemas/ExtendedUIOptionsWithDynamicModules" } } }, "BusinessVerificationUrlResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "verification_url": { "type": "string", "example": "https://verify-sandbox.aiprise.com/?business_onboarding_session_id=123" } } }, "MediaInfo": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "description": "Title of the media" }, "url": { "type": "string", "nullable": true, "description": "URL of the media" }, "date": { "type": "string", "nullable": true, "description": "Date of the media" }, "snippet": { "type": "string", "nullable": true, "description": "Short summary of the media" } } }, "SourceDetails": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the source" }, "source_id": { "type": "string", "nullable": true, "description": "ID of the source" }, "url": { "type": "string", "nullable": true, "description": "URL of the source" }, "listing_started": { "type": "string", "nullable": true, "description": "Unix timestamp in seconds for when the source listing started" }, "listing_ended": { "type": "string", "nullable": true, "description": "Unix timestamp in seconds for when the source listing ended" }, "country_codes": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of country codes associated with the source" }, "aml_types": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of AML types associated with the source" } } }, "FieldTypeEnum": { "type": "string", "enum": [ "date_of_birth", "place_of_birth", "date_of_death", "country_codes", "country_names", "url" ] }, "FieldDetail": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "object" }, { "type": "array", "items": { "type": "string" } } ] }, "type": { "$ref": "#/components/schemas/FieldTypeEnum" } } }, "AMLHit": { "type": "object", "properties": { "hit_type": { "$ref": "#/components/schemas/AMLHitType", "nullable": true }, "source_details": { "$ref": "#/components/schemas/SourceDetails", "nullable": true, "description": "Details of the source where the AML hit was found" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDetail" }, "nullable": true, "description": "List of fields associated with the AML hit" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MediaInfo" }, "nullable": true, "description": "List of media associated with the AML hit" } } }, "EntityHit": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "PERSON", "COMPANY", "ORGANISATION", "UNKNOWN" ] }, "name": { "type": "string" }, "name_match_score": { "type": "number", "format": "float", "minimum": 0, "maximum": 100 }, "also_known_as": { "type": "array", "items": { "type": "string" } }, "associates": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "association": { "type": "string" } } } }, "aml_hits": { "type": "array", "items": { "$ref": "#/components/schemas/AMLHit" } }, "date_of_birth": { "type": "string", "nullable": true }, "date_of_birth_match_score": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "nullable": true }, "id": { "type": "string" }, "resolution_status": { "$ref": "#/components/schemas/ResolutionStatus" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AMLEntityHitHistory" } }, "is_deleted": { "type": "boolean" }, "additional_fields": { "type": "object", "description": "Additional fields as key-value pairs." } } }, "EntityHitWithoutHistory": { "type": "object", "properties": { "entity_type": { "type": "string", "enum": [ "PERSON", "COMPANY", "ORGANISATION", "UNKNOWN" ] }, "name": { "type": "string" }, "name_match_score": { "type": "number", "format": "float", "minimum": 0, "maximum": 100 }, "also_known_as": { "type": "array", "items": { "type": "string" } }, "aml_hits": { "type": "array", "items": { "$ref": "#/components/schemas/AMLHit" } }, "date_of_birth": { "type": "string", "nullable": true }, "date_of_birth_match_score": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "nullable": true }, "id": { "type": "string" }, "resolution_status": { "$ref": "#/components/schemas/ResolutionStatus" }, "is_deleted": { "type": "boolean" }, "additional_fields": { "type": "object", "description": "Additional fields as key-value pairs." } } }, "AMLEntityHitHistory": { "type": "object", "properties": { "created_at": { "type": "integer" }, "entity_hit": { "$ref": "#/components/schemas/EntityHitWithoutHistory" }, "event": { "$ref": "#/components/schemas/AMLEntityHitHistoryEvent" } } }, "AMLEntityHitHistoryEvent": { "type": "string", "enum": [ "ADDED", "UPDATED", "REMOVED", "MONITORING_UPDATE" ] }, "AMLInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "entity_hits": { "type": "array", "items": { "$ref": "#/components/schemas/EntityHit" } }, "result": { "$ref": "#/components/schemas/AiPriseResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "num_hits": { "type": "number" }, "aml_hit_summary": { "type": "object", "additionalProperties": { "type": "string" } }, "section_id": { "type": "string" }, "search_criteria": { "type": "object", "properties": { "search_term": { "type": "string", "nullable": true }, "fuzziness_score": { "type": "number", "nullable": true }, "exact_match": { "type": "boolean", "nullable": true }, "birth_year": { "type": "number", "nullable": true } } } } }, "DocumentDetails": { "type": "object", "properties": { "mrz_data": { "type": "object", "additionalProperties": true, "nullable": true }, "barcode_data": { "type": "object", "additionalProperties": true, "nullable": true }, "ocr_data": { "type": "object", "additionalProperties": true, "nullable": true } } }, "IDInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "id_type": { "$ref": "#/components/schemas/IDType" }, "id_number": { "type": "string" }, "id_expiry_date": { "type": "string" }, "id_issue_date": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "second_last_name": { "type": "string" }, "full_name": { "type": "string" }, "personal_number": { "type": "string" }, "birth_date": { "type": "string" }, "gender": { "type": "string" }, "nationality": { "type": "string" }, "nationality_code": { "type": "string" }, "issue_country": { "type": "string" }, "issue_country_code": { "type": "string" }, "issue_state": { "type": "string" }, "issue_state_code": { "type": "string" }, "address": { "$ref": "#/components/schemas/ExtractedAddress", "nullable": true, "description": "Contains address extracted from the document" }, "document_details": { "$ref": "#/components/schemas/DocumentDetails" }, "lookup_details": { "type": "object" }, "field_info": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true }, "check_summary": { "type": "object" }, "section_id": { "type": "string" } }, "required": [ "result" ] }, "FaceMatchInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "face_match_score": { "type": "number", "format": "float", "minimum": 0, "maximum": 100, "nullable": true }, "check_summary": { "type": "object" }, "section_id": { "type": "string" } }, "required": [ "result" ] }, "FaceLivenessInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "source": { "type": "string", "nullable": true }, "check_summary": { "type": "object" }, "section_id": { "type": "string" } }, "required": [ "result" ] }, "SocialProfile": { "type": "object", "properties": { "platform": { "type": "string", "description": "Name of the social media platform (e.g. Facebook, Telegram, etc.)", "nullable": true }, "registered": { "type": "boolean", "description": "Indicates whether the user is registered on the social media platform", "nullable": true }, "name": { "type": "string", "description": "Name of the user's account on the social media platform", "nullable": true }, "last_seen": { "type": "string", "format": "date-time", "description": "Timestamp indicating when the user was last seen on the social media platform", "nullable": true }, "account_id": { "type": "string", "description": "Unique identifier of the user's account on the social media platform", "nullable": true } } }, "SocialSummary": { "type": "object", "properties": { "age_on_social": { "type": "number", "description": "Age of the user on the social media platform", "nullable": true }, "number_of_names_returned": { "type": "number", "description": "Number of names returned from social media platforms", "nullable": true }, "number_of_photos_returned": { "type": "number", "description": "Number of photos returned from social media platforms", "nullable": true }, "registered_consumer_electronics_profiles": { "type": "number", "description": "Number of registered consumer electronics profiles", "nullable": true }, "registered_ecommerce_profiles": { "type": "number", "description": "Number of registered ecommerce profiles", "nullable": true }, "registered_education_profiles": { "type": "number", "description": "Number of registered education profiles", "nullable": true }, "registered_email_provider_profiles": { "type": "number", "description": "Number of registered email provider profiles", "nullable": true }, "registered_entertainment_profiles": { "type": "number", "description": "Number of registered entertainment profiles", "nullable": true }, "registered_financial_profiles": { "type": "number", "description": "Number of registered financial profiles", "nullable": true }, "registered_messaging_profiles": { "type": "number", "description": "Number of registered messaging profiles", "nullable": true }, "registered_professional_profiles": { "type": "number", "description": "Number of registered professional profiles", "nullable": true }, "registered_profiles": { "type": "number", "description": "Total number of registered profiles", "nullable": true }, "registered_social_media_profiles": { "type": "number", "description": "Number of registered social media profiles", "nullable": true }, "registered_travel_profiles": { "type": "number", "description": "Number of registered travel profiles", "nullable": true } } }, "PortEvent": { "type": "object", "properties": { "from_carrier": { "type": "string", "description": "Name of the carrier that the number is being transferred from." }, "to_carrier": { "type": "string", "description": "Name of the carrier that the number is being transferred to." }, "port_date": { "type": "string", "format": "date-time", "description": "The date the number ported." } } }, "PersonAddress": { "type": "object", "properties": { "address_line_1": { "type": "string" }, "address_line_2": { "type": "string" }, "address_city": { "type": "string" }, "address_country": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "last_seen": { "type": "string", "format": "date-time" }, "postal_code": { "type": "string" }, "address_state": { "type": "string" }, "valid_since": { "type": "string", "format": "date-time" } } }, "PersonField": { "type": "object", "properties": { "last_seen": { "type": "string", "format": "date-time" }, "valid_since": { "type": "string", "format": "date-time" }, "value": { "type": "string" } } }, "Person": { "type": "object", "properties": { "names": { "type": "array", "items": { "$ref": "#/components/schemas/PersonField" } }, "genders": { "type": "array", "items": { "$ref": "#/components/schemas/PersonField" } }, "date_of_births": { "type": "array", "items": { "$ref": "#/components/schemas/PersonField" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/PersonAddress" } }, "email_address": { "$ref": "#/components/schemas/PersonField" }, "ip_addresses": { "type": "array", "items": { "$ref": "#/components/schemas/PersonField" } }, "national_id": { "type": "string" }, "phone_number": { "type": "string" } } }, "PhoneInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "phone_number": { "type": "string" }, "phone_valid": { "type": "boolean" }, "phone_type": { "type": "string", "description": "Line type, passed through from the phone enrichment provider. Not a fixed set; values seen include MOBILE, FIXED, VOIP." }, "phone_disposable": { "type": "boolean" }, "phone_active": { "type": "string", "description": "Whether the line is currently active. Passed through from the phone enrichment provider as a string, not a boolean. The observed value is \"YES\"; the value set is the provider's and is not fixed." }, "activation_date": { "type": "string" }, "sim_type": { "type": "string", "description": "Passed through from the phone enrichment provider. Not a fixed set; values seen include prepaid and postpaid." }, "country": { "type": "string" }, "original_carrier": { "type": "string" }, "current_carrier": { "type": "string" }, "port_history": { "type": "array", "items": { "$ref": "#/components/schemas/PortEvent" } }, "phone_is_spam": { "type": "boolean" }, "social_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/SocialProfile" } }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "section_id": { "type": "string" } } }, "IPLocation": { "type": "object", "properties": { "country": { "type": "string" }, "country_code": { "type": "string" }, "region": { "type": "string" }, "city": { "type": "string" }, "latitude": { "type": "number", "format": "float" }, "longitude": { "type": "number", "format": "float" }, "postal_code": { "type": "string" }, "timezone": { "type": "string" }, "geo_name_id": { "type": "integer" } } }, "DeviceInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "browser_name": { "type": "string" }, "browser_major_version": { "type": "string" }, "browser_full_version": { "type": "string" }, "os": { "type": "string" }, "os_version": { "type": "string" }, "device": { "type": "string" }, "user_agent": { "type": "string" }, "incognito": { "type": "boolean" }, "bot_status": { "type": "boolean" }, "bot_type": { "type": "string" }, "privacy_settings": { "type": "boolean" }, "section_id": { "type": "string" } } }, "RelatedSession": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "created_at": { "type": "integer" }, "relation": { "type": "string" }, "verification_session_id": { "type": "string" } } }, "RelatedSessionInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "related_sessions": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedSession" } }, "section_id": { "type": "string" } } }, "GeolocationInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "accuracy": { "type": "string" }, "altitude": { "type": "string" }, "altitude_accuracy": { "type": "string" }, "heading": { "type": "string" }, "speed": { "type": "string" }, "section_id": { "type": "string" } } }, "VPNInfo": { "type": "object", "description": "Breakdown of the signals behind the VPN determination.", "properties": { "confidence": { "type": "string", "nullable": true }, "origin_timezone": { "type": "string", "nullable": true }, "origin_country": { "type": "string", "nullable": true }, "timezone_mismatch": { "type": "boolean", "nullable": true }, "public_vpn": { "type": "boolean", "nullable": true, "description": "IP matches known public VPN providers; drives the VPN_DETECTED warning." }, "auxiliary_mobile": { "type": "boolean", "nullable": true }, "os_mismatch": { "type": "boolean", "nullable": true }, "relay": { "type": "boolean", "nullable": true, "description": "Traffic routed through an anonymizing relay (e.g. iCloud Private Relay)." }, "ml_prediction": { "type": "boolean", "nullable": true }, "vpn_ml_score": { "type": "number", "nullable": true, "description": "Probability (0-1) that a VPN is in use, from the ML detection model; null when no score is available." } } }, "IPInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "location": { "$ref": "#/components/schemas/IPLocation" }, "internet_service_provider": { "type": "string" }, "connection_type": { "type": "string" }, "autonomous_system_number": { "type": "integer" }, "organization": { "type": "string" }, "is_crawler": { "type": "boolean" }, "host": { "type": "string" }, "proxy": { "type": "boolean" }, "vpn": { "type": "boolean" }, "vpn_info": { "$ref": "#/components/schemas/VPNInfo" }, "tor": { "type": "boolean" }, "active_vpn": { "type": "boolean", "description": "Identifies active VPN connections used by popular VPN services and private VPN servers." }, "active_tor": { "type": "boolean", "description": "Identifies active TOR exits on the TOR network." }, "recent_abuse": { "type": "boolean" }, "bot_status": { "type": "boolean" }, "abuse_velocity": { "type": "string" }, "unique_hash": { "type": "string" }, "ip_address": { "type": "string" }, "section_id": { "type": "string" } } }, "DomainInfo": { "type": "object", "properties": { "domain_name": { "type": "string" }, "top_level_domain": { "type": "string" }, "registered": { "type": "boolean" }, "company_name": { "type": "string" }, "disposable": { "type": "boolean" }, "free_provider": { "type": "boolean" }, "dmarc_compliance": { "type": "boolean" }, "spf_strict": { "type": "boolean" }, "suspicious_top_level_domain": { "type": "boolean" }, "custom": { "type": "boolean" } } }, "Breach": { "type": "object", "properties": { "platform_name": { "type": "string" }, "breach_date": { "type": "string", "format": "date-time" }, "domain_name": { "type": "string" } } }, "EmailInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "email": { "type": "string", "nullable": true }, "email_tenure": { "type": "number", "format": "float" }, "domain_info": { "$ref": "#/components/schemas/DomainInfo" }, "is_breached": { "type": "boolean" }, "no_of_breaches": { "type": "integer" }, "first_breach": { "type": "string", "format": "date-time" }, "last_breach": { "type": "string", "format": "date-time" }, "breaches": { "type": "array", "items": { "$ref": "#/components/schemas/Breach" } }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "social_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/SocialProfile" } }, "social_summary": { "$ref": "#/components/schemas/SocialSummary", "nullable": true }, "section_id": { "type": "string" } } }, "FraudInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "email_insights": { "type": "array", "items": { "$ref": "#/components/schemas/EmailInsights" } }, "phone_insights": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneInsights" } }, "ip_insights": { "$ref": "#/components/schemas/IPInsights" }, "device_insights": { "$ref": "#/components/schemas/DeviceInsights" }, "related_session_insights": { "$ref": "#/components/schemas/RelatedSessionInsights" }, "geolocation_insights": { "$ref": "#/components/schemas/GeolocationInsights" }, "section_id": { "type": "string" } } }, "AiPriseResultStatusV2": { "type": "string", "nullable": true, "example": "APPROVED", "enum": [ "APPROVED", "DECLINED", "REVIEW", "UNKNOWN" ], "description": "The overall workflow result status for verification sessions/cases." }, "AiPriseRunStatusV2": { "type": "string", "nullable": true, "example": "RUNNING", "enum": [ "NOT_STARTED", "RUNNING", "PENDING", "FAILED", "COMPLETED", "SUBMITTED" ], "description": "The overall workflow result status." }, "StatusReasonCodeEntry": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "WarningEntry": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/AiPriseReasonCode" }, "message": { "type": "string", "nullable": true }, "warning_id": { "type": "string" }, "resolution_status": { "$ref": "#/components/schemas/ResolutionStatus" } } }, "AdditionalInfoType": { "type": "string", "description": "The type of additional information being submitted or returned for an individual. Business verification uses BusinessAdditionalInfoType instead.", "enum": [ "KBA", "KENYA_KRA_PIN", "BANK_STATEMENT_DOCUMENT", "BUSINESS_REGISTRATION_DOCUMENT", "OPERATING_LICENSE_DOCUMENT", "SOURCE_OF_FUNDS_DOCUMENT", "VISA_DOCUMENT", "US_AAMVA", "AADHAAR_DOCUMENT_FRONT", "AADHAAR_DOCUMENT_BACK", "USER_SELFIE", "GENDER", "SEON_SESSION_PAYLOAD", "ADDRESS_PROOF_DOCUMENT", "NIGERIA_BVN_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PREVIOUS_VERIFICATION_SESSION_ID", "FRAUD_CHECK_DOCUMENT", "OPERATION_CARD", "TRANSPORTATION_PERMIT", "VEHICLE_OWNERSHIP_CARD", "TAX_CERTIFICATE", "OTHER" ] }, "POADocumentCategory": { "type": "string", "description": "How AiPrise classified a proof-of-address document. This is the classifier's output and is not configurable. It is distinct from the user-declared file_sub_type on the request, and from document_class_type, which comes from the document fraud provider.", "enum": [ "FINANCIAL_STATEMENT", "UTILITY_BILL", "GOVERNMENT_LETTER", "INSURANCE_DOCUMENT", "TENANCY_AGREEMENT", "EMPLOYMENT_DOCUMENT", "NATIONAL_ID", "UNKNOWN" ] }, "ResolutionStatus": { "type": "string", "description": "Whether a hit or warning has been actioned by a reviewer.", "enum": [ "RESOLVED", "UNRESOLVED", "WHITELISTED" ] }, "AMLHitType": { "type": "string", "description": "The category of an AML screening hit. PEP_CLASS_1 through PEP_CLASS_4 rank a politically exposed person by seniority, and the ADVERSE_MEDIA_* values narrow an adverse media hit to a specific category.", "enum": [ "PEP", "PEP_CLASS_1", "PEP_CLASS_2", "PEP_CLASS_3", "PEP_CLASS_4", "ADVERSE_MEDIA", "ADVERSE_MEDIA_PROPERTY", "ADVERSE_MEDIA_FINANCIAL_AML_CFT", "ADVERSE_MEDIA_FRAUD_LINKED", "ADVERSE_MEDIA_NARCOTICS_AML_CFT", "ADVERSE_MEDIA_VIOLENCE_AML_CFT", "ADVERSE_MEDIA_TERRORISM", "ADVERSE_MEDIA_CYBERCRIME", "ADVERSE_MEDIA_GENERAL_AML_CFT", "ADVERSE_MEDIA_REGULATORY", "ADVERSE_MEDIA_FINANCIAL_DIFFICULTY", "ADVERSE_MEDIA_VIOLENCE_NON_AML_CFT", "ADVERSE_MEDIA_OTHER_FINANCIAL", "ADVERSE_MEDIA_OTHER_SERIOUS", "ADVERSE_MEDIA_OTHER_MINOR", "SANCTION", "WARNING", "FITNESS_PROBITY", "CRIMINAL_RECORD", "LEGAL_BACKGROUND", "UNKNOWN" ] }, "ValidationRulesOverallOutcome": { "type": "string", "description": "The combined outcome of every validation rule run against a document.", "enum": [ "APPROVED", "REVIEW", "DECLINED", "NOT_EVALUATED" ] }, "AdditionalInfoResponseType": { "type": "string", "enum": [ "ID_INFO", "LOOKUP_DATA", "ADDRESS_VERIFICATION", "DOCUMENT_INSIGHTS" ] }, "AdditionalInfoBlob": { "type": "object", "properties": { "additional_info_type": { "description": "Individual values for user verification, business values for business verification. The same blob shape serves both, so either set is valid here.", "anyOf": [ { "$ref": "#/components/schemas/AdditionalInfoType" }, { "$ref": "#/components/schemas/BusinessAdditionalInfoType" } ] }, "additional_info_response_type": { "$ref": "#/components/schemas/AdditionalInfoResponseType" }, "data": { "oneOf": [ { "$ref": "#/components/schemas/IDInfo" }, { "$ref": "#/components/schemas/AddressVerificationInfo" }, { "$ref": "#/components/schemas/DocumentInsights" }, { "type": "object" } ] } } }, "AiPriseReasonCode": { "type": "string", "enum": [ "UNRECOGNIZED_DOCUMENT", "UNREADABLE_DOCUMENT", "DOCUMENT_NOT_FOUND", "DOCUMENT_EXPIRED", "DOCUMENT_FRONT_BACK_MISMATCH", "DOCUMENT_DAMAGED", "DOCUMENT_FRONT_MISSING", "DOCUMENT_BACK_MISSING", "DOCUMENT_CROPPED", "DOCUMENT_FACE_NOT_FOUND", "INVALID_DOCUMENT_DETAILS", "DOCUMENT_TYPE_MISMATCH", "UNABLE_TO_EXTRACT_DOCUMENT_METADATA", "MISSING_EXPIRY_DATE", "MISSING_ISSUE_DATE", "MISSING_BIRTH_DATE", "MISSING_DOCUMENT_NUMBER", "MISSING_PERSONAL_NUMBER", "MISSING_ADDRESS", "MISSING_POSTCODE", "MISSING_NAME", "MISSING_GENDER", "MISSING_NATIONALITY", "MISSING_DOCUMENT_DETAILS", "DOCUMENT_FRONT_OR_BACK_MISSING", "NAME_VERIFICATION_FAILED", "ID_DATA_MISMATCH", "ID_TYPE_MISMATCH", "ID_NOT_ALLOWED", "ID_COUNTRY_MISMATCH", "BIRTH_DATE_MISMATCH", "ADDRESS_MISMATCH", "DATABASE_LOOKUP_ISSUE", "DOCUMENT_PHOTO_OF_PHOTO", "SCREEN_DETECTED", "IMAGE_FORGED_EDITED", "FEATURE_VERIFICATION_FAILED", "FAKE_ID", "DOCUMENT_FOUND_ON_INTERNET", "ARTIFICIAL_IMAGE", "ARTIFICIAL_TEXT", "TEXT_FORGERY", "IMAGE_TOO_SMALL", "GLARE_DETECTED", "IMAGE_TOO_BLURRY", "CHECK_DIGIT_FAILED", "PRINTOUT_DETECTED", "DOCUMENT_CONVERTED_TO_IMAGE", "BLACK_WHITE_DOCUMENT", "FACE_NOT_FOUND", "MULTIPLE_FACES", "FACE_MISMATCH", "LOW_FACE_SIMILARITY", "FACE_IDENTICAL", "FACE_NOT_LIVE", "FACE_LIVENESS_REVIEW_REQUIRED", "FACE_PHOTO_OF_PHOTO", "FACE_COVERED", "FACE_EDITED", "FACE_BLUR", "FACE_TOO_CLOSE", "FACE_CROPPED", "FACE_TOO_SMALL", "FACE_ANGLE_TOO_LARGE", "FACE_DEEPFAKE", "ID_NUMBER_NOT_VERIFIED", "INVALID_ID_NUMBER_SUPPLIED", "LOOKUP_SOURCE_DOWN", "LOOKUP_FACE_NOT_FOUND", "ID_PREVIOUSLY_SEEN", "AGE_UNDER_18", "AML_MATCH", "API_DATA_REQUIREMENTS_NOT_MET", "IP_ADDRESS_SUSPICIOUS", "SUSPICIOUS_USER_BEHAVIOUR", "GEOLOCATION_MISMATCH", "COMPANY_NOT_FOUND", "COMPANY_NUMBER_NOT_VALID_FORMAT", "COMPANY_PREVIOUSLY_SEEN", "CUSTOM_ERROR_CODE", "DOCUMENT_TAMPERED", "DOCUMENT_MINOR_DIGITAL_ARTIFACTS", "DOCUMENT_REQUIRES_REVIEW", "VALIDATION_RULES_DECLINED", "VALIDATION_RULES_REVIEW", "DOCUMENT_TOO_FAR", "DOCUMENT_SIZE_TOO_LARGE", "BROKEN_DOCUMENT", "INVALID_FILE_EXTENSION", "FILE_TOO_LARGE", "FACE_LIVENESS_TOO_FAR_FROM_CAMERA", "FACE_PREVIOUSLY_ONBOARDED", "ADDRESS_DOCUMENT_MISSING_ADDRESS", "ADDRESS_DOCUMENT_ADDRESS_MISMATCH", "ADDRESS_DOCUMENT_MISSING_NAME", "ADDRESS_DOCUMENT_NAME_VERIFICATION_FAILED", "ADDRESS_DOCUMENT_MISSING_ISSUE_DATE", "ADDRESS_DOCUMENTS_NOT_SAME", "EXPIRY_DATE_MISSING_USING_ISSUE_DATE", "EXPIRY_AND_ISSUE_DATE_MISSING", "ADDRESS_DOCUMENT_DOCUMENT_EXPIRED", "ADDRESS_DOCUMENT_DOCUMENT_NOT_ISSUED_RECENTLY", "ADDRESS_DOCUMENT_UNRECOGNIZED_DOCUMENT", "TOR_DETECTED", "VPN_DETECTED", "BOT_DETECTED", "BROWSER_PREVIOUSLY_SEEN", "IP_ADDRESS_PREVIOUSLY_SEEN", "PRIVACY_SETTINGS_BLOCKED", "BUSINESS_ID_MISMATCH", "BUSINESS_INFO_NAME_MISMATCH", "REGISTRATION_STATUS_INACTIVE", "UNABLE_TO_EXTRACT_DATA", "EMAIL_NOT_FOUND", "PHONE_NUMBER_NOT_FOUND", "BROWSER_PREVIOUSLY_ATTEMPTED", "IP_ADDRESS_PREVIOUSLY_ATTEMPTED", "ID_PREVIOUSLY_ATTEMPTED", "BACKGROUND_CHECK_ALERT", "BUSINESS_ID_NOT_VERIFIED", "MRZ_DATA_MISMATCH", "SELFIE_VIDEO_FRAUD", "SELFIE_VIDEO_MISSING", "VIDEO_INJECTION_DETECTED", "VIRTUAL_CAMERA_DETECTED", "ADDRESS_ZIPCODE_MISMATCH", "FACE_AGE_MISMATCH", "NO_GLARES_DETECTED", "KEYWORD_MATCHES_FOUND", "HIGH_RISK_INDUSTRY_MATCHES_FOUND", "IMAGE_IN_FOCUS", "GOOD_IMAGE_RESOLUTION", "GOOD_IMAGE_COLOR", "GOOD_IMAGE_PERSPECTIVE", "DOCUMENT_FULLY_PRESENT", "PORTRAIT_PRESENT_IN_IMAGE", "GOOD_IMAGE_BRIGHTNESS", "NO_OCCLUSION_DETECTED", "GOOD_IMAGE_QUALITY", "IMAGE_DOCUMENT_TYPE_DETECTED", "IMAGE_TEXT_FIELDS_VERIFIED", "PO_BOX_DETECTED", "PARKED_WEBSITE", "SOCIAL_MEDIA_BROKEN_LINKS", "SOCIAL_MEDIA_BUSINESS_MISMATCH", "INCONSISTENCIES_IN_WEBSITE_CONTENT", "STOCK_IMAGES_FOUND", "PLACEHOLDER_TEXT_FOUND_IN_WEBSITE_CONTENT", "WEBSITE_NOT_FOUND", "WEBSITE_PARKED", "WEBSITE_REDIRECTED", "WEBSITE_GENERIC", "WEBSITE_NOT_AUTHENTIC", "BUSINESS_DESCRIPTION_MISMATCH", "TERMS_AND_CONDITIONS_NOT_FOUND", "TERMS_AND_CONDITIONS_FAILED", "INVALID_WEBSITE_SSL", "BUSINESS_GEOLOCATION_MISMATCH", "EMAIL_ADDRESS_MISMATCH", "PHONE_NUMBER_MISMATCH", "PROHIBITED_INDUSTRY_MATCHES_FOUND", "WEBSITE_URL_AND_BUSINESS_NAME_MISMATCH", "BUSINESS_COUNTRY_MISMATCH", "BUSINESS_WEBSITE_MISMATCH", "BUSINESS_FORMATION_DATE_MISMATCH", "BUSINESS_TAX_ID_MISMATCH" ] }, "AiPriseAPIResultStatusV2": { "type": "string", "enum": [ "APPROVED", "DECLINED", "REVIEW", "UNKNOWN", "FOUND", "NOT_FOUND" ], "description": "The result status of an API request. Possible values are `APPROVED`, `DECLINED`, `REVIEW`, `UNKNOWN`, `FOUND`, and `NOT_FOUND`.", "example": "APPROVED" }, "ProfileAPIResultStatusV2": { "type": "string", "enum": [ "APPROVED", "DECLINED", "REVIEW", "UNKNOWN", "DEACTIVATED" ], "description": "The result status for business/user profile APIs. Includes DEACTIVATED for deactivating profiles.", "example": "APPROVED" }, "IDType": { "type": "string", "enum": [ "NATIONAL_ID", "ID_CARD", "PASSPORT", "DRIVER_LICENSE", "RESIDENT_CARD", "VISA", "VOTER_ID", "TAX_ID", "COLOMBIA_PPT", "GHANA_CARD", "GHANA_SSNIT_CARD", "KENYA_ALIEN_CARD", "NATIONAL_ID_NUMBER", "PASSPORT_NUMBER", "BVN", "VOTER_ID_NUMBER", "DRIVER_LICENSE_NUMBER", "TAX_ID_NUMBER", "NIN", "SSN9", "SSN4", "SSNIT", "KRA_PIN", "ALIEN_CARD_NUMBER", "COLOMBIA_PPT_NUMBER", "GHANA_CARD_NUMBER" ] }, "BusinessAdditionalInfoType": { "type": "string", "enum": [ "BANK_STATEMENT_DOCUMENT", "BUSINESS_REGISTRATION_DOCUMENT", "OPERATING_LICENSE_DOCUMENT", "FRAUD_CHECK_DOCUMENT", "ADDRESS_PROOF_DOCUMENT", "BANK_ACCOUNT_DETAILS", "SOURCE_OF_FUNDS_DOCUMENT", "CHAMBER_OF_COMMERCE_CERTIFICATE", "CAC_CERTIFICATE", "ARTICLES_OF_INCORPORATION", "AML_POLICY", "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION", "DIRECTORS_REGISTRY", "CORPORATE_CHART", "SHAREHOLDERS_REGISTRY", "BALANCE_SHEET", "REPORTING_ENTITY_REGISTRATION_DOCUMENT", "COMPANY_CONSTITUTION", "MEMORANDUM_OF_ASSOCIATION", "PARTNERSHIP_DEED", "CERTIFIED_ANNUAL_RETURNS_STATEMENT", "COMPANY_PROFILE", "AUDITED_ACCOUNTS", "ANTI_BRIBERY_POLICY", "DATA_PROTECTION_POLICY", "INVOICE", "PEP_FORM", "TAX_REGISTRATION_CERTIFICATE", "INTENDED_USAGE_DOCUMENT", "OTHER" ] }, "ExternalUserProfile": { "allOf": [ { "$ref": "#/components/schemas/UserProfileInputOnly" }, { "$ref": "#/components/schemas/UserProfileComputedOnly" } ] }, "UserProfileInputOnly": { "type": "object", "properties": { "user_profile_id": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "second_last_name": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address", "nullable": true }, "date_of_birth": { "type": "string", "example": "1984-01-21", "description": "The person's date of birth in YYYY-MM-DD format" }, "email_address": { "type": "string", "example": "johnsmith@aiprise.com", "description": "The person's email address" }, "phone_number": { "type": "string", "example": "+13334445555", "description": "The person's phone number. Prefer phone number in E.164 format" }, "phone_number_parts": { "description": "The Person's phone number details like country code, phone code, and number (Used internally for client SDK).", "type": "object", "nullable": true, "properties": { "countryCode": { "type": "string", "nullable": true }, "phoneCode": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true } } }, "client_reference_id": { "type": "string", "example": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810", "description": "An id you want to associate with the business profile." }, "client_reference_data": { "type": "object", "description": "A JSON you want to associate with the business profile." }, "verification_session_ids": { "type": "array", "items": { "type": "string" }, "description": "List of verification sessions run against this User" }, "user_profile_result": { "$ref": "#/components/schemas/ProfileAPIResultStatusV2" }, "questions_response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuestionGroup" }, "description": "Questions responded by the business" }, "events_callback_url": { "type": "string", "example": "https://yourwebsite.com/aiprise-callback" } } }, "UserProfileComputedOnly": { "type": "object", "properties": { "risk_info": { "$ref": "#/components/schemas/RiskInfo", "nullable": true }, "id_info": { "nullable": true, "$ref": "#/components/schemas/IDInfo" }, "face_match_info": { "$ref": "#/components/schemas/FaceMatchInfo", "nullable": true }, "face_liveness_info": { "$ref": "#/components/schemas/FaceLivenessInfo", "nullable": true }, "lookup_info": { "type": "array", "items": { "$ref": "#/components/schemas/LookupInfo" } }, "aml_info": { "$ref": "#/components/schemas/AMLInfo", "nullable": true }, "fraud_insights": { "$ref": "#/components/schemas/FraudInsights", "nullable": true }, "additional_information": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalInfoBlob" } }, "created_at": { "type": "integer", "example": 1717334400000 }, "updated_at": { "type": "integer", "example": 1717334400000 } } }, "FieldDataInfoMatchtype": { "type": "string", "enum": [ "NIN", "CURP", "DRIVER_LICENSE", "VOTER_ID", "BVN", "PASSPORT", "AADHAAR", "PAN", "MRZ", "BARCODE", "SSNIT", "NATIONAL_ID", "RFC" ] }, "FieldInfo": { "type": "object", "properties": { "matched": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDataInfoMatchtype" } }, "unmatched": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDataInfoMatchtype" } } } }, "AddressVerificationInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "extracted_address": { "$ref": "#/components/schemas/ExtractedAddress" }, "document_issue_date": { "type": "string", "nullable": true }, "document_expiry_date": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "name_match": { "type": "boolean", "nullable": true }, "address_match": { "type": "boolean", "nullable": true }, "translated_full_name": { "type": "string", "nullable": true }, "translated_extracted_address": { "$ref": "#/components/schemas/ExtractedAddress" }, "translation_language": { "type": "string", "nullable": true }, "document_type": { "type": "string", "nullable": true }, "poa_document_category": { "$ref": "#/components/schemas/POADocumentCategory" }, "section_id": { "type": "string" }, "document_class_id": { "type": "string", "description": "Passed through from the document fraud provider. Not an AiPrise-owned enum, so the value set is not fixed. Values are lowercase, for example account_statement." }, "document_class_type": { "type": "string", "description": "Passed through from the document fraud provider. Not an AiPrise-owned enum, so the value set is not fixed. Values are lowercase, for example account_statement." }, "document_metadata": { "$ref": "#/components/schemas/DocumentMetadata" }, "info_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/AddressVerificationIndicator" } }, "risk_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/AddressVerificationIndicator" } }, "trust_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/AddressVerificationIndicator" } }, "validation_rules_execution_response": { "$ref": "#/components/schemas/ValidationRulesExecutionResponse" } } }, "ValidationRulesExecutionResponse": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationRuleExecutionResult" } }, "overall_outcome": { "$ref": "#/components/schemas/ValidationRulesOverallOutcome" }, "overall_outcome_reason": { "type": "string", "description": "A short phrase explaining which rules drove overall_outcome." } } }, "ValidationRuleExecutionResult": { "type": "object", "properties": { "evidence": { "type": "array", "items": { "type": "string" } }, "order_number": { "type": "number" }, "reasoning": { "type": "string" }, "result": { "type": "string" }, "rule_id": { "type": "string" }, "rule_text": { "type": "string" }, "severity": { "type": "string" } } }, "AddressVerificationIndicator": { "type": "object", "properties": { "id": { "type": "string", "description": "The provider's indicator identifier, passed through unchanged. Not an AiPrise-owned enum." }, "category": { "type": "string", "description": "The provider's indicator category, passed through unchanged. Not an AiPrise-owned enum." }, "title": { "type": "string" }, "description": { "type": "string" }, "indicator_attributes": { "type": "object" }, "metadata": { "type": "object" } } }, "DocumentInsightsIndicator": { "type": "object", "properties": { "id": { "type": "string", "description": "The provider's indicator identifier, passed through unchanged. Not an AiPrise-owned enum." }, "category": { "type": "string", "description": "The provider's indicator category, passed through unchanged. Not an AiPrise-owned enum." }, "title": { "type": "string" }, "description": { "type": "string" }, "indicator_attributes": { "type": "object" }, "metadata": { "type": "object" } } }, "DocumentMetadata": { "type": "object", "properties": { "producer": { "type": "string" }, "creator": { "type": "string" }, "creation_date": { "type": "string" }, "modification_date": { "type": "string" }, "author": { "type": "string" }, "title": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" } } }, "DocumentInsights": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "info_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInsightsIndicator" } }, "risk_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInsightsIndicator" } }, "trust_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInsightsIndicator" } }, "document_metadata": { "$ref": "#/components/schemas/DocumentMetadata" }, "document_class_id": { "type": "string", "description": "Passed through from the document fraud provider. Not an AiPrise-owned enum, so the value set is not fixed. Values are lowercase, for example account_statement." }, "document_class_type": { "type": "string", "description": "Passed through from the document fraud provider. Not an AiPrise-owned enum, so the value set is not fixed. Values are lowercase, for example account_statement." }, "document_class_variant": { "type": "string", "description": "Passed through from the document fraud provider. Not an AiPrise-owned enum, so the value set is not fixed. Values are lowercase, for example account_statement." }, "section_id": { "type": "string" }, "document_data": { "type": "object", "additionalProperties": {} } } }, "Question": { "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "answer": { "type": "string", "nullable": true }, "answer_file": { "type": "string", "nullable": true }, "order": { "type": "number", "nullable": true }, "answer_type": { "nullable": true, "$ref": "#/components/schemas/QuestionType" }, "answer_language": { "type": "string", "nullable": true } } }, "QuestionGroupMetaData": { "type": "object", "properties": { "template_id": { "type": "string" }, "verification_session_id": { "type": "string" }, "updated_at": { "type": "integer" } } }, "QuestionGroup": { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/Question" }, { "type": "string" }, { "$ref": "#/components/schemas/QuestionGroupMetaData" } ] } }, "BusinessData": { "type": "object", "properties": { "name": { "type": "string", "description": "The business name. (Legal name preferred)", "example": "AiPrise" }, "alternate_name": { "type": "string", "description": "Alternate business name. (DBA)", "example": "AiPrise Inc" }, "tax_identification_number": { "type": "string", "description": "Tax ID" }, "website": { "type": "string", "description": "The business website", "example": "www.aiprise.com" }, "formation_date": { "type": "string", "example": "1999-03-21", "description": "The formation date in YYYY-MM-DD format" }, "country_code": { "type": "string", "description": "A 2-letter ISO country code where business is primarily registered.", "example": "US" }, "state_code": { "type": "string", "description": "State Code of the province/region where business is primarily registered." }, "business_entity_id": { "type": "string", "description": "Entity ID given by the government to the business." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "List of addresses associated with this business" }, "phone_numbers": { "type": "array", "items": { "type": "string", "example": "+13334445555" }, "description": "List of phone numbers associated with this business" }, "email_addresses": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses associated with this business" } } }, "BusinessDataWithPrefillData": { "allOf": [ { "$ref": "#/components/schemas/BusinessData" } ], "properties": { "related_people": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RelatedPersonInfo" }, { "$ref": "#/components/schemas/RelatedPersonInfoV2Input" } ] } } } }, "BusinessProfileInputOnly": { "type": "object", "properties": { "name": { "type": "string", "description": "The business name. (Legal name preferred)", "example": "AiPrise" }, "alternate_name": { "type": "string", "description": "Alternate business name. (DBA)", "example": "AiPrise Inc" }, "tax_identification_number": { "type": "string", "description": "Tax ID" }, "website": { "type": "string", "description": "The business website", "example": "www.aiprise.com" }, "formation_date": { "type": "string", "example": "1999-03-21", "description": "The formation date in YYYY-MM-DD format" }, "country_code": { "type": "string", "description": "A 2-letter ISO country code where business is primarily registered.", "example": "US" }, "state_code": { "type": "string", "description": "State Code of the province/region where business is primarily registered." }, "business_entity_id": { "type": "string", "description": "Entity ID given by the government to the business." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "List of addresses associated with this business" }, "phone_numbers": { "type": "array", "items": { "type": "string", "example": "+13334445555" }, "description": "List of phone numbers associated with this business" }, "email_addresses": { "type": "array", "items": { "type": "string" }, "description": "List of email addresses associated with this business" }, "additional_information": { "$ref": "#/components/schemas/CreateBusinessProfileAdditionalInformation" }, "client_reference_id": { "type": "string", "example": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810", "description": "An id you want to associate with the business profile." }, "client_reference_data": { "type": "object", "description": "A JSON you want to associate with the business profile." }, "callback_url": { "type": "string", "example": "https://yourwebsite.com/aiprise-callback" }, "events_callback_url": { "type": "string", "example": "https://yourwebsite.com/aiprise-callback" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag names associated with this business profile" } } }, "BusinessProfileComputedOnly": { "type": "object", "properties": { "verification_session_ids": { "type": "array", "items": { "type": "string" }, "description": "List of verification sessions run against this business" }, "related_people": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RelatedPersonWithComputedFields" }, { "$ref": "#/components/schemas/RelatedPersonInfoV2" } ] }, "description": "List of Related People associated with this business" }, "related_companies": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/RelatedCompanyWithComputedFields" }, { "$ref": "#/components/schemas/RelatedCompanyInfoV2" } ] }, "description": "List of Related Companies associated with this business" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessMediaFile" }, "description": "List of Documents associated with this business" }, "business_info": { "$ref": "#/components/schemas/BusinessInfo", "description": "A JSON response of BusinessInfo object." }, "registration_info": { "$ref": "#/components/schemas/RegistrationInfo", "description": "A JSON response of RegistrationInfo object." }, "lookup_info": { "type": "array", "items": { "$ref": "#/components/schemas/LookupInfo" }, "description": "A JSON response of array of LookupInfo object." }, "website_info": { "$ref": "#/components/schemas/WebsiteInfo", "description": "A JSON response of WebsiteInfo object." }, "online_presence_info": { "$ref": "#/components/schemas/OnlinePresenceInfo", "description": "A JSON response of OnlinePresenceInfo object." }, "aml_info": { "$ref": "#/components/schemas/AMLInfo", "description": "A JSON response of AMLInfo object." }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "description": "A JSON response of array of EventInfo object." }, "business_profile_id": { "type": "string" }, "business_profile_result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "lifecycle_status": { "type": "string", "nullable": true, "enum": [ "PROFILE_NOT_SUBMITTED", "ONBOARDING_SESSIONS_PENDING", "READY_FOR_REVIEW", "ADDITIONAL_INFO_REQUESTED", "MONITORING_UPDATES", "SESSIONS_EXPIRED" ], "description": "The current lifecycle status of the business profile" }, "questions_response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuestionGroup" } }, "fraud_insights": { "$ref": "#/components/schemas/FraudInsights" }, "created_at": { "type": "integer", "example": 1658201633363 }, "updated_at": { "type": "integer", "example": 1658201633363 }, "risk_info": { "$ref": "#/components/schemas/RiskInfo", "nullable": true }, "aml_monitoring_info": { "type": "array", "items": { "$ref": "#/components/schemas/AMLMonitoringUpdate" } } } }, "BusinessProfile": { "allOf": [ { "$ref": "#/components/schemas/BusinessProfileInputOnly" }, { "$ref": "#/components/schemas/BusinessProfileComputedOnly" } ] }, "BusinessActivity": { "type": "object", "properties": { "code": { "type": "string" }, "code_type": { "type": "string" }, "description": { "type": "string" }, "activity_type": { "type": "string", "enum": [ "primary", "secondary" ] } } }, "BusinessScope": { "type": "object", "properties": { "business_description": { "type": "string", "nullable": true }, "business_activities": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessActivity" } } } }, "BusinessInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "name": { "type": "string" }, "entity_type": { "type": "string" }, "phone_numbers": { "type": "array", "items": { "type": "string" } }, "emails": { "type": "array", "items": { "type": "string" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedAddress" } }, "website": { "type": "string" }, "tax_id": { "type": "string" }, "business_id": { "type": "string" }, "business_scope": { "$ref": "#/components/schemas/BusinessScope" }, "country_code": { "type": "string" }, "additional_fields": { "type": "object", "additionalProperties": {} }, "section_id": { "type": "string" } } }, "RegistrationRecord": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "record_id": { "type": "string", "nullable": true }, "entity_type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "registration_date": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "source_url": { "type": "string", "nullable": true }, "source_name": { "type": "string", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/ExtractedAddress" } }, "additional_fields": { "type": "object", "description": "Additional fields for the registration record.", "example": { "key": "value" } } } }, "RegistrationInfo": { "type": "object", "properties": { "formation_date": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "normalised_status": { "type": "string", "nullable": true }, "registration_records": { "type": "array", "items": { "$ref": "#/components/schemas/RegistrationRecord" } } } }, "PersonRoleDetails": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "start_date": { "type": "string", "nullable": true }, "end_date": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "normalised_name": { "$ref": "#/components/schemas/NormalisedRole", "nullable": true } } }, "PersonKYCInfo": { "type": "object", "properties": { "verification_session_id": { "type": "string", "nullable": true }, "verification_result": { "type": "string", "nullable": true }, "risk_info": { "$ref": "#/components/schemas/RiskInfo", "nullable": true } } }, "RelatedPersonInfo": { "type": "object", "properties": { "first_name": { "type": "string", "nullable": true }, "middle_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "birth_date": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/ExtractedAddress" }, "ownership_percent": { "type": "number", "nullable": true }, "person_reference_id": { "type": "string", "nullable": false }, "shares_allocated": { "type": "integer", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRoleDetails" } }, "identity": { "$ref": "#/components/schemas/OutputIdentity" }, "additional_fields": { "type": "object" }, "client_reference_id": { "type": "string" }, "client_reference_data": { "type": "object" }, "source": { "type": "array", "items": { "type": "string" } }, "added_via": { "type": "string", "nullable": true } } }, "RelatedPersonComputedOnly": { "type": "object", "properties": { "kyc": { "$ref": "#/components/schemas/PersonKYCInfo" }, "verification_sessions": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/VerificationSessions" } }, "questions_response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuestionGroup" }, "description": "Questions responded by the user" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFile" } } } }, "RelatedPersonWithComputedFields": { "allOf": [ { "$ref": "#/components/schemas/RelatedPersonInfo" }, { "$ref": "#/components/schemas/RelatedPersonComputedOnly" } ] }, "RelatedPersonInfoV2Input": { "type": "object", "properties": { "person_reference_id": { "type": "string", "nullable": false }, "user_profile": { "$ref": "#/components/schemas/UserProfileInputOnly" }, "ownership_percent": { "type": "number", "nullable": true }, "shares_allocated": { "type": "integer", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRoleDetails" } }, "additional_fields": { "type": "object" } } }, "RelatedPersonInfoV2": { "type": "object", "properties": { "person_reference_id": { "type": "string", "nullable": false }, "user_profile": { "allOf": [ { "$ref": "#/components/schemas/ExternalUserProfile" }, { "type": "object", "properties": { "source": { "type": "array", "items": { "type": "string" }, "nullable": true }, "added_via": { "type": "string", "nullable": true } } } ] }, "ownership_percent": { "type": "number", "nullable": true }, "shares_allocated": { "type": "integer", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRoleDetails" } }, "additional_fields": { "type": "object" }, "other_relationship_data": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityOtherRelationshipData" } } } }, "CompanyRoleDetails": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "start_date": { "type": "string", "nullable": true }, "end_date": { "type": "string", "nullable": true }, "is_active": { "type": "boolean", "nullable": true }, "normalised_name": { "$ref": "#/components/schemas/NormalisedRole", "nullable": true } } }, "CompanyKYBInfo": { "type": "object", "properties": { "verification_session_id": { "type": "string", "nullable": true }, "verification_result": { "type": "string", "nullable": true }, "risk_info": { "$ref": "#/components/schemas/RiskInfo", "nullable": true } } }, "RelatedCompanyInfo": { "type": "object", "properties": { "company_reference_id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "addresses": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ExtractedAddress" } }, "ownership_percent": { "type": "number", "nullable": true }, "shares_allocated": { "type": "integer", "nullable": true }, "alternate_name": { "type": "string", "nullable": true }, "tax_identification_number": { "type": "string", "nullable": true }, "formation_date": { "type": "string" }, "website": { "type": "string", "nullable": true }, "state_code": { "type": "string", "nullable": true }, "business_entity_id": { "type": "string", "nullable": true }, "roles": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CompanyRoleDetails" } }, "phone_numbers": { "type": "array", "nullable": true, "items": { "type": "string" } }, "additional_fields": { "nullable": true, "type": "object" }, "email_addresses": { "type": "array", "nullable": true, "items": { "type": "string" } }, "client_reference_id": { "type": "string" }, "client_reference_data": { "type": "object" }, "source": { "type": "array", "items": { "type": "string" } }, "added_via": { "type": "string", "nullable": true } } }, "RelatedCompanyInfoV2": { "type": "object", "properties": { "company_reference_id": { "type": "string", "nullable": false }, "business_profile": { "allOf": [ { "$ref": "#/components/schemas/BusinessProfileInputOnly" }, { "type": "object", "properties": { "business_profile_id": { "type": "string" }, "business_profile_result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "questions_response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuestionGroup" } }, "risk_info": { "$ref": "#/components/schemas/RiskInfo", "nullable": true }, "created_at": { "type": "integer", "example": 1658201633363 }, "source": { "type": "array", "items": { "type": "string" }, "nullable": true }, "added_via": { "type": "string", "nullable": true } } } ] }, "ownership_percent": { "type": "number", "nullable": true }, "shares_allocated": { "type": "integer", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRoleDetails" } }, "additional_fields": { "type": "object" }, "relationship_type": { "$ref": "#/components/schemas/RelatedEntityRelationshipType", "nullable": true }, "other_relationship_data": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedEntityOtherRelationshipData" } } } }, "RelatedEntityRelationshipType": { "type": "string", "nullable": true, "enum": [ "PARENT", "CHILD", "SIBLING", "UNKNOWN" ] }, "NormalisedRole": { "type": "string", "nullable": true, "enum": [ "ULTIMATE_BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SHAREHOLDER", "EMPLOYEE", "UNKNOWN" ] }, "RelatedEntityOtherRelationshipData": { "type": "object", "properties": { "source_name": { "type": "string", "nullable": false }, "source_id": { "type": "string", "nullable": false }, "relationship_type": { "type": "string", "nullable": false }, "ownership_percent": { "type": "number", "nullable": true }, "shares_allocated": { "type": "integer", "nullable": true }, "roles": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRoleDetails" } }, { "type": "array", "items": { "$ref": "#/components/schemas/PersonRoleDetails" } } ] } } }, "BusinessAdditionalInfoFileUploadType": { "type": "string", "nullable": true, "enum": [ "BANK_STATEMENT_DOCUMENT", "BUSINESS_REGISTRATION_DOCUMENT", "OPERATING_LICENSE_DOCUMENT", "SOURCE_OF_FUNDS_DOCUMENT", "ADDRESS_PROOF_DOCUMENT", "CHAMBER_OF_COMMERCE_CERTIFICATE", "CAC_CERTIFICATE", "ARTICLES_OF_INCORPORATION", "AML_POLICY", "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION", "DIRECTORS_REGISTRY", "CORPORATE_CHART", "SHAREHOLDERS_REGISTRY", "BALANCE_SHEET", "REPORTING_ENTITY_REGISTRATION_DOCUMENT", "COMPANY_CONSTITUTION", "MEMORANDUM_OF_ASSOCIATION", "PARTNERSHIP_DEED", "CERTIFIED_ANNUAL_RETURNS_STATEMENT", "COMPANY_PROFILE", "AUDITED_ACCOUNTS", "ANTI_BRIBERY_POLICY", "DATA_PROTECTION_POLICY", "FRAUD_CHECK_DOCUMENT", "INVOICE", "PEP_FORM", "TAX_REGISTRATION_DOCUMENT_CONSTANCIA_DE_SITUACION_FISCAL", "TAX_REGISTRATION_CERTIFICATE", "INTENDED_USAGE_DOCUMENT", "OTHER" ] }, "RelatedCompanyInfoComputedOnly": { "type": "object", "properties": { "kyb": { "nullable": true, "$ref": "#/components/schemas/CompanyKYBInfo" }, "verification_sessions": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/VerificationSessions" } }, "questions_response": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuestionGroup" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFile" } } } }, "RelatedCompanyWithComputedFields": { "allOf": [ { "$ref": "#/components/schemas/RelatedCompanyInfo" }, { "$ref": "#/components/schemas/RelatedCompanyInfoComputedOnly" } ] }, "WebsiteRiskIndicator": { "type": "object", "description": "Risk indicator identified during web presence analysis", "properties": { "indicator": { "type": "string", "description": "The risk indicator value" }, "detail": { "type": "string", "description": "Description of the risk indicator" }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ], "description": "Severity level of the risk indicator" }, "evidence": { "type": "string", "description": "Proof or reasoning for the assigned severity" } } }, "NetworkEdge": { "type": "object", "description": "Edge between two domains in a network (association)", "properties": { "from": { "type": "string", "description": "Source domain" }, "to": { "type": "string", "description": "Target domain" }, "association_type": { "type": "string", "description": "Type of association (e.g. shared_tracking_id, shared_ssl_cert, shared_registrant)" }, "association_detail": { "type": "string", "description": "Human-readable detail of the association" }, "first_seen": { "type": "string", "description": "Date when the association was first observed (YYYY-MM-DD)" } } }, "AssociatedNetwork": { "type": "object", "description": "Associated domain network (domains and edges between them)", "properties": { "domains": { "type": "array", "items": { "type": "string" }, "description": "List of associated domains in this network" }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkEdge" }, "description": "Edges (associations) between domains in this network" } } }, "NetworkIntelligenceTag": { "type": "object", "properties": { "id": { "type": "integer" }, "tag": { "type": "string", "nullable": true } } }, "NetworkIntelligence": { "type": "object", "description": "Network intelligence showing associated domain networks", "properties": { "associated_networks": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedNetwork" }, "description": "List of associated domain networks" }, "taint_status": { "type": "string", "nullable": true, "enum": [ "FRAUD", "NOT_FRAUD", "UNKNOWN", null ], "description": "Fraud-network verdict (FRAUD / NOT_FRAUD / UNKNOWN)" }, "network_intelligence_tags": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkIntelligenceTag" }, "nullable": true, "description": "Closed-set descriptors classifying the network shape" }, "field_evidence_log": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldEvidence" }, "nullable": true }, "summary": { "type": "string", "nullable": true, "description": "Customer-facing summary of the related-domain network" } } }, "WebsiteInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "site_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "domain_creation_date": { "type": "string", "nullable": true }, "domain_expiration_date": { "type": "string", "nullable": true }, "truebiz_request_id": { "type": "string", "nullable": true }, "section_id": { "type": "string" }, "average_review": { "type": "string", "nullable": true }, "interactions_of_interest": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "snippet": { "type": "string" } } } }, "adverse_media": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "snippet": { "type": "string" } } } }, "critically_concerning_issues": { "type": "array", "items": { "type": "string" } }, "estimated_employee_count_range": { "type": "string", "nullable": true }, "is_public": { "type": "boolean", "nullable": true }, "financial_info": { "type": "object", "$ref": "#/components/schemas/WebsiteFinancials" }, "domain_info": { "type": "object", "$ref": "#/components/schemas/WebsiteDomainInfo" }, "name": { "type": "string" }, "founded_year": { "type": "string", "nullable": true }, "formation_type": { "type": "string" }, "industry_info": { "type": "object", "$ref": "#/components/schemas/IndustryInfo" }, "risk_factors": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactors" } }, "social_media_profiles": { "type": "array", "items": { "type": "string" } }, "social_media_insights": { "$ref": "#/components/schemas/SocialMediaInsights" }, "website_content": { "type": "object", "$ref": "#/components/schemas/WebsiteContent" }, "traffic_info": { "type": "object", "$ref": "#/components/schemas/TrafficInfo" }, "backlinks": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "inline_rank": { "type": "integer" } } } }, "total_backlinks": { "type": "integer", "nullable": true }, "web_presence_report_summary": { "type": "string", "nullable": true }, "web_presence_report_summary_checklist": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "result": { "type": "string" }, "message": { "type": "string" } } } }, "industry_inconsistencies": { "type": "array", "items": { "type": "string" }, "description": "Industry inconsistencies between registration and website presentation" }, "social_media_profiles_referring_to_different_business": { "type": "array", "items": { "type": "string" }, "description": "Social media profiles that refer to a different business" }, "risk_indicators": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteRiskIndicator" }, "description": "Risk indicators identified during web presence analysis" }, "network_intelligence": { "$ref": "#/components/schemas/NetworkIntelligence" } } }, "InstagramPostSummary": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true, "description": "Video, Image, or Sidecar" }, "caption": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "likes_count": { "type": "integer", "nullable": true }, "comments_count": { "type": "integer", "nullable": true }, "video_view_count": { "type": "integer", "nullable": true }, "timestamp": { "type": "string", "nullable": true } } }, "InstagramProfileInsights": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "biography": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "external_url": { "type": "string", "nullable": true }, "followers_count": { "type": "integer", "nullable": true }, "follows_count": { "type": "integer", "nullable": true }, "posts_count": { "type": "integer", "nullable": true }, "is_business_account": { "type": "boolean", "nullable": true }, "is_verified": { "type": "boolean", "nullable": true }, "is_private": { "type": "boolean", "nullable": true }, "profile_pic_url": { "type": "string", "nullable": true }, "business_category_name": { "type": "string", "nullable": true }, "latest_posts": { "type": "array", "items": { "$ref": "#/components/schemas/InstagramPostSummary" }, "description": "Latest 5 posts from the profile" } } }, "SocialMediaInsights": { "type": "object", "properties": { "instagram": { "$ref": "#/components/schemas/InstagramProfileInsights" }, "facebook": { "$ref": "#/components/schemas/FacebookPageInsights" }, "linkedin": { "$ref": "#/components/schemas/LinkedInCompanyInsights" } } }, "FacebookLinkedInstagram": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "FacebookPageInsights": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "biography": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "external_url": { "type": "string", "nullable": true }, "followers_count": { "type": "integer", "nullable": true }, "follows_count": { "type": "integer", "nullable": true }, "is_business_account": { "type": "boolean", "nullable": true }, "business_category_name": { "type": "string", "nullable": true }, "business_address": { "$ref": "#/components/schemas/ExtractedAddress", "nullable": true }, "profile_pic_url": { "type": "string", "nullable": true }, "likes_count": { "type": "integer", "nullable": true }, "business_categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "business_hours": { "type": "string", "nullable": true }, "price_range": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "cover_photo_url": { "type": "string", "nullable": true }, "rating_overall": { "type": "integer", "nullable": true, "description": "Percentage, e.g. 94 for 94%" }, "rating_count": { "type": "integer", "nullable": true }, "rating_description": { "type": "string", "nullable": true }, "services": { "type": "string", "nullable": true }, "creation_date": { "type": "string", "nullable": true }, "ad_status": { "type": "string", "nullable": true }, "is_ad_library_active": { "type": "boolean", "nullable": true }, "linked_instagram": { "type": "array", "items": { "$ref": "#/components/schemas/FacebookLinkedInstagram" }, "nullable": true }, "alternative_social_media": { "type": "string", "nullable": true }, "websites": { "type": "array", "items": { "type": "string" }, "nullable": true }, "info": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messenger": { "type": "string", "nullable": true } } }, "LinkedInKeyPerson": { "type": "object", "description": "Represents a key person (executive/employee) from LinkedIn company page", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the person (clickable link to LinkedIn profile)" }, "linkedin_profile_url": { "type": "string", "nullable": true, "description": "LinkedIn profile URL (makes name clickable)" }, "designation": { "type": "string", "nullable": true, "description": "Designation/Title (e.g., CEO, CTO, Software Engineer)" }, "profile_image_url": { "type": "string", "nullable": true, "description": "Profile image URL (for circular icon display)" } } }, "LinkedInKeyPeopleInsights": { "type": "object", "description": "Container for LinkedIn key people (executives/employees) insights", "properties": { "key_people": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedInKeyPerson" }, "nullable": true, "description": "List of key people" }, "total_count": { "type": "integer", "nullable": true, "description": "Total count of key people" } } }, "LinkedInCompanyInsights": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "full_name": { "type": "string", "nullable": true }, "biography": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "external_url": { "type": "string", "nullable": true }, "followers_count": { "type": "integer", "nullable": true }, "follows_count": { "type": "integer", "nullable": true }, "is_business_account": { "type": "boolean", "nullable": true }, "business_category_name": { "type": "string", "nullable": true }, "business_address": { "$ref": "#/components/schemas/ExtractedAddress", "nullable": true }, "profile_pic_url": { "type": "string", "nullable": true }, "tagline": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "specialties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "industries": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hashtags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "employee_count": { "type": "integer", "nullable": true }, "employee_count_range": { "type": "string", "nullable": true }, "founded_year": { "type": "integer", "nullable": true }, "is_verified": { "type": "boolean", "nullable": true }, "logo_url": { "type": "string", "nullable": true }, "cover_url": { "type": "string", "nullable": true }, "funding_total_rounds": { "type": "integer", "nullable": true }, "funding_latest_type": { "type": "string", "nullable": true }, "funding_latest_date": { "type": "string", "nullable": true }, "funding_latest_url": { "type": "string", "nullable": true }, "funding_latest_investors_count": { "type": "integer", "nullable": true }, "crunchbase_url": { "type": "string", "nullable": true }, "key_people": { "$ref": "#/components/schemas/LinkedInKeyPeopleInsights", "nullable": true, "description": "Key people (executives/employees) from the company" } } }, "OnlinePresenceInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2" }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" } }, "result": { "$ref": "#/components/schemas/AiPriseAPIResultStatusV2" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" } }, "section_id": { "type": "string" }, "company_data": { "type": "object" }, "name": { "type": "string", "description": "Registered business name" }, "formation_date": { "type": "string", "description": "Formation date of the business" }, "website": { "type": "string", "description": "Website URL of the company" }, "address": { "$ref": "#/components/schemas/ExtractedAddress", "description": "Structured company address information" }, "ubos": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPersonInfo" }, "description": "List of Ultimate Beneficial Owners of the business" }, "tax_identification_number": { "type": "string", "description": "Tax ID" }, "business_entity_id": { "type": "string", "description": "Entity ID given by the government to the business." } } }, "WebsiteContent": { "type": "object", "properties": { "description": { "type": "string" }, "evaluated_url": { "type": "string" }, "title": { "type": "string" }, "real_website": { "type": "string", "enum": [ "YES", "PARKED", "NO" ] }, "compliance": { "type": "array", "items": { "type": "string" } }, "harmful_content": { "type": "boolean" }, "industries": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" }, "mlm_links": { "type": "array", "items": { "type": "string" } }, "number_of_bad_policies": { "type": "integer" }, "number_of_mlm_links": { "type": "integer" }, "pages_linked": { "type": "integer" }, "policy_analysis": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyEntry" } }, "customers": { "type": "array", "items": { "type": "string" } }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteContentPhoneInfo" } }, "email": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteContentEmailInfo" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteContentAddressInfo" } }, "screenshot_url": { "type": "string" }, "historic_screenshots_urls_and_timestamps": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "timestamp": { "type": "number" } } } }, "is_website_authentic": { "type": "boolean" }, "website_authenticity_reasoning": { "type": "string" }, "keyword_contexts": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "context": { "type": "string" }, "url": { "type": "string" } } } }, "summary_notes": { "type": "string" }, "has_placeholder_text": { "type": "boolean", "description": "Whether placeholder text is detected on the website" }, "content_inconsistencies": { "type": "array", "items": { "type": "string" }, "description": "List of content inconsistencies found on the website" }, "has_stock_images": { "type": "string", "description": "Description of stock images found on the website" }, "deadlinks": { "type": "array", "items": { "type": "string" }, "description": "List of dead links detected on the website" }, "blog_or_news_last_updated_date": { "type": "string", "description": "Date when blog or news section was last updated" }, "website_last_updated_date": { "type": "string", "description": "Date when website was last updated" } } }, "PolicyEntry": { "type": "object", "properties": { "policy_type": { "type": "string" }, "policy_url": { "type": "string" }, "policy_text": { "type": "string" } } }, "WebsiteFinancials": { "type": "object", "properties": { "funding_amount": { "type": "string", "nullable": true }, "revenue_amount": { "type": "string", "nullable": true }, "net_income": { "type": "string", "nullable": true }, "debtToEquity": { "type": "string", "nullable": true }, "marketCapitalization": { "type": "string", "nullable": true } } }, "RiskFactors": { "type": "object", "properties": { "category": { "type": "string" }, "classification_type": { "type": "string" }, "description": { "type": "string" }, "risk_element_name": { "type": "string" }, "display_name": { "type": "string" }, "score": { "type": "number" }, "subcategory": { "type": "string" } } }, "WebsiteDomainInfo": { "type": "object", "properties": { "name": { "type": "string" }, "registrar": { "type": "string" }, "registrar_country": { "type": "string" }, "registration_date": { "type": "string" }, "last_update_date": { "type": "string" }, "expiration_date": { "type": "string" }, "has_robots_txt": { "type": "boolean" }, "is_known_free_email_host": { "type": "boolean" }, "is_known_hosting_provider_domain": { "type": "boolean" }, "is_known_marketplace_domain": { "type": "boolean" }, "is_known_social_media_domain": { "type": "boolean" }, "is_known_top_domain": { "type": "boolean" }, "is_non_business": { "type": "boolean" }, "is_parked": { "type": "boolean" }, "is_registered": { "type": "boolean" }, "is_resolvable": { "type": "boolean" }, "is_ssl_valid": { "type": "boolean" }, "is_webserver_responsive": { "type": "boolean" }, "domain_history": { "type": "array", "items": { "type": "string" } }, "hosting_provider": { "type": "string" }, "hosting_provider_category": { "type": "string" }, "supports_apex_and_www": { "type": "boolean" }, "inbound_linking_domains": { "type": "integer" }, "whois_privacy_mode": { "type": "string" }, "domain_age": { "type": "integer" }, "dns_address_status": { "type": "string" }, "ns_status": { "type": "string" }, "DNS_records": { "type": "array", "items": { "type": "string" } }, "tech_stack_used": { "type": "array", "items": { "type": "string" } } } }, "WebsiteContentPhoneInfo": { "type": "object", "properties": { "number": { "type": "string" }, "is_verified": { "type": "boolean" }, "country_code": { "type": "string" } } }, "WebsiteContentEmailInfo": { "type": "object", "properties": { "email": { "type": "string" }, "is_verified": { "type": "boolean" } } }, "WebsiteContentAddressInfo": { "type": "object", "properties": { "address": { "type": "object", "$ref": "#/components/schemas/ExtractedAddress" }, "is_verified": { "type": "boolean" } } }, "IndustryInfo": { "type": "object", "properties": { "additional_mcc_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } } }, "additional_naics_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } } }, "additional_sic_codes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } } }, "primary_industry": { "type": "string" }, "primary_mcc": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "primary_naics": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "primary_sic": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "high_risk_industry_contexts": { "type": "array", "items": { "type": "object", "properties": { "industry": { "type": "string" }, "context": { "type": "string" }, "url": { "type": "string" }, "role": { "type": "string" }, "confidence": { "type": "string" } } } }, "prohibited_industry_contexts": { "type": "array", "items": { "type": "object", "properties": { "industry": { "type": "string" }, "context": { "type": "string" }, "url": { "type": "string" }, "role": { "type": "string" }, "confidence": { "type": "string" } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "primary_risky_industry_flag": { "type": "boolean" }, "additional_risky_industry_flag": { "type": "boolean" } } }, "TrafficInfo": { "type": "object", "properties": { "visits_per_month": { "type": "number" }, "time_on_site": { "type": "number" }, "pages_per_visit": { "type": "number" }, "bounce_rate": { "type": "number" }, "traffic_trends": { "type": "object" }, "traffic_by_country": { "type": "object" }, "traffic_by_source": { "type": "object" }, "top_organic_keywords": { "type": "array", "items": { "type": "string" } } } }, "EventInfo": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "event_type": { "type": "string", "nullable": true }, "metadata": { "type": "object", "nullable": true } } }, "LookupInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AiPriseRunStatusV2", "nullable": true }, "status_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/StatusReasonCodeEntry" }, "nullable": true }, "result": { "$ref": "#/components/schemas/AiPriseResultStatusV2", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningEntry" }, "nullable": true }, "database_name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "data": { "type": "object", "nullable": true }, "section_id": { "type": "string" } } }, "RiskLevelEnum": { "type": "string", "nullable": true, "example": null, "enum": [ "PROHIBITED", "HIGH", "MEDIUM", "LOW" ] }, "EvaluatedRiskRuleStatusEnum": { "type": "string", "nullable": true, "example": null, "enum": [ "PASSED", "NOT_PASSED", "FAILED" ] }, "EvaluatedRiskRule": { "type": "object", "properties": { "rule_name": { "type": "string", "nullable": true }, "result": { "$ref": "#/components/schemas/AiPriseResultStatusV2", "nullable": true }, "score": { "type": "number", "nullable": true }, "status": { "$ref": "#/components/schemas/EvaluatedRiskRuleStatusEnum", "nullable": true } } }, "AMLMonitoringUpdate": { "type": "object", "properties": { "added_entity_hits": { "type": "array", "items": { "$ref": "#/components/schemas/EntityHit" }, "nullable": true }, "removed_entity_hits": { "type": "array", "items": { "$ref": "#/components/schemas/EntityHit" }, "nullable": true }, "updated_entity_hits": { "type": "array", "items": { "$ref": "#/components/schemas/EntityHit" }, "nullable": true }, "created_at": { "type": "number", "nullable": true } } }, "RiskInfoScoring": { "type": "object", "properties": { "score": { "type": "number", "nullable": true }, "risk_level": { "$ref": "#/components/schemas/RiskLevelEnum", "nullable": true }, "rules_evaluated": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedRiskRule" } }, "section_id": { "type": "string", "nullable": true } } }, "RiskInfoDecisioning": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/AiPriseResultStatusV2", "nullable": true }, "rules_evaluated": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedRiskRule" } }, "section_id": { "type": "string", "nullable": true } } }, "RiskInfo": { "type": "object", "properties": { "scoring": { "$ref": "#/components/schemas/RiskInfoScoring" }, "decisioning": { "$ref": "#/components/schemas/RiskInfoDecisioning" } } }, "MediaFile": { "type": "object", "properties": { "file_uuid": { "type": "string", "nullable": false }, "file_name": { "type": "string", "nullable": false }, "file_type": { "type": "string", "nullable": true }, "file_s3_url": { "type": "string", "nullable": false } } }, "BusinessMediaFile": { "type": "object", "properties": { "file_uuid": { "type": "string", "nullable": false }, "file_name": { "type": "string", "nullable": false }, "file_type": { "type": "string", "nullable": true }, "file_s3_url": { "type": "string", "nullable": false }, "file_blob": { "type": "string", "nullable": false }, "file_created_at": { "type": "integer", "nullable": true }, "file_source": { "type": "string", "nullable": true }, "document_source_authority": { "type": "string", "nullable": true }, "document_source_authority_code": { "type": "string", "nullable": true }, "file_format_type": { "type": "string", "nullable": true }, "is_purchased": { "type": "boolean", "nullable": true }, "document_price": { "type": "string", "nullable": true }, "order_status": { "type": "string", "nullable": true }, "estimated_response_time": { "type": "string", "nullable": true }, "document_date": { "type": "integer", "nullable": false }, "document_published_date": { "type": "string", "nullable": true }, "verification_sessions": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/VerificationSessions" } } } }, "VerificationSessions": { "type": "object", "properties": { "verification_session_id": { "type": "string", "nullable": false }, "result": { "type": "string", "nullable": false }, "created_at": { "type": "integer", "nullable": true } } }, "ThemeOptions": { "type": "object", "properties": { "background": { "type": "string", "nullable": true, "enum": [ "light", "dark" ] }, "color_page": { "type": "string", "nullable": true, "example": "#5251FD" }, "color_brand": { "type": "string", "nullable": true, "example": "#5251FD" }, "color_brand_overlay": { "type": "string", "nullable": true, "example": "#5251FD" }, "font_name": { "type": "string", "nullable": true, "example": "Plus Jakarta Sans" }, "font_weights": { "type": "string", "nullable": true, "example": "300,400,500,600,700" }, "button_border_radius": { "type": "string", "nullable": true, "example": "8px" }, "button_padding": { "type": "string", "nullable": true, "example": "18px" }, "button_font_size": { "type": "string", "nullable": true, "example": "16px" }, "button_font_weight": { "type": "string", "nullable": true, "example": "400" }, "input_border_radius": { "type": "string", "nullable": true, "example": "8px" }, "input_padding": { "type": "string", "nullable": true, "example": "14px 18px" }, "input_font_size": { "type": "string", "nullable": true, "example": "16px" }, "input_font_weight": { "type": "string", "nullable": true, "example": "500" }, "input_label_font_size": { "type": "string", "nullable": true, "example": "16px" }, "input_label_font_weight": { "type": "string", "nullable": true, "example": "500" }, "layout_border_radius": { "type": "string", "nullable": true, "example": "18px" }, "modal_border_radius": { "type": "string", "nullable": true, "example": "12px" }, "image_border_radius": { "type": "string", "nullable": true, "example": "12px" } } }, "ExtendedUIOptionsWithDynamicModules": { "type": "object", "properties": { "common": { "type": "object", "properties": { "default_language": { "type": "string", "example": "en" } } }, "dynamic_business_document_module": { "$ref": "#/components/schemas/DynamicBusinessDocumentModule" }, "dynamic_business_question_group_module": { "$ref": "#/components/schemas/DynamicBusinessQuestionGroupModule" } } }, "DynamicBusinessDocumentModule": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicDocument" } } } }, "DynamicDocument": { "type": "object", "required": [ "file_type", "required", "auto_run_check" ], "properties": { "subtitle": { "$ref": "#/components/schemas/LanguageMap" }, "required": { "type": "boolean" }, "auto_run_check": { "type": "boolean" }, "file_type": { "$ref": "#/components/schemas/BusinessAdditionalInfoFileUploadType" } } }, "LanguageMap": { "type": "object", "properties": { "en": { "type": "string" }, "fr": { "type": "string" }, "it": { "type": "string" }, "es": { "type": "string" }, "pt": { "type": "string" }, "de": { "type": "string" }, "pl": { "type": "string" }, "ja": { "type": "string" }, "ko": { "type": "string" }, "zh": { "type": "string" }, "ru": { "type": "string" }, "ar": { "type": "string" } } }, "DynamicQuestion": { "type": "object", "required": [ "type", "title", "required", "order" ], "properties": { "type": { "$ref": "#/components/schemas/QuestionType" }, "title": { "$ref": "#/components/schemas/LanguageMap" }, "subtitle": { "$ref": "#/components/schemas/LanguageMap" }, "required": { "type": "boolean" }, "order": { "type": "integer" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageMap" } } } }, "DynamicBusinessQuestionGroupModule": { "type": "object", "properties": { "questions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DynamicQuestion" }, "description": "Each key must be a string that matches the pattern /^Q\\d{2}$/ (e.g., Q01, Q02, Q99).\n", "example": { "Q01": { "type": "SINGLE_CHOICE", "title": { "en": "What is your business type?" }, "subtitle": { "en": "Select one" }, "required": true, "order": 0, "options": [ { "en": "Retail", "fr": "Vente au détail" }, { "en": "Wholesale", "fr": "Vente en gros" } ] }, "Q02": { "type": "TEXT", "title": { "en": "Describe your services" }, "subtitle": { "en": "" }, "required": false, "order": 1 } } } } }, "VerificationOptions": { "type": "object", "properties": { "aml_config": { "type": "object", "properties": { "exact_match": { "type": "number" }, "fuzziness_score": { "type": "number" }, "monitoring": { "type": "boolean" }, "categories_filter": { "type": "array", "items": { "type": "string" } }, "search_profile": { "type": "string", "nullable": true } } } } }, "QuestionType": { "type": "string", "enum": [ "SINGLE_CHOICE", "MULTIPLE_CHOICE", "BOOLEAN", "TEXT", "FILE", "EMAIL", "PHONE_NUMBER", "SINGLE_SELECT", "MULTIPLE_SELECT", "DATE", "PARAGRAPH", "URL" ] }, "CreateBusinessProfileAdditionalInformation": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBusinessProfileAdditionalInfoItem" }, "description": "- For each item in this list:\n - If `additional_info_type` is a `File/Document`, then `additional_info_data` MUST be an object and MUST contain a required property `file_data`. Some specific file types \n may also require additional properties.\n - Otherwise, `additional_info_data` MAY be a string.\n" }, "CreateBusinessProfileAdditionalInfoItem": { "type": "object", "properties": { "additional_info_type": { "$ref": "#/components/schemas/BusinessAdditionalInfoType" }, "additional_info_data": { "oneOf": [ { "type": "string", "description": "Used when additional_info_type is not a File/Document." }, { "type": "object", "required": [ "file_data" ], "properties": { "file_data": { "type": "string", "description": "The file data (base64) associated with this additional info." } } } ] } } }, "FieldEvidence": { "type": "object", "properties": { "reasoning": { "type": "string", "nullable": true }, "confidence": { "type": "string", "nullable": true }, "citations": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "All requests must include the `X-API-KEY` header containing your API Key." } } }, "security": [ { "apiKey": [] } ] } ```