Skip to main content
POST
/
api
/
customer
createNewCustomer
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/customer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "profileReferenceId": "<string>",
  "type": "CORPORATE",
  "active": true,
  "assigneeId": 123,
  "batchUploadId": 123,
  "forms": {},
  "id": 123,
  "profileId": 123,
  "referenceId": "<string>",
  "vendorEntityGuid": "<string>",
  "vendorName": "<string>"
}
'
{
  "active": true,
  "assignees": [
    {
      "email": "<string>",
      "firstName": "<string>",
      "fullName": "<string>",
      "id": 123,
      "lastName": "<string>"
    }
  ],
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "forms": {},
  "id": 123,
  "lastRiskAssessment": "2023-11-07T05:31:56Z",
  "listRoleAsText": [
    "<string>"
  ],
  "notes": {},
  "other": {},
  "parentId": 123,
  "particular": {},
  "profileId": 123,
  "profileReferenceId": "<string>",
  "referenceId": "<string>",
  "riskRating": "HIGH",
  "roles": [
    {
      "appointedDate": "2023-12-25",
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "id": 123,
      "resignedDate": "2023-12-25",
      "role": "<string>",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "status": "ACCEPTED",
  "type": "CORPORATE",
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "vendorEntityGuid": "<string>",
  "vendorName": "<string>"
}

​
Description

This endpoint creates a new Corporate Primary Customer. You can submit either:
  • A minimal request with only the mandatory fields, or
  • A full request with all optional fields.
Important:
  • To create a new corporate primary customer, it is mandatory for the end user to provide their profileReferenceId and corporate particulars (name, incorporationStatus, countryOfIncorporation, and operation) inside the request body.
  • The type field must be set to CORPORATE.
Field Specifications:
  • evidenceCorroborated: Enum field that accepts either "YES" or "NO". Used in sourceOfFunds and sourceOfWealth arrays.

​
Sample Request Body 1 - Corporate Customer (Mandatory fields only)

{
  "active": true,
  "profileReferenceId": "180162353535F",
  "other": {
    "entityType": "ASSOCIATION",
    "corporateWebsite": null,
    "industry": "AGRICULTURE",
    "onBoardingMode": "FACE-TO-FACE",
    "ownershipStructureLayer": "1",
    "paymentMode": [
      "CHEQUE (LOCAL)"
    ],
    "productServiceComplexity": "SIMPLE"
  },
  "particular": {
    "incorporated": true,
    "name": "Corporate Primary Customer",
    "countryOfIncorporation": "SINGAPORE",
    "countryOfOperation": [
      "SINGAPORE"
    ]
  },
  "type": "CORPORATE",
  "domainId": [
    {{domain_id}}
  ],
  "assigneeId": {{assignee_id}}
}

​
Sample Request Body 2 - Corporate Customer (All fields)

{
  "active": true,
  "profileReferenceId": "180162353535",
  "other": {
    "entityType": "ASSOCIATION",
    "corporateWebsite": null,
    "fatfjurisdiction": "",
    "industry": "AGRICULTURE",
    "onBoardingMode": "FACE-TO-FACE",
    "ownershipStructureLayer": "1",
    "paymentMode": [
      "CHEQUE (LOCAL)"
    ],
    "productServiceComplexity": "SIMPLE",
    "sourceOfFunds": [
        {
          "id": "",
          "category": "",
          "amountDeclared": null,
          "evidenceCorroborated": "YES"
        }
        ],
        "sourceOfWealth": [
          {
            "id": "",
            "category": "",
            "amountDeclared": null,
            "evidenceCorroborated": "YES"
          }
    ],
    "natureOfBusinessRelationship": "",
    "bankAccount": [],
    "additionalInformation": ""
  },
  "particular": {
    "incorporated": true,
    "name": "Corporate Primary Customer",
    "alias": [],
    "formerName": [],
    "countryOfIncorporation": "SINGAPORE",
    "countryOfOperation": [
      "SINGAPORE"
    ],
    "address": [],
    "incorporateNumber": "",
    "phone": [],
    "email": [],
    "dateOfIncorporation": null,
    "dateOfIncorporationExpiry": null,
    "imonumber": null
  },
  "type": "CORPORATE",
  "domainId": [
    {{domain_id}}
  ],
  "assigneeId": {{assignee_id}}
}

​
Below is the following sample JSON response body when it is successful in creating a new customer.S

​
Success Code 200

{
  "id": 926,
  "createdAt": "2022-07-26T04:28:23.297+00:00",
  "updatedAt": "2022-07-26T04:28:23.302+00:00",
  "createdBy": null,
  "updatedBy": null,
  "active": true,
  "parentId": null,
  "profileId": 916,
  "type": "CORPORATE",
  "referenceId": null,
  "profileReferenceId": "180162353535F",
  "particular": {
    "incorporated": true,
    "name": "Corporate Primary Customer",
    "alias": null,
    "formerName": null,
    "countryOfIncorporation": "SINGAPORE",
    "countryOfOperation": [
      "SINGAPORE"
    ],
    "address": null,
    "incorporateNumber": null,
    "phone": null,
    "email": null,
    "dateOfIncorporation": null,
    "dateOfIncorporationExpiry": null,
    "vendorName": null,
    "vendorEntityGuid": null,
    "imonumber": null
  },
  "other": {
    "ownershipStructureLayer": "1",
    "industry": "AGRICULTURE",
    "onBoardingMode": "FACE-TO-FACE",
    "paymentMode": [
      "CHEQUE (LOCAL)"
    ],
    "productServiceComplexity": "SIMPLE",
    "bankAccount": null,
    "corporateWebsite": null,
    "sourceOfFunds": null,
    "natureOfBusinessRelationship": null,
    "additionalInformation": null,
    "documentList": null,
    "entityType": "ASSOCIATION",
    "variableCapitalCompany": null,
    "fatfjurisdiction": false
  },
  "vendorName": null,
  "vendorEntityGuid": null,
  "lastRiskAssessment": null,
  "status": "DRAFT",
  "riskRating": "UNKNOWN",
  "roles": [],
  "listRoleAsText": []
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer<int64>
required

X-Domain-ID

Body

application/json

customerDTO

​
profileReferenceId
string
required
​
type
enum<string>
required
Available options:
CORPORATE,
INDIVIDUAL
​
active
boolean
​
assigneeId
integer<int64>
​
batchUploadId
integer<int64>
​
forms
JsonNode · object
​
id
integer<int64>
​
profileId
integer<int64>
​
referenceId
string
​
vendorEntityGuid
string
​
vendorName
string

Response

OK

​
active
boolean
​
assignees
UserInfo · object[]
​
createdAt
Timestamp · object
​
createdBy
UserInfo · object
​
forms
JsonNode · object
​
id
integer<int64>
​
lastRiskAssessment
string<date-time>
​
listRoleAsText
string[]
​
notes
JsonNode · object
​
other
JsonNode · object
​
parentId
integer<int64>
​
particular
JsonNode · object
​
profileId
integer<int64>
​
profileReferenceId
string
​
referenceId
string
​
riskRating
enum<string>
Available options:
HIGH,
LOW,
MEDIUM,
MEDIUM_HIGH,
MEDIUM_LOW,
UNKNOWN
​
roles
CRPRoleResponseDto · object[]
​
status
enum<string>
Available options:
ACCEPTED,
CLEARED,
DRAFT,
PENDING,
REJECTED,
REQUEST_CHANGES
​
type
enum<string>
Available options:
CORPORATE,
INDIVIDUAL
​
updatedAt
Timestamp · object
​
updatedBy
UserInfo · object
​
vendorEntityGuid
string
​
vendorName
string