Create Entity

post

https://sandbox-oxygen.fiatrepublic.com/api/v1/events/entities

The endpoint is designed to handle two types of entities: individual and business. This means that when using the API, the user will need to select proper type of entity and provide the appropriate payload information accordingly.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

required

Entity id provided by the Member

type

string

enum

required

Entity type which can be either individual (PERSON) or company (BUSINESS)

Allowed:

externalUpdatedAt

int32

required

Date of the entity's data update

externalCreatedAt

int32

required

Date of entity creation within Member's system

riskRating

string

enum

User risk level provided by the Member

Allowed:

externalStatus

string

Status of the user within Members system, e.g. ACTIVE, BLOCKED, CREATED, OFFBOARDED

externalType

string

Type of the entity within Member's system, e.g. PAYEE, PAYER

metadata

array of strings

Additional data

metadata

string

Email of the Individual Entity / Business

phone

string

Phone number of the Individual Entity / Business including country prefix. e.g. +447788661100

paymentChannelExternalIds

string

Id of the payment channel card or bank account within the Member's system related with the particular entity

firstName

string

Defaults to Individual Entity

FOR INDIVIDUAL: First Name of the Individual Entity.

middleName

string

FOR INDIVIDUAL: Middle Name of the Individual Entity.

lastName

string

FOR INDIVIDUAL: Last Name of the Individual Entity.

address

object

FOR INDIVIDUAL: Home Address of the Individual Entity

birthCountry

string

FOR INDIVIDUAL: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom.

nationality

string

FOR INDIVIDUAL: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom. One of more nationalities can be provided.

dob

date

FOR INDIVIDUAL: Date of birth of the user

pep

boolean

FOR INDIVIDUAL: Confirmation if the individual is Politically Exposed Person (PEP)

companyName

string

FOR BUSINESS: Name of the Business Entity

tradingName

string

FOR BUSINESS: Trading Name of the Business Entity

registrationNumber

string

FOR BUSINESS: Registration number provided within the official registry for the specific jurisdiction

registrationDate

date

FOR BUSINESS: Date of the registration of the company

registeredAddress

object

FOR BUSINESS: Under under which the company has been registered

tradingAddress

object

FOR BUSINESS: Address under which company operates (can be different than registration address)

website

string

FOR BUSINESS: Website of the Business Entity

businessType

string

FOR BUSINESS: Legal form of the Business Entity, e.g: LLC, PLC, SOLETRADER, CHARITY

businessPersons

object

FOR BUSINESS: Contact person within the Business Entity

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400