API Terminology | API

Entity

An entity is the individual you are seeking to verify. Depending on your use case this could be a new customer, candidate etc.

Entities are assigned a unique entityId and are often referred to as individuals within the Credas portal.

Journey

A journey defines the sequence of steps (process flow) that an Entity will be guided through, and the checks that will be performed.  For example 'Identity | Address | International Screening'.

Each journey has a unique journeyId that is used via the API.

Actor

An actor is used by Credas to determine the role of the individual within a Journey.  For example 'Applicant' or 'House Buyer'.

Each actor has a unique actorId that is used via the API. 

Process

A Process is used to invite an Entity to complete a Journey.  Depending on your use case a Process could be used to invite an entity to complete a Right to work check, Safe harbour check and so forth.

Processes are assigned a unique processId. 

When creating a process via the API you must include a JourneyId & ActorId. You must also either provide basic information to create an entity or an existing EntityId to use.

An Entity can have multiple Processes attached to it.

Datacheck

Certain services can be performed as a Datacheck where we use data (e.g. Forename, Surname, Address) to verify against a dataset.

Examples of Datachecks include Address & Mortality, International Screening, Bank Account Verification etc. Datachecks can be performed as part of a journey (asynchronous) or via a specific Datacheck endpoint (synchronous). Each Datacheck you perform is assigned a unique datacheckId.

Invite

Invites are issued to Entities (individuals) as part of a Process.  Invites can be issued via email and/or SMS. Depending on your setup the invites that we issue may be custom or Credas branded. 

Native

We use the term native to refer to both our native iOS and Android mobile apps.

Magic links

Magic links are short life URL’s that can be generated via the Credas API.