POST api/Nymcard/CreateHookUser

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

OperationStatusOfNymUser
NameDescriptionTypeAdditional information
Result

NymUser

None.

HasNoData

boolean

None.

ErrorMsg

string

None.

Succeeded

boolean

None.

AlreadyExists

boolean

None.

NotFound

boolean

None.

Error

Exception

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "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-10-01T10:00:56.2077806+00:00",
    "modified": "2024-10-01T10:00:56.2077806+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-10-01T10:00:56.2077806+00:00",
    "status": "sample string 31",
    "status_reason_code": "sample string 32",
    "phone_number": "sample string 33",
    "website": "sample string 34"
  },
  "HasNoData": true,
  "ErrorMsg": "sample string 2",
  "Succeeded": true,
  "AlreadyExists": true,
  "NotFound": true,
  "Error": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<OperationStatusOfNymUsers25BU49F xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <AlreadyExists>true</AlreadyExists>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Error>
  <ErrorMsg>sample string 2</ErrorMsg>
  <HasNoData>true</HasNoData>
  <NotFound>true</NotFound>
  <Result>
    <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-10-01T10:00:56.2077806+00:00</created>
    <date_established>2024-10-01T10:00:56.2077806+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-10-01T10:00:56.2077806+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 33</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>
    <status>sample string 31</status>
    <status_reason_code>sample string 32</status_reason_code>
    <title>sample string 2</title>
    <user_type>sample string 27</user_type>
    <website>sample string 34</website>
  </Result>
  <Succeeded>true</Succeeded>
</OperationStatusOfNymUsers25BU49F>