--- updatedAt: 2025-06-13T00:00:06.000Z agentTools: projectIndex: https://docs.fiatrepublic.com/llms.txt --- # Create Entity 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. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "transaction-monitoring", "version": "1.0" }, "servers": [ { "url": "https://sandbox-oxygen.fiatrepublic.com/api/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/events/entities": { "post": { "summary": "Create Entity", "description": "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.", "operationId": "oxygen-create-entity", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "externalId", "type", "externalUpdatedAt", "externalCreatedAt" ], "properties": { "externalId": { "type": "string", "description": "Entity id provided by the Member" }, "type": { "type": "string", "description": "Entity type which can be either individual (PERSON) or company (BUSINESS)", "enum": [ "PERSON", "BUSINESS" ] }, "externalUpdatedAt": { "type": "integer", "description": "Date of the entity's data update", "format": "int32" }, "externalCreatedAt": { "type": "integer", "description": "Date of entity creation within Member's system", "format": "int32" }, "riskRating": { "type": "string", "description": "User risk level provided by the Member", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "externalStatus": { "type": "string", "description": "Status of the user within Members system, e.g. ACTIVE, BLOCKED, CREATED, OFFBOARDED" }, "externalType": { "type": "string", "description": "Type of the entity within Member's system, e.g. PAYEE, PAYER" }, "metadata": { "type": "array", "description": "Additional data", "items": { "type": "string" } }, "email": { "type": "string", "description": "Email of the Individual Entity / Business" }, "phone": { "type": "string", "description": "Phone number of the Individual Entity / Business including country prefix. e.g. +447788661100" }, "paymentChannelExternalIds": { "type": "string", "description": "Id of the payment channel card or bank account within the Member's system related with the particular entity" }, "firstName": { "type": "string", "description": "FOR INDIVIDUAL: First Name of the Individual Entity.", "default": "Individual Entity" }, "middleName": { "type": "string", "description": "FOR INDIVIDUAL: Middle Name of the Individual Entity." }, "lastName": { "type": "string", "description": "FOR INDIVIDUAL: Last Name of the Individual Entity." }, "address": { "type": "object", "description": "FOR INDIVIDUAL: Home Address of the Individual Entity", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom" } } }, "birthCountry": { "type": "string", "description": "FOR INDIVIDUAL: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom." }, "nationality": { "type": "string", "description": "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": { "type": "string", "description": "FOR INDIVIDUAL: Date of birth of the user", "format": "date" }, "pep": { "type": "boolean", "description": "FOR INDIVIDUAL: Confirmation if the individual is Politically Exposed Person (PEP)" }, "companyName": { "type": "string", "description": "FOR BUSINESS: Name of the Business Entity" }, "tradingName": { "type": "string", "description": "FOR BUSINESS: Trading Name of the Business Entity" }, "registrationNumber": { "type": "string", "description": "FOR BUSINESS: Registration number provided within the official registry for the specific jurisdiction" }, "registrationDate": { "type": "string", "description": "FOR BUSINESS: Date of the registration of the company", "format": "date" }, "registeredAddress": { "type": "object", "description": "FOR BUSINESS: Under under which the company has been registered", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom" } } }, "tradingAddress": { "type": "object", "description": "FOR BUSINESS: Address under which company operates (can be different than registration address)", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom" } } }, "website": { "type": "string", "description": "FOR BUSINESS: Website of the Business Entity" }, "businessType": { "type": "string", "description": "FOR BUSINESS: Legal form of the Business Entity, e.g: LLC, PLC, SOLETRADER, CHARITY" }, "businessPersons": { "type": "object", "description": "FOR BUSINESS: Contact person within the Business Entity", "required": [ "firstName", "lastName" ], "properties": { "firstName": { "type": "string", "description": "First Name of the Business Person" }, "middleName": { "type": "string", "description": "Middle Name of the Business Person" }, "lastName": { "type": "string", "description": "Last Name of the Business Person" }, "address": { "type": "object", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom" } } }, "email": { "type": "string", "description": "Email of the Business Person" }, "phone": { "type": "string", "description": "Phone number of the Individual including country prefix. e.g. `+447788661100`" }, "birthCountry": { "type": "string", "description": "Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code e.g. `GB` for United Kingdom" }, "nationality": { "type": "string", "description": "Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code e.g. `GB` for United Kingdom" }, "dob": { "type": "string", "description": "Date of Birth of the Individual in `YYYY-MM-DD` format. e.g. `1975-04-05`", "format": "date" }, "type": { "type": "string" }, "pep": { "type": "boolean" } } } } } } } }, "responses": { "201": { "description": "201", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```