{"version":1,"pages":[{"id":"Qe2ItbJKjfg79BmI0vGr","title":"Getting started","pathname":"/api-documentation","siteSpaceId":"sitesp_2TrQx","description":"Welcome, you're moments away from integrating. Let's get started."},{"id":"unIdO9lQhKNJyMevQqcQ","title":"Integration types","pathname":"/api-documentation/getting-started/integration-types","siteSpaceId":"sitesp_2TrQx","description":"We've conveniently packaged our API into no, low and full-code options for easy integration.","breadcrumbs":[{"label":"Getting started"}]},{"id":"CDljPChmPQWf8whsclRp","title":"Generating an authentication token","pathname":"/api-documentation/getting-started/generating-an-authentication-token","siteSpaceId":"sitesp_2TrQx","description":"Let's start by generating an Authorization Bearer token to use with subsequent endpoints.","breadcrumbs":[{"label":"Getting started"}]},{"id":"hWcUW1O4y7EZ28k724cm","title":"Using basic authentication","pathname":"/api-documentation/getting-started/using-basic-authentication","siteSpaceId":"sitesp_2TrQx","description":"Instead of sending account details as body parameters, you can use basic authentication to generate a bearer token instead.","breadcrumbs":[{"label":"Getting started"}]},{"id":"rfgZCXe0PIBgYtO9OMMm","title":"Creating an applicant","pathname":"/api-documentation/applicants/creating-an-applicant","siteSpaceId":"sitesp_2TrQx","description":"Let's create an applicant, ready to be verified.","breadcrumbs":[{"label":"Applicants"}]},{"id":"QH0QcdY2afvCUXptc8k7","title":"Generating a verification link","pathname":"/api-documentation/applicants/generating-a-verification-link","siteSpaceId":"sitesp_2TrQx","description":"Once you've created an applicant, you can generate a hosted link for verification.","breadcrumbs":[{"label":"Applicants"}]},{"id":"mAxpqj0bctlM6zIvpVyC","title":"Uploading documents to an applicant","pathname":"/api-documentation/applicants/uploading-documents-to-an-applicant","siteSpaceId":"sitesp_2TrQx","description":"Instead of using a verification link, use this endpoint to upload document images directly via API.","breadcrumbs":[{"label":"Applicants"}]},{"id":"6KlOtMnjqOrc12Il2PJM","title":"Supported Documents and Types","pathname":"/api-documentation/applicants/uploading-documents-to-an-applicant/supported-documents-and-types","siteSpaceId":"sitesp_2TrQx","description":"A list of supported documents, and their subtypes.","breadcrumbs":[{"label":"Applicants"},{"label":"Uploading documents to an applicant"}]},{"id":"qDaID3rJm9lQl3S4MowC","title":"Requesting to start the verification process","pathname":"/api-documentation/applicants/requesting-to-start-the-verification-process","siteSpaceId":"sitesp_2TrQx","description":"Once you've uploaded all required documents to an applicant, you can request to start the verification.","breadcrumbs":[{"label":"Applicants"}]},{"id":"q3S7G8Kd0k92XdbfPGMF","title":"Retrieving applicant verification results","pathname":"/api-documentation/applicant-results/retrieving-applicant-verification-results","siteSpaceId":"sitesp_2TrQx","description":"When an applicant has finished processing, you can retrieve the verification results.","breadcrumbs":[{"label":"Applicant Results"}]},{"id":"qHgbipdHctPhfYMoVPAE","title":"Understanding applicant rejection labels","pathname":"/api-documentation/applicant-results/retrieving-applicant-verification-results/understanding-applicant-rejection-labels","siteSpaceId":"sitesp_2TrQx","description":"Reject labels are used to explain why an applicant has been rejected.","breadcrumbs":[{"label":"Applicant Results"},{"label":"Retrieving applicant verification results"}]},{"id":"czxhT5lQYRxvq3B2mBEe","title":"Setting up a webhook","pathname":"/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook","siteSpaceId":"sitesp_2TrQx","description":"Instead of retrieving verification results, you can use a webhook that sends results automatically.","breadcrumbs":[{"label":"Applicant Results"},{"label":"Retrieving applicant verification results"}]},{"id":"BbModCQ5R3OFrlRioAHS","title":"Supported Documents","pathname":"/api-documentation/applicant-results/supported-documents","siteSpaceId":"sitesp_2TrQx","description":"This page covers all documents internationally that are supported for ID and Proof of Address Checks","breadcrumbs":[{"label":"Applicant Results"}]},{"id":"ZGnFjIzgEjAvMSB3n65i","title":"Downloading verified documents","pathname":"/api-documentation/applicant-results/downloading-verified-documents","siteSpaceId":"sitesp_2TrQx","description":"When an applicant has been verified, you can download and retrieve the document images.","breadcrumbs":[{"label":"Applicant Results"}]},{"id":"0muUWgFWNclpMNBX4CMW","title":"Downloading verified documents with information","pathname":"/api-documentation/applicant-results/downloading-verified-documents-with-information","siteSpaceId":"sitesp_2TrQx","description":"When an applicant has been verified, you can download and retrieve the document images.","breadcrumbs":[{"label":"Applicant Results"}]},{"id":"ZrBXOjJlomPVFdYQOIGK","title":"Check types and coverage","pathname":"/api-documentation/entities/check-types-and-coverage","siteSpaceId":"sitesp_2TrQx","description":"When verifying an entity, you can perform a registry check and opt-in to automatically identify ownership, where available.","breadcrumbs":[{"label":"Entities"}]},{"id":"FobYZJfH9yUKTK0TR1oM","title":"Company Search","pathname":"/api-documentation/entities/company-search","siteSpaceId":"sitesp_2TrQx","description":"Before creating an Entity, you can perform a lookup search to fill more details for a more accurate check","breadcrumbs":[{"label":"Entities"}]},{"id":"By4o4dQVXX7e7o10FiuM","title":"Creating an entity","pathname":"/api-documentation/entities/creating-an-entity","siteSpaceId":"sitesp_2TrQx","description":"Let's create an entity, ready to be verified.","breadcrumbs":[{"label":"Entities"}]},{"id":"6uSe0YLX7TkX3ubcBugJ","title":"Generating a verification link","pathname":"/api-documentation/entities/generating-a-verification-link","siteSpaceId":"sitesp_2TrQx","description":"Once you've created an entity, you can generate a hosted link for verification.","breadcrumbs":[{"label":"Entities"}]},{"id":"u4C7DdwXphvABFY0vCG0","title":"Uploading documents to an entity","pathname":"/api-documentation/entities/uploading-documents-to-an-entity","siteSpaceId":"sitesp_2TrQx","description":"Instead of using a verification link, use this endpoint to upload documents directly via API.","breadcrumbs":[{"label":"Entities"}]},{"id":"dEFHNFws033AuOWbyp8M","title":"Uploading encoded documents to an entity","pathname":"/api-documentation/entities/uploading-documents-to-an-entity/uploading-encoded-documents-to-an-entity","siteSpaceId":"sitesp_2TrQx","description":"Instead of using a verification link, use this endpoint to upload documents directly via API.","breadcrumbs":[{"label":"Entities"},{"label":"Uploading documents to an entity"}]},{"id":"2D9PiOwYXtdqBt1SfcaL","title":"Supported Documents and Types","pathname":"/api-documentation/entities/uploading-documents-to-an-entity/supported-documents-and-types","siteSpaceId":"sitesp_2TrQx","description":"A list of supported documents, and their subtypes.","breadcrumbs":[{"label":"Entities"},{"label":"Uploading documents to an entity"}]},{"id":"DKpdcexFFnFQ11j25WFo","title":"Linking a UBO to an entity","pathname":"/api-documentation/entities/linking-a-ubo-to-an-entity","siteSpaceId":"sitesp_2TrQx","description":"Optionally, you can link existing applicants or entities to another entity as a UBO","breadcrumbs":[{"label":"Entities"}]},{"id":"aNVrD7IZ2LmENznxNEf7","title":"Requesting to start the verification process","pathname":"/api-documentation/entities/requesting-to-start-the-verification-process","siteSpaceId":"sitesp_2TrQx","description":"Once you've uploaded all required documents to an entity, you can request to start the verification.","breadcrumbs":[{"label":"Entities"}]},{"id":"CJD4KJi2thn4ytczUHcf","title":"Retrieving entity verification results","pathname":"/api-documentation/entity-results/retrieving-entity-verification-results","siteSpaceId":"sitesp_2TrQx","description":"When an entity has finished processing, you can retrieve the verification results.","breadcrumbs":[{"label":"Entity Results"}]},{"id":"kG2D6tiKCnFq8RajK3tL","title":"Understanding entity rejection labels","pathname":"/api-documentation/entity-results/retrieving-entity-verification-results/understanding-entity-rejection-labels","siteSpaceId":"sitesp_2TrQx","description":"Reject labels are used to explain why an applicant has been rejected.","breadcrumbs":[{"label":"Entity Results"},{"label":"Retrieving entity verification results"}]},{"id":"bIadBQFWxAW1XONtMLZH","title":"Setting up a webhook","pathname":"/api-documentation/entity-results/retrieving-entity-verification-results/setting-up-a-webhook","siteSpaceId":"sitesp_2TrQx","description":"Instead of retrieving verification results, you can use a webhook that sends results automatically.","breadcrumbs":[{"label":"Entity Results"},{"label":"Retrieving entity verification results"}]},{"id":"2JLnuMzwdrHRrGrKYPFD","title":"Retrieving entity ownership structures","pathname":"/api-documentation/entity-results/retrieving-entity-ownership-structures","siteSpaceId":"sitesp_2TrQx","description":"Once a verification has processed, you can retrieve the entity's ownership structure.","breadcrumbs":[{"label":"Entity Results"}]},{"id":"BqG42z0o3ae1QA3A7UqF","title":"Retrieving entity questionnaire answers","pathname":"/api-documentation/entity-results/retrieving-entity-questionnaire-answers","siteSpaceId":"sitesp_2TrQx","description":"When an entity has finished processing, you can retrieve the answers from the questionnaire, product, and plan selection logic blocks.","breadcrumbs":[{"label":"Entity Results"}]},{"id":"g55eAXqWVFwYVS2Mnecq","title":"Retrieving AML results","pathname":"/api-documentation/anti-money-laundering/retrieving-aml-results","siteSpaceId":"sitesp_2TrQx","description":"Once an applicant or entity's verification has processed, you can retrieve more details about any flags or entries we've found during the check.","breadcrumbs":[{"label":"Anti-Money Laundering"}]},{"id":"uPG100Ml2Bi9a1IN24RC","title":"Applicants","pathname":"/api-documentation/database-verification/applicants","siteSpaceId":"sitesp_2TrQx","description":"Verify applicant identity data against government and commercial databases around the world.","breadcrumbs":[{"label":"Database Verification"}]},{"id":"sFy8umK8HO4typKqhq7R","title":"Verifying applicant identity data","pathname":"/api-documentation/database-verification/applicants/verifying-applicant-identity-data","siteSpaceId":"sitesp_2TrQx","description":"Verify identity data against government and commercial data sources.","breadcrumbs":[{"label":"Database Verification"},{"label":"Applicants"}]},{"id":"iUk4gg2DX4RHbJKHjDLD","title":"Entities","pathname":"/api-documentation/database-verification/entities","siteSpaceId":"sitesp_2TrQx","description":"Verify entity or company data against registries and commercial data sources.","breadcrumbs":[{"label":"Database Verification"}]},{"id":"rGjTsJXoJaRtiq3shDTg","title":"Verifying entity information","pathname":"/api-documentation/database-verification/entities/verifying-entity-information","siteSpaceId":"sitesp_2TrQx","description":"Verify entity, or company, data against registries and commercial data sources.","breadcrumbs":[{"label":"Database Verification"},{"label":"Entities"}]},{"id":"OKkPgYTeIZ6R26pNbUQm","title":"Overview","pathname":"/api-documentation/pages/overview","siteSpaceId":"sitesp_2TrQx","description":"Pages — an easier way to onboard clients.","breadcrumbs":[{"label":"Pages"}]},{"id":"iFnurhU0KB5OfXTA22ar","title":"Creating a Page","pathname":"/api-documentation/pages/creating-a-page","siteSpaceId":"sitesp_2TrQx","description":"Create and customise your page in minutes, and share - or embed - the same link to onboard clients.","breadcrumbs":[{"label":"Pages"}]},{"id":"mZELj5uMdkhdZYHPN7rD","title":"Verifying with Pages","pathname":"/api-documentation/pages/verifying-with-pages","siteSpaceId":"sitesp_2TrQx","description":"Pages verifies your clients automatically, no additional API calls or links needed.","breadcrumbs":[{"label":"Pages"}]},{"id":"lK4ZlIGeFKOSKhRUyeu7","title":"Overview","pathname":"/api-documentation/domain-names/overview","siteSpaceId":"sitesp_2TrQx","description":"Link your domain and display branded verification links, or Pages, to your clients.","breadcrumbs":[{"label":"Domain Names"}]},{"id":"lt49l2KOBLvIB68b5XRc","title":"Linking your domain","pathname":"/api-documentation/domain-names/linking-your-domain","siteSpaceId":"sitesp_2TrQx","description":"Linking your domain to the platform is easy, and only takes a few minutes.","breadcrumbs":[{"label":"Domain Names"}]},{"id":"JgCSbIrZJhvvo3476Nej","title":"Overview","pathname":"/api-documentation/flow-logic/overview","siteSpaceId":"sitesp_2TrQx","description":"Flow Logic — a dynamic onboarding experience.","breadcrumbs":[{"label":"Flow Logic"}]},{"id":"wNaXa9NNRhTuLMyhVujk","title":"Switching Workspaces","pathname":"/api-documentation/workspaces/switching-workspaces","siteSpaceId":"sitesp_2TrQx","description":"Easily switch your user account between workspaces.","breadcrumbs":[{"label":"Workspaces"}]}]}