POST CLIENT_ONBOARD_REQ

Request Information

URI Parameters

None.

Body Parameters

CLIENT_ONBOARDING_MODEL
NameDescriptionTypeAdditional information
firstname

string

None.

lastname

string

None.

email

string

None.

PIN

string

None.

DOB

date

None.

idnumber

integer

None.

MobileNo

integer

None.

PostalAddress

string

None.

PostalCode

string

None.

Town

string

None.

NextOfKinName

string

None.

NofKRelation

string

None.

NofKMobileNo

integer

None.

fund_code

integer

None.

idType

integer

None.

middlename

string

None.

password

string

None.

title

string

None.

Occupation

integer

None.

fund_source

string

None.

agent_code

integer

None.

EMG_TITLE

string

None.

EMG_DOB

date

None.

EMG_GENDER

integer

None.

EMG_RELATIONSHIP

string

Required

Matching regular expression pattern: ^^[a-zA-Z\-\.]+(?: [a-zA-Z\-\.]+)*$

Max length: 20

EMG_NATIONALITY

integer

Required

Matching regular expression pattern: ^[0-9]+$

EMG_FNAME

string

Required

Matching regular expression pattern: ^^[a-zA-Z\-\.\,\!\@\#\$\%\^\&\*\']+(?: [a-zA-Z\-\.]+)*$

Max length: 50

EMG_MNAME

string

Matching regular expression pattern: ^^[a-zA-Z\-\.\,\!\@\#\$\%\^\&\*\']+(?: [a-zA-Z\-\.]+)*$

Max length: 50

EMG_LNAME

string

Required

Matching regular expression pattern: ^^[a-zA-Z\-\.\,\!\@\#\$\%\^\&\*\']+(?: [a-zA-Z\-\.]+)*$

Max length: 50

EMG_ID_TYPE

integer

Required

Matching regular expression pattern: ^[0-9]+$

EMG_PASPRT_NO

string

None.

EMG_PASSPRT_ISSUE_DT

date

None.

EMG_PASSPRT_EXP_DT

date

None.

EMG_MOB

integer

Required

Range: inclusive between 100000000 and 999999999999

EMG_EMAIL

string

Required

Matching regular expression pattern: \w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*

Max length: 50

EMG_POSTAL_ADD

string

Required

Matching regular expression pattern: ^[a-zA-Z0-9\-\.]+(?: [a-zA-Z0-9_\-\.]+)*$

Max length: 100

EMG_POSTAL_CODE

string

Required

Matching regular expression pattern: ^[0-9\-]*$

Max length: 12

EMG_CITY

string

None.

Request Formats

application/json, text/json

Sample:
{
  "firstname": "sample string 1",
  "lastname": "sample string 2",
  "email": "sample string 3",
  "PIN": "sample string 4",
  "DOB": "2026-08-08T12:36:21.2105743+00:00",
  "idnumber": 6,
  "MobileNo": 7,
  "PostalAddress": "sample string 8",
  "PostalCode": "sample string 9",
  "Town": "sample string 10",
  "NextOfKinName": "sample string 11",
  "NofKRelation": "sample string 12",
  "NofKMobileNo": 13,
  "fund_code": 14,
  "idType": 1,
  "middlename": "sample string 15",
  "password": "sample string 16",
  "title": "sample string 17",
  "Occupation": 18,
  "fund_source": "sample string 19",
  "agent_code": 20,
  "EMG_TITLE": "sample string 21",
  "EMG_DOB": "2026-08-08T12:36:21.2105743+00:00",
  "EMG_GENDER": 22,
  "EMG_RELATIONSHIP": "sample string 23",
  "EMG_NATIONALITY": 1,
  "EMG_FNAME": "sample string 24",
  "EMG_MNAME": "sample string 25",
  "EMG_LNAME": "sample string 26",
  "EMG_ID_TYPE": 1,
  "EMG_PASPRT_NO": "sample string 27",
  "EMG_PASSPRT_ISSUE_DT": "2026-08-08T12:36:21.2105743+00:00",
  "EMG_PASSPRT_EXP_DT": "2026-08-08T12:36:21.2105743+00:00",
  "EMG_MOB": 28,
  "EMG_EMAIL": "sample string 29",
  "EMG_POSTAL_ADD": "sample string 30",
  "EMG_POSTAL_CODE": "sample string 31",
  "EMG_CITY": "sample string 32"
}

application/xml, text/xml

Sample:
<CLIENT_ONBOARDING_MODEL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/INVS_ERP.ViewModels">
  <DOB>2026-08-08T12:36:21.2105743+00:00</DOB>
  <EMG_CITY>sample string 32</EMG_CITY>
  <EMG_DOB>2026-08-08T12:36:21.2105743+00:00</EMG_DOB>
  <EMG_EMAIL>sample string 29</EMG_EMAIL>
  <EMG_FNAME>sample string 24</EMG_FNAME>
  <EMG_GENDER>22</EMG_GENDER>
  <EMG_ID_TYPE>1</EMG_ID_TYPE>
  <EMG_LNAME>sample string 26</EMG_LNAME>
  <EMG_MNAME>sample string 25</EMG_MNAME>
  <EMG_MOB>28</EMG_MOB>
  <EMG_NATIONALITY>1</EMG_NATIONALITY>
  <EMG_PASPRT_NO>sample string 27</EMG_PASPRT_NO>
  <EMG_PASSPRT_EXP_DT>2026-08-08T12:36:21.2105743+00:00</EMG_PASSPRT_EXP_DT>
  <EMG_PASSPRT_ISSUE_DT>2026-08-08T12:36:21.2105743+00:00</EMG_PASSPRT_ISSUE_DT>
  <EMG_POSTAL_ADD>sample string 30</EMG_POSTAL_ADD>
  <EMG_POSTAL_CODE>sample string 31</EMG_POSTAL_CODE>
  <EMG_RELATIONSHIP>sample string 23</EMG_RELATIONSHIP>
  <EMG_TITLE>sample string 21</EMG_TITLE>
  <MobileNo>7</MobileNo>
  <NextOfKinName>sample string 11</NextOfKinName>
  <NofKMobileNo>13</NofKMobileNo>
  <NofKRelation>sample string 12</NofKRelation>
  <Occupation>18</Occupation>
  <PIN>sample string 4</PIN>
  <PostalAddress>sample string 8</PostalAddress>
  <PostalCode>sample string 9</PostalCode>
  <Town>sample string 10</Town>
  <agent_code>20</agent_code>
  <email>sample string 3</email>
  <firstname>sample string 1</firstname>
  <fund_code>14</fund_code>
  <fund_source>sample string 19</fund_source>
  <idType>1</idType>
  <idnumber>6</idnumber>
  <lastname>sample string 2</lastname>
  <middlename>sample string 15</middlename>
  <password>sample string 16</password>
  <title>sample string 17</title>
</CLIENT_ONBOARDING_MODEL>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.