Onboard an individual

There are four steps to onboarding an individual with Verify.

Capture the individual’s information
Run the verification
Send the ID&V request
View the verification outcome and onboarding decision

info

Verify supports onboarding of individuals resident in the 🇬🇧 UK, 🇪🇺 European Union, 🇦🇪 United Arab Emirates, 🇭🇰 Hong Kong, 🇦🇺 Australia, 🇸🇬 Singapore, 🇺🇸 United States of America, and 🇲🇾 Malaysia.

See here for details on claim requirements for addresses outside the UK.

1. Capture the individual’s information

You will need the following information about the individual:

Information	Claim
Full name	`individual-identity`
Date of birth	`individual-identity`
Email address	`contact-details`
Address	`individual-residence`
Phone number	`mobile-number`
Nationality	`nationality`
Tax residency/ies	`tax-residencies`
US citizen confirmation	`us-citizen`
Tax identifier number/s	`tax-identification-numbers-by-country`
Employment status, occupation, and industry	`employment`
Annual income	`individual-income`
↓ Use of account ↓	↓ Use of account ↓
Purpose(s) of account	`individual-purposes-of-account`
Source(s) of funds	`individual-sources-of-funds`
Initial deposit value	`initial-deposit`
International payment locations	`international-payments-countries`
Cash payments	`cash-payments`

In the API, your customer is represented as a legal person, and each of the data points above represent one claim about them. Create an individual legal person to represent the customer and then add claims about them, as shown below.

curl "https://api.griffin.com/v0/organizations/${ORGANIZATION_ID}/legal-persons" \
  -H "Authorization: GriffinAPIKey$GRIFFIN_API_KEY" \
  -H 'Content-Type: application/json' \
  -d \
'{
  "display-name": "DAVIS, Henry",
  "legal-person-type": "individual",
  "claims": [
    {
      "claim-type": "individual-identity",
      "given-name": "Henry",
      "surname": "Davis",
      "date-of-birth": "1991-05-10"
    },
    {
      "claim-type": "contact-details",
      "email-address": "henrydavis@example.com"
    },
    {
      "claim-type": "individual-residence",
      "street-name": "Example Street",
      "city": "Test Town",
      "postal-code": "TE1 2ST",
      "country-code": "GB",
      "building-number": "19"
    },
    {
      "claim-type": "mobile-number",
      "mobile-number": "+442012345678"
    },
    {
      "claim-type": "employment",
      "employment-status": "employed",
      "occupation": "construction-worker",
      "industry-of-occupation": "property-and-construction"
    },
    {
      "claim-type": "individual-income",
      "income": {
        "value": "85000.00",
        "currency": "GBP"
      }
    },
    {
      "claim-type": "nationality",
      "nationality": "GB"
    },
    {
      "claim-type": "tax-residencies",
      "tax-residencies": [
        "GB",
        "US"
      ]
    },
    {
      "claim-type": "tax-identification-numbers-by-country",
      "tins-by-country": {
        "GB": [
          "1234 5678 901"
        ],
        "US": [
          "123-45-6789",
          "12-3456789"
        ]
      }
    },
    {
      "claim-type": "us-citizen",
      "us-citizen?": false
    },
    {
      "claim-type": "individual-purposes-of-account",
      "individual-purposes-of-account": ["everyday-spending"]
    },
    {
      "claim-type": "individual-sources-of-funds",
      "individual-sources-of-funds": ["savings"]
    },
    {
      "claim-type": "cash-payments",
      "cash-payments?": false
    },
    {
      "claim-type": "initial-deposit",
      "initial-deposit": {
        "currency": "GBP",
        "value": "100.00"
      }
    },
    {
      "claim-type": "international-payments-countries",
      "international-payments-countries": ["FR"]
    }
  ]
}'

A successful response will display the URL for the newly created legal person (e.g./v0/legal-persons/lp.njk7tIWvQJGPEFIdDmS9yQ) in the response's Location header and in the response body. Save this URL for the next step.

info

In this example, you create the legal person and their claims in one go, but you can also create a legal person first and then add claims individually. For more detail on claims, see the API reference.

1.2 Landlords

If the individual you are onboarding is a landlord, you will need to include the following information, in addition to the claims listed above.

Information	Claim
Number of properties owned	`managed-properties`
What funds the landlord intends to receive into the account	`properties-origins-of-deposits`
HMO verification	`hmo-verification`
Whether the properties owned are residential, commercial, holiday lets, or HMO	`property-types`
If they own commercial properties, what industries	`commercial-property-industries`

2. Run the verification

2.1 Retrieve your workflows

If your onboarding a customer for the first time you will need to retrieve your [workflows] in order to submit the verification. Retrieve and cache your workflow IDs.

curl "https://api.griffin.com/v0/organizations/${ORGANIZATION_ID}/workflows" -H "Authorization: GriffinAPIKey $GRIFFIN_API_KEY"

Example response:

{
  "workflows": [
    {
      "workflow-url": "/v0/workflows/wf.Ul-1r4gRWfOFxHJsHWghcA",
      "display-name": "Individual - Account Owners",
      "legal-person-type": "individual"
    },
  ]
}

tip

In your implementation, store these workflow IDs and match them to the appropriate customer type. For example, use the "Individual - Account Owners" workflow when onboarding individuals.

2.2 Submit

Submit the individual legal person for verification, as shown below.

curl 'https://api.griffin.com/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45/verifications' \
  -X 'POST'
  -H "Authorization: GriffinAPIKey$GRIFFIN_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"workflow-url": "/v0/workflows/wf.Ul-1r4gRWfOFxHJsHWghcA"}'

A successful response will look like this. Grab the verification-url for monitoring later.

{
  "created-at": "2022-08-15T10:47:51.959Z",
  "display-name": "DAVIS, Henry",
  "legal-person-type": "individual",
  "legal-person-url": "/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45",
  "updated-at": "2022-08-15T10:47:51.959Z", 
  "verification-status": "pending",
  "verification-url": "/v0/verifications/vn.BhpS_dCqFKRYXa8d457fgA",
  "workflow-url": "/v0/workflows/wf.W1NwgL6sXCmB3u9cPiJoKQ"
}

3. Send ID&V request

info

In sandbox, no selfies or ID photos are captured and all ID&V results are mock-ups. Learn more about sandbox vs. live mode.

The individual will need to complete an identity and verification (ID&V) check before the verification can be completed. This involves submitting a selfie and a photo of a valid identity document to Veriff, our ID&V partner.

Get the ID&V link from idv-check-url within /verifications/<:verification-id>/resources, as shown below. You will need to share this with your customer so they can complete ID&V.

To find out the ID&V links, you can poll the verification-resources-urluntil they become available. You can also leverage webhooks and listen for the verification-resource-created|updated events, emitted once the ID&V links are available.

{
  "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
  "legal-person-url": "/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45",
  "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  "verification-resources": [
    {
      "verification-resource-type": "idv-check",
      "verification-resource-id": "a87ef592-c300-43f2-84f9-005120592392",
      "idv-check-status": "pending",
      "idv-check-url": "IDV.check.url",
      "idv-check-expires-at": "2024-02-16",
      "display-name": "string",
      "legal-person-url": "/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45"
    },
  ],
  "links": {
    "prev": "string",
    "next": "string"
  }
}

The idv-check-status begins in a pending state and transitions to one of three final states: complete, errored, or expired.

Embedding the ID&V flow in your web/mobile app

For a better user experience, you can embed Veriff's ID&V flow directly within your application instead of redirecting users to an external page. Veriff provides SDKs for web, iOS, and Android that accept the session URL (the idv-check-url generated above) and render the verification flow natively in your app.

For detailed integration instructions, code examples, and platform-specific guidance, see Veriff's SDK documentation.

4. View the verification outcome and onboarding decision

Verification Status

The verification has successfully completed when verification-status reaches checks-complete. You can track this by:

Polling the verification-url
Listening for verification-updated webhook events

Example response:

{
  "created-at": "2024-02-11T10:47:51.959Z",
  "display-name": "DAVIS, Henry",
  "legal-person-type": "individual",
  "legal-person-url": "/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45",
  "risk-rating": "low-risk",
  "updated-at": "2022-08-15T10:48:03.215Z",
  "verification-status": "checks-complete",
  "verification-url": "/v0/verifications/vn.BhpS_dCqFKRYXa8d457fgA",
  "workflow-url": "/v0/workflows/wf.G3yYmojQV32I814_5JLTEQ"
}

Verification Statuses Explained

Status	Description
`pending`	Verification has been created but processing has not yet begun
`in-progress`	Verification checks are actively being performed
`failed`	An internal system error has occurred during verification
`checks-declined`	Verification was terminated early due to failing one or more workflow checks
`checks-complete`	Verification has successfully completed all required checks

Verification Status Flow

Decision Process

After reaching checks-complete, the system will either:

Generate an automated decision
Refer the application for manual review (followed by a manual decision)

Tracking Decisions

Monitor decisions by:

Polling the legal-person-decisions-url endpoint
Listening for decision-created webhook events

Application Status & Decision Flow

In context

Both the verification status and the decisions can be seen in context on the legal person entity.

curl 'https://api.griffin.com/v0/legal-persons/lp.Kfd8_BhpSdCqFKRYXa8d45' -H "Authorization: GriffinAPIKey $GRIFFIN_API_KEY"

The response will include application-status and also the latest-decision when one exists, as shown below:

{
  "latest-decision":
  {
    "verification-url": "/v0/verifications/vn.BhpS_dCqFKRYXa8d457fgA",
    "decision-outcome": "accepted",
    "decision-maker": "user",
    "decision-notes": "No red flags here",
    "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
    "created-at": "2024-08-11T10:47:51.959Z"
  },
  "display-name": "DAVIS, Henry",
  "application-status": "accepted",
  "status-changed-at": "2024-02-11T10:47:51.959Z",
  "created-at": "2024-02-10T10:47:51.959Z",
  ...
}

Once you have an accepted decision, you're good to go 🎉

What's next? Open an account! See here to get started.

Onboarding international individuals

When onboarding individuals outside the UK, the claim requirements for addresses are different.

See this example for an imaginary French address:

{
  "claim-type": "individual-residence",
  "address-line-1": "4 Rue Paul Cabet",
  "address-line-2": "Appartement 5",
  "city": "Dijon",
  "state": "Côte-d'Or",
  "postal-code": "21000",
  "country-code": "FR"
}

Required:

claim-type
address-line-1
city
postal-code
country-code

Optional:

address-line-2
state

1. Capture the individual’s information​

1.2 Landlords​

2. Run the verification​

2.1 Retrieve your workflows​

2.2 Submit​

3. Send ID&V request​

Embedding the ID&V flow in your web/mobile app​

4. View the verification outcome and onboarding decision​

Verification Status​

Verification Statuses Explained​

Verification Status Flow​

Decision Process​

Tracking Decisions​

Application Status & Decision Flow​

In context​

Onboarding international individuals​

1. Capture the individual’s information

1.2 Landlords

2. Run the verification

2.1 Retrieve your workflows

2.2 Submit

3. Send ID&V request

Embedding the ID&V flow in your web/mobile app

4. View the verification outcome and onboarding decision

Verification Status

Verification Statuses Explained

Verification Status Flow

Decision Process

Tracking Decisions

Application Status & Decision Flow

In context

Onboarding international individuals