POST api/Nymcard/IdentificationWebhook

Request Information

URI Parameters

None.

Body Parameters

WebhookMainModel
NameDescriptionTypeAdditional information
ID

globally unique identifier

None.

event

string

None.

user_id

globally unique identifier

None.

applicant_id

globally unique identifier

None.

sdk_token

string

None.

status

string

None.

status_reason_code

string

None.

createddatetime

date

None.

kyc_id

string

None.

old_status

string

None.

old_status_reason_code

string

None.

new_status

string

None.

new_status_reason_code

string

None.

user_type

string

None.

created

date

None.

User_status_change

UserStatusChange

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "85124e79-000e-4130-b313-2d2238700243",
  "event": "sample string 2",
  "user_id": "a9cab487-19ef-483b-8a4e-2afef26a515b",
  "applicant_id": "8d2a3959-7bcf-48d0-8f37-2b8b6cd88033",
  "sdk_token": "sample string 3",
  "status": "sample string 4",
  "status_reason_code": "sample string 5",
  "createddatetime": "2024-10-02T22:43:04.8443521+00:00",
  "kyc_id": "sample string 6",
  "old_status": "sample string 7",
  "old_status_reason_code": "sample string 8",
  "new_status": "sample string 9",
  "new_status_reason_code": "sample string 10",
  "user_type": "sample string 11",
  "created": "2024-10-02T22:43:04.8443521+00:00",
  "User_status_change": {
    "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": "2024-10-02T22:43:04.8443521+00:00",
    "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-02T22:43:04.8443521+00:00",
    "modified": "2024-10-02T22:43:04.8443521+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,
    "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,
    "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-02T22:43:04.8443521+00:00",
    "phone_number": "sample string 31",
    "website": "sample string 32",
    "status": "sample string 33",
    "status_reason_code": "sample string 34",
    "kyc_policy_passed": "sample string 35"
  }
}

application/xml, text/xml

Sample:
<WebhookMainModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <ID>85124e79-000e-4130-b313-2d2238700243</ID>
  <User_status_change>
    <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-02T22:43:04.8443521+00:00</created>
    <date_established>2024-10-02T22:43:04.8443521+00:00</date_established>
    <date_of_birth>2024-10-02T22:43:04.8443521+00:00</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</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>
    <kyc_policy_passed>sample string 35</kyc_policy_passed>
    <last_name>sample string 5</last_name>
    <middle_name>sample string 4</middle_name>
    <mobile>sample string 9</mobile>
    <modified>2024-10-02T22:43:04.8443521+00:00</modified>
    <monthly_salary>21</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>
    <status>sample string 33</status>
    <status_reason_code>sample string 34</status_reason_code>
    <title>sample string 2</title>
    <user_type>sample string 27</user_type>
    <website>sample string 32</website>
  </User_status_change>
  <applicant_id>8d2a3959-7bcf-48d0-8f37-2b8b6cd88033</applicant_id>
  <created>2024-10-02T22:43:04.8443521+00:00</created>
  <createddatetime>2024-10-02T22:43:04.8443521+00:00</createddatetime>
  <event>sample string 2</event>
  <kyc_id>sample string 6</kyc_id>
  <new_status>sample string 9</new_status>
  <new_status_reason_code>sample string 10</new_status_reason_code>
  <old_status>sample string 7</old_status>
  <old_status_reason_code>sample string 8</old_status_reason_code>
  <sdk_token>sample string 3</sdk_token>
  <status>sample string 4</status>
  <status_reason_code>sample string 5</status_reason_code>
  <user_id>a9cab487-19ef-483b-8a4e-2afef26a515b</user_id>
  <user_type>sample string 11</user_type>
</WebhookMainModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WebhookMainModel'.

Response Information

Resource Description

ResponseViewModel
NameDescriptionTypeAdditional information
Status

boolean

None.

StatusCode

integer

None.

Message

string

None.

Data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "StatusCode": 2,
  "Message": "sample string 3",
  "Data": {}
}

application/xml, text/xml

Sample:
<ResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <Data />
  <Message>sample string 3</Message>
  <Status>true</Status>
  <StatusCode>2</StatusCode>
</ResponseViewModel>