POST api/NYMCARDService/CreateUser

Request Information

URI Parameters

None.

Body Parameters

UserInput
NameDescriptionTypeAdditional information
first_name

string

None.

id

string

None.

title

string

None.

middle_name

string

None.

last_name

string

None.

native_name

string

None.

date_of_birth

string

None.

email

string

None.

mobile

string

None.

address

Address

None.

gender

string

None.

preferred_language

string

None.

place_of_birth

string

None.

nationality

string

None.

parent_user_id

string

None.

country_residence

string

None.

country_tax_residence

string

None.

employment_type

string

None.

employment_title

string

None.

monthly_salary

decimal number

None.

company_name

string

None.

company_address

CompanyAddress

None.

company_country

string

None.

industry_type

string

None.

expected_monthly_balance

decimal number

None.

relationship_with_parent

string

None.

user_type

string

None.

business_legal_name

string

None.

business_dba_name

string

None.

date_established

date

None.

phone_number

string

None.

website

string

None.

Request Formats

application/json, text/json

Sample:
{
  "first_name": "sample string 1",
  "id": "sample string 2",
  "title": "sample string 3",
  "middle_name": "sample string 4",
  "last_name": "sample string 5",
  "native_name": "sample string 6",
  "date_of_birth": "sample string 7",
  "email": "sample string 8",
  "mobile": "sample string 9",
  "address": {
    "address_line1": "sample string 1",
    "address_line2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "postal_code": "sample string 5",
    "country": "sample string 6"
  },
  "gender": "sample string 10",
  "preferred_language": "sample string 11",
  "place_of_birth": "sample string 12",
  "nationality": "sample string 13",
  "parent_user_id": "sample string 14",
  "country_residence": "sample string 15",
  "country_tax_residence": "sample string 16",
  "employment_type": "sample string 17",
  "employment_title": "sample string 18",
  "monthly_salary": 19.1,
  "company_name": "sample string 20",
  "company_address": {
    "address_line1": "sample string 1",
    "address_line2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "postal_code": "sample string 5",
    "country": "sample string 6"
  },
  "company_country": "sample string 21",
  "industry_type": "sample string 22",
  "expected_monthly_balance": 23.1,
  "relationship_with_parent": "sample string 24",
  "user_type": "sample string 25",
  "business_legal_name": "sample string 26",
  "business_dba_name": "sample string 27",
  "date_established": "2024-09-19T04:22:24.9825708+00:00",
  "phone_number": "sample string 28",
  "website": "sample string 29"
}

application/xml, text/xml

Sample:
<UserInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <address>
    <address_line1>sample string 1</address_line1>
    <address_line2>sample string 2</address_line2>
    <city>sample string 3</city>
    <country>sample string 6</country>
    <postal_code>sample string 5</postal_code>
    <state>sample string 4</state>
  </address>
  <business_dba_name>sample string 27</business_dba_name>
  <business_legal_name>sample string 26</business_legal_name>
  <company_address>
    <address_line1>sample string 1</address_line1>
    <address_line2>sample string 2</address_line2>
    <city>sample string 3</city>
    <country>sample string 6</country>
    <postal_code>sample string 5</postal_code>
    <state>sample string 4</state>
  </company_address>
  <company_country>sample string 21</company_country>
  <company_name>sample string 20</company_name>
  <country_residence>sample string 15</country_residence>
  <country_tax_residence>sample string 16</country_tax_residence>
  <date_established>2024-09-19T04:22:24.9825708+00:00</date_established>
  <date_of_birth>sample string 7</date_of_birth>
  <email>sample string 8</email>
  <employment_title>sample string 18</employment_title>
  <employment_type>sample string 17</employment_type>
  <expected_monthly_balance>23.1</expected_monthly_balance>
  <first_name>sample string 1</first_name>
  <gender>sample string 10</gender>
  <id>sample string 2</id>
  <industry_type>sample string 22</industry_type>
  <last_name>sample string 5</last_name>
  <middle_name>sample string 4</middle_name>
  <mobile>sample string 9</mobile>
  <monthly_salary>19.1</monthly_salary>
  <nationality>sample string 13</nationality>
  <native_name>sample string 6</native_name>
  <parent_user_id>sample string 14</parent_user_id>
  <phone_number>sample string 28</phone_number>
  <place_of_birth>sample string 12</place_of_birth>
  <preferred_language>sample string 11</preferred_language>
  <relationship_with_parent>sample string 24</relationship_with_parent>
  <title>sample string 3</title>
  <user_type>sample string 25</user_type>
  <website>sample string 29</website>
</UserInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResponseOfUser
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Data

User

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Data": {
    "id": "sample string 1",
    "title": "sample string 2",
    "first_name": "sample string 3",
    "middle_name": "sample string 4",
    "last_name": "sample string 5",
    "native_name": "sample string 6",
    "date_of_birth": "sample string 7",
    "email": "sample string 8",
    "mobile": "sample string 9",
    "address": {
      "address_line1": "sample string 1",
      "address_line2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "postal_code": "sample string 5",
      "country": "sample string 6"
    },
    "gender": "sample string 10",
    "preferred_language": "sample string 11",
    "place_of_birth": "sample string 12",
    "nationality": "sample string 13",
    "parent_user_id": "sample string 14",
    "created": "2024-09-19T04:22:25.0138713+00:00",
    "modified": "2024-09-19T04:22:25.0138713+00:00",
    "country_residence": "sample string 17",
    "country_tax_residence": "sample string 18",
    "employment_type": "sample string 19",
    "employment_title": "sample string 20",
    "monthly_salary": 21.1,
    "company_name": "sample string 22",
    "company_address": {
      "address_line1": "sample string 1",
      "address_line2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "postal_code": "sample string 5",
      "country": "sample string 6"
    },
    "company_country": "sample string 23",
    "industry_type": "sample string 24",
    "expected_monthly_balance": 25.1,
    "relationship_with_parent": "sample string 26",
    "user_type": "sample string 27",
    "business_legal_name": "sample string 28",
    "business_dba_name": "sample string 29",
    "date_established": "2024-09-19T04:22:25.0138713+00:00",
    "phone_number": "sample string 31",
    "website": "sample string 32"
  },
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<BaseResponseOfUserzwF0ve9J xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <Data>
    <address>
      <address_line1>sample string 1</address_line1>
      <address_line2>sample string 2</address_line2>
      <city>sample string 3</city>
      <country>sample string 6</country>
      <postal_code>sample string 5</postal_code>
      <state>sample string 4</state>
    </address>
    <business_dba_name>sample string 29</business_dba_name>
    <business_legal_name>sample string 28</business_legal_name>
    <company_address>
      <address_line1>sample string 1</address_line1>
      <address_line2>sample string 2</address_line2>
      <city>sample string 3</city>
      <country>sample string 6</country>
      <postal_code>sample string 5</postal_code>
      <state>sample string 4</state>
    </company_address>
    <company_country>sample string 23</company_country>
    <company_name>sample string 22</company_name>
    <country_residence>sample string 17</country_residence>
    <country_tax_residence>sample string 18</country_tax_residence>
    <created>2024-09-19T04:22:25.0138713+00:00</created>
    <date_established>2024-09-19T04:22:25.0138713+00:00</date_established>
    <date_of_birth>sample string 7</date_of_birth>
    <email>sample string 8</email>
    <employment_title>sample string 20</employment_title>
    <employment_type>sample string 19</employment_type>
    <expected_monthly_balance>25.1</expected_monthly_balance>
    <first_name>sample string 3</first_name>
    <gender>sample string 10</gender>
    <id>sample string 1</id>
    <industry_type>sample string 24</industry_type>
    <last_name>sample string 5</last_name>
    <middle_name>sample string 4</middle_name>
    <mobile>sample string 9</mobile>
    <modified>2024-09-19T04:22:25.0138713+00:00</modified>
    <monthly_salary>21.1</monthly_salary>
    <nationality>sample string 13</nationality>
    <native_name>sample string 6</native_name>
    <parent_user_id>sample string 14</parent_user_id>
    <phone_number>sample string 31</phone_number>
    <place_of_birth>sample string 12</place_of_birth>
    <preferred_language>sample string 11</preferred_language>
    <relationship_with_parent>sample string 26</relationship_with_parent>
    <title>sample string 2</title>
    <user_type>sample string 27</user_type>
    <website>sample string 32</website>
  </Data>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccess>true</IsSuccess>
</BaseResponseOfUserzwF0ve9J>