--- title: Create an entity slug: monoova-onboarding-api/create-an-entity docTags: createdAt: 2026-08-12T06:04:58.890Z --- { "id": "FJ4tz1v6Fqk6tUxsEyf9l", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://sand-api.monoova.com/kyb/v1/Entity", "servers": [ { "url": "https://sand-api.monoova.com/kyb/v1/Entity", "description": "Sandbox URL" }, { "url": "https://api.monoova.com/kyb/v1/Entity", "description": "Production URL" } ], "name": "Create an entity", "description": "Creates a new entity.", "contentType": "application/json-patch+json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "CreateEntityDto", "schema": [ { "name": "companyName", "kind": "required", "type": "string", "description": "", "example": "Test OZ AIRCONDITIONING PTY LTD", "maxLength": 160 }, { "name": "registrationNumber", "kind": "required", "type": "string", "description": "", "example": "74157843626", "maxLength": 11 }, { "name": "country", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "AUS", "maxLength": 3 }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "johndoe@gmail.com", "maxLength": 100 }, { "name": "mccCode", "kind": "required", "type": "string", "description": "", "example": "7623", "maxLength": 4 }, { "name": "externalReference", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "TestRef12345", "maxLength": 256 }, { "name": "automatcherAccountDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CreateEntityAutoMatcherDto", "customType": "CreateEntityAutoMatcherDto", "schema": [ { "name": "clientUniqueId", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "202512240000000125", "maxLength": 35 }, { "name": "bsb", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "802-985", "maxLength": 7 }, { "name": "bankAccountNumber", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "999999999" } ] }, { "name": "ledgerAccountDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CreateEntityLedgerAccountDto", "customType": "CreateEntityLedgerAccountDto", "schema": [ { "name": "name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Test OZ AIRCONDITIONING PTY LTD", "maxLength": 250 }, { "name": "description", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "OZ Ledger account", "maxLength": 256 } ] } ], "modelRef": "#/components/schemas/CreateEntityDto", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "CreateEntityResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/Error", "customType": "Error[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "MOS_REQ_BODY_INVALID", "MOS_VALIDATION_ERROR", "MOS_APIKEY_REQUIRED", "MOS_MACCOUNT_REQUIRED", "MOS_REGISTRATION_NUMBER_REQUIRED", "MOS_REGISTRATION_NUMBER_MAX_INVALID", "MOS_COUNTRY_MAX_INVALID", "MOS_POSTCODE_MAX_INVALID", "MOS_STATE_MAX_INVALID", "MOS_STREET_NUMBER_MAX_INVALID", "MOS_STREET_TYPE_MAX_INVALID", "MOS_UNIT_NUMBER_MAX_INVALID", "MOS_TOWN_MAX_INVALID", "MOS_SUBURB_MAX_INVALID", "MOS_COUNTRY_REQUIRED", "MOS_POSTCODE_REQUIRED", "MOS_STATE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_FORMAT_ERROR", "MOS_SUBURB_REQUIRED", "MOS_COMPANY_NAME_REQUIRED", "MOS_ADDRESS_REQUIRED", "MOS_COMPANY_NAME_MAX_INVALID", "MOS_MCC_CODE_REQUIRED", "MOS_MCC_CODE_MAX_INVALID", "MOS_ENTITY_APPLICANT_ID_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_NAME_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_DATA_REQUIRED", "MOS_ENTITY_ID_REQUIRED", "MOS_ENTITY_ID_MAX_INVALID", "MOS_ENTITY_ID_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_SYSTEM_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_DB_ERROR", "MOS_FUNCTION_NAME_IGNORE", "MOS_ENTITY_TYPE_IGNORE", "MOS_GENERATE_SIGNATURE_ERROR", "MOS_ENTITY_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_REQUIRED", "MOS_REQUEST_ID_REQUIRED", "MOS_INDIVIDUAL_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_EMAIL_REQUIRED", "MOS_EMAIL_DISPLAY_NAME_REQUIRED", "MOS_EMAIL_MAX_INVALID", "MOS_EMAIL_DISPLAY_NAME_MAX_INVALID", "MOS_EMAIL_MAX_LENGTH_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_NAME_MAX_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_DESCRIPTION_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_BSB_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_CLIENT_UNIQUE_ID_MAX_INVALID", "MOS_EMAIL_FORMAT_ERROR", "MOS_PHONE_REQUIRED", "MOS_PHONE_MAX_INVALID", "MOS_EXTERNAL_REFERENCE_MAX_INVALID", "MOS_FIRST_NAME_REQUIRED", "MOS_FIRST_NAME_MAX_INVALID", "MOS_LAST_NAME_REQUIRED", "MOS_LAST_NAME_MAX_INVALID", "MOS_MIDDLE_NAME_REQUIRED", "MOS_MIDDLE_NAME_MAX_INVALID", "MOS_DATE_OF_BIRTH_REQUIRED", "MOS_DATE_OF_BIRTH_FORMAT_ERROR", "MOS_STATE_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_FORMAT_ERROR", "MOS_INDIVIDUAL_APPLICANT_ID_FORMAT_ERROR", "MOS_DATE_OF_BIRTH_MAX_INVALID", "MOS_REQUEST_PAYLOAD_EMPTY", "MOS_CREATED_DATE_BEGIN_INVALID", "MOS_CREATED_DATE_END_INVALID", "MOS_PAGE_SIZE_INVALID", "MOS_PAGE_NUMBER_INVALID", "MOS_START_DATE_ERROR", "MOS_CREATE_CLIENT_EXISTS", "MOS_CLIENT_NOT_FOUND_ERROR", "MOS_SYSTEM_CREATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ASSOCIATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ONBOARDING_URL_ERROR", "MOS_SYSTEM_UPDATE_ENTITY_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_MIME_TYPE_ERROR", "MOS_SYSTEM_GET_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_BUSINESS_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_ENTITY_BY_ID_ERROR", "MOS_CLICK_SEND_GET_EMAIL_TEMPLATE_BY_ID_ERROR", "MOS_CLICK_SEND_SEND_EMAIL_ERROR", "MOS_CRM_GET_MCC_CODE_ERROR", "MOS_CRM_UPDATE_ACCOUNT_EMAIL_ERROR", "MOS_CRM_UPDATE_ACCOUNT_MCC_CODE_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ABN_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_KYC_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ID_ERROR", "MOS_GET_API_KEY_ERROR", "MOS_CRM_GET_ACCOUNT_EXISTS", "MOS_CRM_CREATE_ACCOUNT_ERROR", "MOS_MONOOVA_CREATE_LEDGER_ACCOUNT_ERROR", "MOS_MONOOVA_GET_LEDGER_ACCOUNT_TOKEN_ERROR", "MOS_CLIENT_UPDATE_ERROR", "MOS_CLIENT_NOT_UNIQUE", "MOS_UNEXPECTED_ERROR", "MOS_CLIENT_IDENTITY_NOT_FOUND_ERROR", "MOS_CLIENT_IDENTITY_NOT_UNIQUE" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] }, { "name": "entityApplicantId", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "e2d91eb9-7922-f111-8341-7ced8da15ab5" }, { "name": "ledgerAccountNumber", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "6279059713116082" }, { "name": "bankAccountNumber", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "114630169" }, { "name": "bankAccountName", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Test OZ AIRCONDITIONING PTY LTD" }, { "name": "bsb", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "802-985" } ], "modelRef": "#/components/schemas/CreateEntityResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/Error", "customType": "Error[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "MOS_REQ_BODY_INVALID", "MOS_VALIDATION_ERROR", "MOS_APIKEY_REQUIRED", "MOS_MACCOUNT_REQUIRED", "MOS_REGISTRATION_NUMBER_REQUIRED", "MOS_REGISTRATION_NUMBER_MAX_INVALID", "MOS_COUNTRY_MAX_INVALID", "MOS_POSTCODE_MAX_INVALID", "MOS_STATE_MAX_INVALID", "MOS_STREET_NUMBER_MAX_INVALID", "MOS_STREET_TYPE_MAX_INVALID", "MOS_UNIT_NUMBER_MAX_INVALID", "MOS_TOWN_MAX_INVALID", "MOS_SUBURB_MAX_INVALID", "MOS_COUNTRY_REQUIRED", "MOS_POSTCODE_REQUIRED", "MOS_STATE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_FORMAT_ERROR", "MOS_SUBURB_REQUIRED", "MOS_COMPANY_NAME_REQUIRED", "MOS_ADDRESS_REQUIRED", "MOS_COMPANY_NAME_MAX_INVALID", "MOS_MCC_CODE_REQUIRED", "MOS_MCC_CODE_MAX_INVALID", "MOS_ENTITY_APPLICANT_ID_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_NAME_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_DATA_REQUIRED", "MOS_ENTITY_ID_REQUIRED", "MOS_ENTITY_ID_MAX_INVALID", "MOS_ENTITY_ID_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_SYSTEM_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_DB_ERROR", "MOS_FUNCTION_NAME_IGNORE", "MOS_ENTITY_TYPE_IGNORE", "MOS_GENERATE_SIGNATURE_ERROR", "MOS_ENTITY_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_REQUIRED", "MOS_REQUEST_ID_REQUIRED", "MOS_INDIVIDUAL_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_EMAIL_REQUIRED", "MOS_EMAIL_DISPLAY_NAME_REQUIRED", "MOS_EMAIL_MAX_INVALID", "MOS_EMAIL_DISPLAY_NAME_MAX_INVALID", "MOS_EMAIL_MAX_LENGTH_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_NAME_MAX_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_DESCRIPTION_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_BSB_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_CLIENT_UNIQUE_ID_MAX_INVALID", "MOS_EMAIL_FORMAT_ERROR", "MOS_PHONE_REQUIRED", "MOS_PHONE_MAX_INVALID", "MOS_EXTERNAL_REFERENCE_MAX_INVALID", "MOS_FIRST_NAME_REQUIRED", "MOS_FIRST_NAME_MAX_INVALID", "MOS_LAST_NAME_REQUIRED", "MOS_LAST_NAME_MAX_INVALID", "MOS_MIDDLE_NAME_REQUIRED", "MOS_MIDDLE_NAME_MAX_INVALID", "MOS_DATE_OF_BIRTH_REQUIRED", "MOS_DATE_OF_BIRTH_FORMAT_ERROR", "MOS_STATE_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_FORMAT_ERROR", "MOS_INDIVIDUAL_APPLICANT_ID_FORMAT_ERROR", "MOS_DATE_OF_BIRTH_MAX_INVALID", "MOS_REQUEST_PAYLOAD_EMPTY", "MOS_CREATED_DATE_BEGIN_INVALID", "MOS_CREATED_DATE_END_INVALID", "MOS_PAGE_SIZE_INVALID", "MOS_PAGE_NUMBER_INVALID", "MOS_START_DATE_ERROR", "MOS_CREATE_CLIENT_EXISTS", "MOS_CLIENT_NOT_FOUND_ERROR", "MOS_SYSTEM_CREATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ASSOCIATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ONBOARDING_URL_ERROR", "MOS_SYSTEM_UPDATE_ENTITY_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_MIME_TYPE_ERROR", "MOS_SYSTEM_GET_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_BUSINESS_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_ENTITY_BY_ID_ERROR", "MOS_CLICK_SEND_GET_EMAIL_TEMPLATE_BY_ID_ERROR", "MOS_CLICK_SEND_SEND_EMAIL_ERROR", "MOS_CRM_GET_MCC_CODE_ERROR", "MOS_CRM_UPDATE_ACCOUNT_EMAIL_ERROR", "MOS_CRM_UPDATE_ACCOUNT_MCC_CODE_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ABN_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_KYC_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ID_ERROR", "MOS_GET_API_KEY_ERROR", "MOS_CRM_GET_ACCOUNT_EXISTS", "MOS_CRM_CREATE_ACCOUNT_ERROR", "MOS_MONOOVA_CREATE_LEDGER_ACCOUNT_ERROR", "MOS_MONOOVA_GET_LEDGER_ACCOUNT_TOKEN_ERROR", "MOS_CLIENT_UPDATE_ERROR", "MOS_CLIENT_NOT_UNIQUE", "MOS_UNEXPECTED_ERROR", "MOS_CLIENT_IDENTITY_NOT_FOUND_ERROR", "MOS_CLIENT_IDENTITY_NOT_UNIQUE" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] }, { "name": "requestId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "nullable": true, "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/Error", "customType": "Error[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "MOS_REQ_BODY_INVALID", "MOS_VALIDATION_ERROR", "MOS_APIKEY_REQUIRED", "MOS_MACCOUNT_REQUIRED", "MOS_REGISTRATION_NUMBER_REQUIRED", "MOS_REGISTRATION_NUMBER_MAX_INVALID", "MOS_COUNTRY_MAX_INVALID", "MOS_POSTCODE_MAX_INVALID", "MOS_STATE_MAX_INVALID", "MOS_STREET_NUMBER_MAX_INVALID", "MOS_STREET_TYPE_MAX_INVALID", "MOS_UNIT_NUMBER_MAX_INVALID", "MOS_TOWN_MAX_INVALID", "MOS_SUBURB_MAX_INVALID", "MOS_COUNTRY_REQUIRED", "MOS_POSTCODE_REQUIRED", "MOS_STATE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_FORMAT_ERROR", "MOS_SUBURB_REQUIRED", "MOS_COMPANY_NAME_REQUIRED", "MOS_ADDRESS_REQUIRED", "MOS_COMPANY_NAME_MAX_INVALID", "MOS_MCC_CODE_REQUIRED", "MOS_MCC_CODE_MAX_INVALID", "MOS_ENTITY_APPLICANT_ID_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_NAME_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_DATA_REQUIRED", "MOS_ENTITY_ID_REQUIRED", "MOS_ENTITY_ID_MAX_INVALID", "MOS_ENTITY_ID_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_SYSTEM_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_DB_ERROR", "MOS_FUNCTION_NAME_IGNORE", "MOS_ENTITY_TYPE_IGNORE", "MOS_GENERATE_SIGNATURE_ERROR", "MOS_ENTITY_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_REQUIRED", "MOS_REQUEST_ID_REQUIRED", "MOS_INDIVIDUAL_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_EMAIL_REQUIRED", "MOS_EMAIL_DISPLAY_NAME_REQUIRED", "MOS_EMAIL_MAX_INVALID", "MOS_EMAIL_DISPLAY_NAME_MAX_INVALID", "MOS_EMAIL_MAX_LENGTH_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_NAME_MAX_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_DESCRIPTION_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_BSB_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_CLIENT_UNIQUE_ID_MAX_INVALID", "MOS_EMAIL_FORMAT_ERROR", "MOS_PHONE_REQUIRED", "MOS_PHONE_MAX_INVALID", "MOS_EXTERNAL_REFERENCE_MAX_INVALID", "MOS_FIRST_NAME_REQUIRED", "MOS_FIRST_NAME_MAX_INVALID", "MOS_LAST_NAME_REQUIRED", "MOS_LAST_NAME_MAX_INVALID", "MOS_MIDDLE_NAME_REQUIRED", "MOS_MIDDLE_NAME_MAX_INVALID", "MOS_DATE_OF_BIRTH_REQUIRED", "MOS_DATE_OF_BIRTH_FORMAT_ERROR", "MOS_STATE_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_FORMAT_ERROR", "MOS_INDIVIDUAL_APPLICANT_ID_FORMAT_ERROR", "MOS_DATE_OF_BIRTH_MAX_INVALID", "MOS_REQUEST_PAYLOAD_EMPTY", "MOS_CREATED_DATE_BEGIN_INVALID", "MOS_CREATED_DATE_END_INVALID", "MOS_PAGE_SIZE_INVALID", "MOS_PAGE_NUMBER_INVALID", "MOS_START_DATE_ERROR", "MOS_CREATE_CLIENT_EXISTS", "MOS_CLIENT_NOT_FOUND_ERROR", "MOS_SYSTEM_CREATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ASSOCIATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ONBOARDING_URL_ERROR", "MOS_SYSTEM_UPDATE_ENTITY_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_MIME_TYPE_ERROR", "MOS_SYSTEM_GET_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_BUSINESS_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_ENTITY_BY_ID_ERROR", "MOS_CLICK_SEND_GET_EMAIL_TEMPLATE_BY_ID_ERROR", "MOS_CLICK_SEND_SEND_EMAIL_ERROR", "MOS_CRM_GET_MCC_CODE_ERROR", "MOS_CRM_UPDATE_ACCOUNT_EMAIL_ERROR", "MOS_CRM_UPDATE_ACCOUNT_MCC_CODE_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ABN_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_KYC_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ID_ERROR", "MOS_GET_API_KEY_ERROR", "MOS_CRM_GET_ACCOUNT_EXISTS", "MOS_CRM_CREATE_ACCOUNT_ERROR", "MOS_MONOOVA_CREATE_LEDGER_ACCOUNT_ERROR", "MOS_MONOOVA_GET_LEDGER_ACCOUNT_TOKEN_ERROR", "MOS_CLIENT_UPDATE_ERROR", "MOS_CLIENT_NOT_UNIQUE", "MOS_UNEXPECTED_ERROR", "MOS_CLIENT_IDENTITY_NOT_FOUND_ERROR", "MOS_CLIENT_IDENTITY_NOT_UNIQUE" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] }, { "name": "requestId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "nullable": true, "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "", "modelRef": "#/components/schemas/Error", "customType": "Error[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "Monoova error code", "enum": [ "MOS_REQ_BODY_INVALID", "MOS_VALIDATION_ERROR", "MOS_APIKEY_REQUIRED", "MOS_MACCOUNT_REQUIRED", "MOS_REGISTRATION_NUMBER_REQUIRED", "MOS_REGISTRATION_NUMBER_MAX_INVALID", "MOS_COUNTRY_MAX_INVALID", "MOS_POSTCODE_MAX_INVALID", "MOS_STATE_MAX_INVALID", "MOS_STREET_NUMBER_MAX_INVALID", "MOS_STREET_TYPE_MAX_INVALID", "MOS_UNIT_NUMBER_MAX_INVALID", "MOS_TOWN_MAX_INVALID", "MOS_SUBURB_MAX_INVALID", "MOS_COUNTRY_REQUIRED", "MOS_POSTCODE_REQUIRED", "MOS_STATE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_REQUIRED", "MOS_ENTITY_DOCUMENT_TYPE_FORMAT_ERROR", "MOS_SUBURB_REQUIRED", "MOS_COMPANY_NAME_REQUIRED", "MOS_ADDRESS_REQUIRED", "MOS_COMPANY_NAME_MAX_INVALID", "MOS_MCC_CODE_REQUIRED", "MOS_MCC_CODE_MAX_INVALID", "MOS_ENTITY_APPLICANT_ID_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_NAME_REQUIRED", "MOS_ENTITY_DOCUMENT_FILE_DATA_REQUIRED", "MOS_ENTITY_ID_REQUIRED", "MOS_ENTITY_ID_MAX_INVALID", "MOS_ENTITY_ID_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_SYSTEM_ERROR", "MOS_ENTITY_ID_NOT_FOUND_IN_DB_ERROR", "MOS_FUNCTION_NAME_IGNORE", "MOS_ENTITY_TYPE_IGNORE", "MOS_GENERATE_SIGNATURE_ERROR", "MOS_ENTITY_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_MAX_INVALID", "MOS_INDIVIDUAL_APPLICANT_ID_REQUIRED", "MOS_REQUEST_ID_REQUIRED", "MOS_INDIVIDUAL_APPLICANT_ID_NOT_FOUND_ERROR", "MOS_EMAIL_REQUIRED", "MOS_EMAIL_DISPLAY_NAME_REQUIRED", "MOS_EMAIL_MAX_INVALID", "MOS_EMAIL_DISPLAY_NAME_MAX_INVALID", "MOS_EMAIL_MAX_LENGTH_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_NAME_MAX_INVALID", "MOS_LEDGER_ACCOUNT_DETAILS_DESCRIPTION_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_BSB_MAX_INVALID", "MOS_AUTO_MATCHER_ACCOUNT_DETAILS_CLIENT_UNIQUE_ID_MAX_INVALID", "MOS_EMAIL_FORMAT_ERROR", "MOS_PHONE_REQUIRED", "MOS_PHONE_MAX_INVALID", "MOS_EXTERNAL_REFERENCE_MAX_INVALID", "MOS_FIRST_NAME_REQUIRED", "MOS_FIRST_NAME_MAX_INVALID", "MOS_LAST_NAME_REQUIRED", "MOS_LAST_NAME_MAX_INVALID", "MOS_MIDDLE_NAME_REQUIRED", "MOS_MIDDLE_NAME_MAX_INVALID", "MOS_DATE_OF_BIRTH_REQUIRED", "MOS_DATE_OF_BIRTH_FORMAT_ERROR", "MOS_STATE_FORMAT_ERROR", "MOS_ENTITY_APPLICANT_ID_FORMAT_ERROR", "MOS_INDIVIDUAL_APPLICANT_ID_FORMAT_ERROR", "MOS_DATE_OF_BIRTH_MAX_INVALID", "MOS_REQUEST_PAYLOAD_EMPTY", "MOS_CREATED_DATE_BEGIN_INVALID", "MOS_CREATED_DATE_END_INVALID", "MOS_PAGE_SIZE_INVALID", "MOS_PAGE_NUMBER_INVALID", "MOS_START_DATE_ERROR", "MOS_CREATE_CLIENT_EXISTS", "MOS_CLIENT_NOT_FOUND_ERROR", "MOS_SYSTEM_CREATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ASSOCIATE_BUSINESS_ENTITY_ERROR", "MOS_SYSTEM_CREATE_ONBOARDING_URL_ERROR", "MOS_SYSTEM_UPDATE_ENTITY_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_ERROR", "MOS_SYSTEM_UPLOAD_ENTITY_DOCUMENT_MIME_TYPE_ERROR", "MOS_SYSTEM_GET_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_BUSINESS_ENTITY_CHECK_BY_ID_ERROR", "MOS_SYSTEM_GET_ENTITY_BY_ID_ERROR", "MOS_CLICK_SEND_GET_EMAIL_TEMPLATE_BY_ID_ERROR", "MOS_CLICK_SEND_SEND_EMAIL_ERROR", "MOS_CRM_GET_MCC_CODE_ERROR", "MOS_CRM_UPDATE_ACCOUNT_EMAIL_ERROR", "MOS_CRM_UPDATE_ACCOUNT_MCC_CODE_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ABN_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_KYC_ERROR", "MOS_CRM_GET_ACCOUNT_BY_PARENT_AND_ID_ERROR", "MOS_GET_API_KEY_ERROR", "MOS_CRM_GET_ACCOUNT_EXISTS", "MOS_CRM_CREATE_ACCOUNT_ERROR", "MOS_MONOOVA_CREATE_LEDGER_ACCOUNT_ERROR", "MOS_MONOOVA_GET_LEDGER_ACCOUNT_TOKEN_ERROR", "MOS_CLIENT_UPDATE_ERROR", "MOS_CLIENT_NOT_UNIQUE", "MOS_UNEXPECTED_ERROR", "MOS_CLIENT_IDENTITY_NOT_FOUND_ERROR", "MOS_CLIENT_IDENTITY_NOT_UNIQUE" ] }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the specific error which may include information from the specific request." } ] }, { "name": "requestId", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "status", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "nullable": true, "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true }, { "statusCode": "502", "description": "Bad Gateway", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "kGNzb0h8vSs7fe-ChG-yJ", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://sand-api.monoova.com/kyb/v1/Entity \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json-patch+json' \\\n --data '{\n \"companyName\": \"Test OZ AIRCONDITIONING PTY LTD\",\n \"registrationNumber\": \"74157843626\",\n \"mccCode\": \"7623\"\n }'" }, { "id": "YYncP2XueQSgtbusp7C5n", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar raw = JSON.stringify({\n \"companyName\": \"Test OZ AIRCONDITIONING PTY LTD\",\n \"registrationNumber\": \"74157843626\",\n \"mccCode\": \"7623\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/kyb/v1/Entity\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "eWEJKiCL0vwqlO82zffSS", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/kyb/v1/Entity\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json-patch+json\"\nrequest.body = JSON.dump({\n \"companyName\": \"Test OZ AIRCONDITIONING PTY LTD\",\n \"registrationNumber\": \"74157843626\",\n \"mccCode\": \"7623\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "TZlDkDnGcxmT8Tjx7v3Xl", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/kyb/v1/Entity\"\n\npayload = json.dumps({\n \"companyName\": \"Test OZ AIRCONDITIONING PTY LTD\",\n \"registrationNumber\": \"74157843626\",\n \"mccCode\": \"7623\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json-patch+json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "kGNzb0h8vSs7fe-ChG-yJ" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"entityApplicantId\": \"e2d91eb9-7922-f111-8341-7ced8da15ab5\",\n \"ledgerAccountNumber\": \"6279059713116082\",\n \"bankAccountNumber\": \"114630169\",\n \"bankAccountName\": \"Test OZ AIRCONDITIONING PTY LTD\",\n \"bsb\": \"802-985\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": \"\",\n \"statusDescription\": \"\"\n}" }, { "id": "response-2-403", "language": "403", "code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": \"\",\n \"statusDescription\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"requestId\": \"\",\n \"status\": \"\",\n \"statusDescription\": \"\"\n}" }, { "id": "response-4-500", "language": "500", "code": "// Internal Server Error\n" }, { "id": "response-5-502", "language": "502", "code": "// Bad Gateway\n" }, { "id": "response-6-504", "language": "504", "code": "// Gateway Timeout\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }