Create the Identity Profile

First action is to create the identity profile in the system. So a POST call is made to the endpoint with the following payload:

{
  "id": "43971e26-61b1-420b-9add-c510d44a354f",
  "compliance_profile_id": "43971e26-61b1-420b-9add-c510d44a354f",
  "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
  "type": "PERSON",
  "person": {
    "id": "43971e26-61b1-420b-9add-c510d44a354f",
    "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
    "date_of_birth": "1970-12-31T00:00:00.000Z",
    "details": {
      "id": "43971e26-61b1-420b-9add-c510d44a354f",
      "title": "PROF",
      "surname": "Example-Surname",
      "firstname": "ExampleFirstname",
      "other_names": "Example-OtherNames",
      "gender": "FEMALE",
      "married": "YES",
      "dates": {
        "date_to": "1970-12-31T00:00:00.000Z",
        "date_from": "1970-12-31T00:00:00.000Z"
      },
      "status": "CURRENT"
    },
    "fatca": true,
    "aliases": [
      {
        "id": "43971e26-61b1-420b-9add-c510d44a354f",
        "title": "PROF",
        "surname": "Example-Surname",
        "firstname": "ExampleFirstname",
        "other_names": "Example-OtherNames",
        "gender": "FEMALE",
        "married": "YES",
        "dates": {
          "date_to": "1970-12-31T00:00:00.000Z",
          "date_from": "1970-12-31T00:00:00.000Z"
        },
        "status": "CURRENT"
      }
    ],
    "identity_references": [
      {
        "id": "43971e26-61b1-420b-9add-c510d44a354f",
        "country": {
          "country": "England",
          "code": "GB"
        },
        "dates": {
          "date_to": "1970-12-31T00:00:00.000Z",
          "date_from": "1970-12-31T00:00:00.000Z"
        },
        "status": "CURRENT",
        "document_type": "PASSPORT",
        "reference_of_document": "AB123456C"
      }
    ],
    "nationality": [
      {
        "id": "43971e26-61b1-420b-9add-c510d44a354f",
        "country": {
          "country": "England",
          "code": "GB"
        },
        "dates": {
          "date_to": "1970-12-31T00:00:00.000Z",
          "date_from": "1970-12-31T00:00:00.000Z"
        },
        "status": "CURRENT"
      }
    ],
    "residency": [
      {
        "id": "43971e26-61b1-420b-9add-c510d44a354f",
        "country": {
          "country": "England",
          "code": "GB"
        },
        "dates": {
          "date_to": "1970-12-31T00:00:00.000Z",
          "date_from": "1970-12-31T00:00:00.000Z"
        },
        "status": "CURRENT"
      }
    ],
    "audit_dates": {
      "created": "2020-01-22T13:15:30Z",
      "updated": "2020-01-22T13:15:30Z"
    }
  },
  "organisation": {
    "id": "43971e26-61b1-420b-9add-c510d44a354f",
    "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
    "company_name": "ExampleCompany",
    "company_number": [
      {
        "type": "COMPANY_HOUSE",
        "value": "12345678",
        "country_of_number": {
          "country": "England",
          "code": "GB"
        },
        "dates": {
          "date_to": "1970-12-31T00:00:00.000Z",
          "date_from": "1970-12-31T00:00:00.000Z"
        }
      }
    ],
    "type_of_organisation": "LIMITED_COMPANY",
    "fatca": true
  },
  "addresses": [
    {
      "id": "43971e26-61b1-420b-9add-c510d44a354f",
      "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
      "full_address": "123 Example House, Example Road, Example Town, UK",
      "address_line_1": "123 Example House",
      "address_line_2": "Example Road",
      "address_line_3": "Example Hamlet",
      "address_line_4": "Example Village",
      "town": "Example Town",
      "state": "Middlesex",
      "postcode": "EX1 1EG",
      "country": {
        "country": "England",
        "code": "GB"
      },
      "type": "REGISTERED_OFFICE",
      "status": "CURRENT",
      "dates": {
        "date_to": "1970-12-31T00:00:00.000Z",
        "date_from": "1970-12-31T00:00:00.000Z"
      }
    }
  ],
  "telephone": [
    {
      "id": "43971e26-61b1-420b-9add-c510d44a354f",
      "valid": true,
      "primary": true,
      "confirmed": true,
      "details_confirmed_by": "CLIENT",
      "routing_type": "MOBILE",
      "number_type": "REGISTERED_OFFICE",
      "number": [
        {
          "tel_type": "LOCAL",
          "tel_number": "07117 754764"
        }
      ],
      "country": {
        "country": "England",
        "code": "GB"
      }
    }
  ],
  "email": [
    {
      "id": "43971e26-61b1-420b-9add-c510d44a354f",
      "valid": true,
      "primary": true,
      "confirmed": true,
      "details_confirmed_by": "CLIENT",
      "email_type": "REGISTERED_OFFICE",
      "email": "[email protected]"
    }
  ],
  "ubo": [
    {
      "id": "43971e26-61b1-420b-9add-c510d44a354f",
      "ubo_identity_id": "43971e26-61b1-420b-9add-c510d44a354f",
      "ubo_type": "DIRECTOR",
      "dates": {
        "date_to": "1970-12-31T00:00:00.000Z",
        "date_from": "1970-12-31T00:00:00.000Z"
      },
      "audit_dates": {
        "created": "2020-01-22T13:15:30Z",
        "updated": "2020-01-22T13:15:30Z"
      }
    }
  ],
  "terms_of_service": {
    "tos_accepted_date": "1970-12-31T00:00:00.000Z",
    "tos_accepted": true
  },
  "compliance": {
    "screened": "CLIENT",
    "risk_rated": "CLIENT"
  },
  "audit_dates": {
    "created": "2020-01-22T13:15:30Z",
    "updated": "2020-01-22T13:15:30Z"
  }
}

An identity could be created for either an organisation or a person (by changing the type PERSON/ORGANISATION) and depending on your needs, you need to populate the relevant part of the JSON payload.

Language
Click Try It! to start a request and see the response here!