Developer Centre
Platform LoginStatus
  • Getting started
    • Integration types
    • Generating an authentication token
    • Using basic authentication
  • Applicants
    • Creating an applicant
    • Generating a verification link
    • Uploading documents to an applicant
      • Supported Documents and Types
    • Requesting to start the verification process
  • Applicant Results
    • Retrieving applicant verification results
      • Understanding applicant rejection labels
      • Setting up a webhook
    • Downloading verified documents
  • Entities
    • Check types and coverage
    • Creating an entity
    • Generating a verification link
    • Uploading documents to an entity
      • Supported Documents and Types
    • Linking a UBO to an entity
    • Requesting to start the verification process
  • Entity Results
    • Retrieving entity verification results
      • Understanding entity rejection labels
      • Setting up a webhook
    • Retrieving entity ownership structures
    • Retrieving entity questionnaire answers
  • Anti-Money Laundering
    • Retrieving AML results
  • Database Verification
    • Applicants
      • Verifying applicant identity data
    • Entities
      • Verifying entity information
  • Pages
    • Overview
    • Creating a Page
    • Verifying with Pages
  • Domain Names
    • Overview
    • Linking your domain
  • Flow Logic
    • Overview
  • Workspaces
    • Switching Workspaces
  • Modules
Powered by GitBook
On this page

Was this helpful?

Getting started

Welcome, you're moments away from integrating. Let's get started.

NextIntegration types

Last updated 10 months ago

Was this helpful?

We've designed our API to be fast and simple to integrate, allowing you to create applicants and retrieve results easily. We offer no, low and full-code integration options. Head to the next page to select how you'd like to integrate.

When interacting, the API requires parameters to be passed in valid JSON format and responds with a JSON payload. In our examples, we use the Content-Type multipart/form-data, but application/json is also supported.

Host URL:

As we continually improve the platform, from time-to-time we include additional data within endpoint responses. When developing with our API, make sure your platform, service, or code can account for these additions. We will never change endpoint URLs, response structures, or key-value pairs without letting you know in advance.

To get started, you'll need an active or subscribed Personr account.

https://enterprise.personr.co/api/1.1/wf/