--- updatedAt: 2025-06-12T23:57:44.000Z agentTools: projectIndex: https://docs.fiatrepublic.com/llms.txt --- # Update Business End User # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "fiat-republic", "version": "1.0" }, "servers": [ { "url": "https://sandbox.fiatrepublic.com/api/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/end-users/businesses/{id}": { "patch": { "summary": "Update Business End User", "description": "", "operationId": "update-business-end-user", "parameters": [ { "name": "id", "in": "path", "description": "ID of Business End User that needs to be updated", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "business": { "type": "object", "properties": { "companyName": { "type": "string" }, "tradingName": { "type": "string" }, "type": { "type": "string", "enum": [ "LIMITED" ] }, "registrationNumber": { "type": "string" }, "registrationDate": { "type": "string", "format": "date" }, "registeredAddress": { "type": "object", "required": [ "line 1", "city", "postal code", "country" ], "properties": { "line 1": { "type": "string", "description": "First line of the company registration address" }, "line 2": { "type": "string", "description": "Second line of the company registration address" }, "city": { "type": "string", "description": "City of the registration address" }, "state": { "type": "string", "description": "Required for USD" }, "postal code": { "type": "string", "description": "Postal code of the registration address" }, "country": { "type": "string", "description": "Country code of the registration address" } } }, "tradingAddress": { "type": "object", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string", "description": "First line of the company trading address" }, "line2": { "type": "string", "description": "Second line of the company trading address" }, "city": { "type": "string", "description": "City of the trading address" }, "state": { "type": "string", "description": "State or region of the trading address" }, "postalCode": { "type": "string", "description": "Postal code of the trading address" }, "country": { "type": "string", "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom" } } }, "website": { "type": "string" } } }, "businessPersons": { "type": "object", "properties": { "person": { "type": "object", "required": [ "dob", "email", "firstName", "lastName" ], "properties": { "address": { "type": "object", "description": "Home Address of the Individual. Is required", "required": [ "line1", "city", "postalCode", "country" ], "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "Required for USD Payees" }, "postalCode": { "type": "string" }, "country": { "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" } } }, "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" }, "dob": { "type": "string", "description": "Date of Birth of the Individual in `YYYY-MM-DD` format. e.g. `1975-04-05`", "format": "date" }, "email": { "type": "string", "description": "Email of the Individual." }, "firstName": { "type": "string", "description": "First Name of the Individual." }, "middleName": { "type": "string", "description": "Middle Name(s) of the Individual." }, "lastName": { "type": "string", "description": "Last Name of the Individual." }, "nationality": { "type": "array", "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. One of more nationalities can be provided. Required for USD.", "items": { "type": "string" } }, "phone": { "type": "string", "description": "Phone number of the Individual including country prefix. e.g. `+447788661100` Required for USD" }, "identificationDocument": { "type": "object", "description": "Required for USD", "properties": { "number": { "type": "string" }, "type": { "type": "string", "description": "Type of identity document", "enum": [ "WORK_PERMIT", "PASSPORT", "NATIONAL_ID", "DRIVERS_LICENCE" ] } } } } }, "types": { "type": "array", "description": "Type of the Business Person. Can be CONTACT, DIRECTOR or UBO. Multiple choice field", "items": { "type": "string" } }, "ownership": { "type": "number", "description": "Amount of shares hold by the Business Person (in %)", "format": "float" } } }, "ipAddress": { "type": "string", "description": "The IP address from where the individual signed up on your platform." }, "linkedCryptoWallets": { "type": "string", "description": "Details of any known crypto wallets linked with the individual being created." }, "tags": { "type": "string", "description": "Tags allowing you to provide additional risk-related information for the business." }, "riskRating": { "type": "string", "description": "Rating of the risk level assigned to the business", "enum": [ "\"LOW\"", "\"MEDIUM\"", "\"HIGH\"" ] }, "metadata": { "type": "array", "items": { "type": "string" } }, "signupAt": { "type": "integer", "description": "A date of registration of End User profile within Member platform", "format": "int32" }, "status": { "type": "string", "enum": [ "ACTIVE", "SUSPENDED", "CLOSED" ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"INVALID_REQUEST_DATA\",\n \"message\": \"Invalid IndividualEndUserUpdateRequest.\",\n \"warnings\": [\n {\n \"position\": \"person.dob\",\n \"issue\": \"Text '1997-01-0' could not be parsed at index 8\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "INVALID_REQUEST_DATA" }, "message": { "type": "string", "example": "Invalid IndividualEndUserUpdateRequest." }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "string", "example": "person.dob" }, "issue": { "type": "string", "example": "Text '1997-01-0' could not be parsed at index 8" } } } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"RESOURCE_MISSING\",\n \"message\": \"IndividualEndUser with 'eus_xxxxyyyyzzzz' id does not exist.\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "RESOURCE_MISSING" }, "message": { "type": "string", "example": "IndividualEndUser with 'eus_xxxxyyyyzzzz' id does not exist." } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```