POST api/SoftAML/PostAccount

Post Account (Single)

Request Information

URI Parameters

None.

Body Parameters

Request Body

account_information_uploads_model
NameDescriptionTypeAdditional information
account_number

Account Number

 string

None.
account_branch

Branch holding account

 string

None.
account_name

Account Name

 string

None.
client_number

The account holder BVN

 string

None.
account_currency_code

Currency the account is kept in

 string

None.
account_type

account Type Code varchar(1) A_Business, C_Savings, D_Current Business, E_Current personal, I_Fixed, L_Trading Account, O_Other, P_Dormicilliary

 string

None.
account_opened_date

Date Account was opened

 date

None.
account_closed_date

Date account was closed, if it has been closed.

 string

None.
account_status_code

account Status after transaction was conducted varchar(1) A_Active, B_Partially Blocked (PND), C_Dormant, H_Fully Blocked, P_performing, N_Non-Performin

 string

None.
account_beneficiary

Ultimate beneficiary of the account

 string

None.
account_balance

The account balance after the transaction was conducted

 decimal number

None.
entity_name

Involved entity name, If Any

 string

None.
entity_incorporation_number

The registration number of the entity/"company" in the relevant authority(e.g.Chamber ofCommerce)

 string

None.
entity_business

Business of the entity

 string

None.
entity_phone_contact_type

Business of the entity varchar(10) Business - B, Private - P

 string

None.
entity_phone_type

string

None.
entity_phone_number

Entity Telephone number

 string

None.
entity_address_type

The contact type of the address Street name and house number

 string

None.
entity_address

Street name and house number

 string

None.
entity_city

City where the entity can be located

 string

None.
entity_state

City where the entity can be located

 string

None.
entity_country_code

Country Code of the enitity varchar(2) e.g NG

 string

None.
entity_email

Email address of the entity

 string

None.
signatories

Account Signatories

 Collection of account_signatories_directors_uploads_model

None.

Request Formats

application/json, text/json

Sample: 
{
  "account_number": "sample string 1",
  "account_branch": "sample string 2",
  "account_name": "sample string 3",
  "client_number": "sample string 4",
  "account_currency_code": "sample string 5",
  "account_type": "sample string 6",
  "account_opened_date": "2025-12-06T05:13:09.3294673+01:00",
  "account_closed_date": "sample string 7",
  "account_status_code": "sample string 8",
  "account_beneficiary": "sample string 9",
  "account_balance": 1.0,
  "entity_name": "sample string 10",
  "entity_incorporation_number": "sample string 11",
  "entity_business": "sample string 12",
  "entity_phone_contact_type": "sample string 13",
  "entity_phone_type": "sample string 14",
  "entity_phone_number": "sample string 15",
  "entity_address_type": "sample string 16",
  "entity_address": "sample string 17",
  "entity_city": "sample string 18",
  "entity_state": "sample string 19",
  "entity_country_code": "sample string 20",
  "entity_email": "sample string 21",
  "signatories": [
    {
      "account_number": "sample string 1",
      "client_number": "sample string 2",
      "person_type": "sample string 3",
      "is_primary": "sample string 4",
      "person_title": "sample string 5",
      "person_first_name": "sample string 6",
      "person_last_name": "sample string 7",
      "person_gender": "sample string 8",
      "person_birth_date": "2025-12-06T05:13:09.3294673+01:00",
      "person_passport_number": "sample string 9",
      "person_passport_country": "sample string 10",
      "person_id_type": "sample string 11",
      "person_id_number": "sample string 12",
      "person_issue_country": "sample string 13",
      "person_nationality": "sample string 14",
      "person_tph_contact_type": "sample string 15",
      "person_tph_comm_type": "sample string 16",
      "person_phone_number": "sample string 17",
      "person_address_type": "sample string 18",
      "person_address": "sample string 19",
      "person_city": "sample string 20",
      "person_state": "sample string 21",
      "person_country_code": "sample string 22",
      "person_email": "sample string 23",
      "person_occupation": "sample string 24",
      "person_tax_number": "sample string 25",
      "expiry_date": "2025-12-06T05:13:09.3294673+01:00",
      "issues_country": "sample string 26",
      "issue_date": "2025-12-06T05:13:09.3294673+01:00",
      "issued_by": "sample string 27",
      "id_type": "sample string 28"
    },
    {
      "account_number": "sample string 1",
      "client_number": "sample string 2",
      "person_type": "sample string 3",
      "is_primary": "sample string 4",
      "person_title": "sample string 5",
      "person_first_name": "sample string 6",
      "person_last_name": "sample string 7",
      "person_gender": "sample string 8",
      "person_birth_date": "2025-12-06T05:13:09.3294673+01:00",
      "person_passport_number": "sample string 9",
      "person_passport_country": "sample string 10",
      "person_id_type": "sample string 11",
      "person_id_number": "sample string 12",
      "person_issue_country": "sample string 13",
      "person_nationality": "sample string 14",
      "person_tph_contact_type": "sample string 15",
      "person_tph_comm_type": "sample string 16",
      "person_phone_number": "sample string 17",
      "person_address_type": "sample string 18",
      "person_address": "sample string 19",
      "person_city": "sample string 20",
      "person_state": "sample string 21",
      "person_country_code": "sample string 22",
      "person_email": "sample string 23",
      "person_occupation": "sample string 24",
      "person_tax_number": "sample string 25",
      "expiry_date": "2025-12-06T05:13:09.3294673+01:00",
      "issues_country": "sample string 26",
      "issue_date": "2025-12-06T05:13:09.3294673+01:00",
      "issued_by": "sample string 27",
      "id_type": "sample string 28"
    }
  ]
}

application/xml, text/xml

Sample: 
<account_information_uploads_model xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SoftAML_UpperLinkAPI.Models">
  <account_balance>1</account_balance>
  <account_beneficiary>sample string 9</account_beneficiary>
  <account_branch>sample string 2</account_branch>
  <account_closed_date>sample string 7</account_closed_date>
  <account_currency_code>sample string 5</account_currency_code>
  <account_name>sample string 3</account_name>
  <account_number>sample string 1</account_number>
  <account_opened_date>2025-12-06T05:13:09.3294673+01:00</account_opened_date>
  <account_status_code>sample string 8</account_status_code>
  <account_type>sample string 6</account_type>
  <client_number>sample string 4</client_number>
  <entity_address>sample string 17</entity_address>
  <entity_address_type>sample string 16</entity_address_type>
  <entity_business>sample string 12</entity_business>
  <entity_city>sample string 18</entity_city>
  <entity_country_code>sample string 20</entity_country_code>
  <entity_email>sample string 21</entity_email>
  <entity_incorporation_number>sample string 11</entity_incorporation_number>
  <entity_name>sample string 10</entity_name>
  <entity_phone_contact_type>sample string 13</entity_phone_contact_type>
  <entity_phone_number>sample string 15</entity_phone_number>
  <entity_phone_type>sample string 14</entity_phone_type>
  <entity_state>sample string 19</entity_state>
  <signatories>
    <account_signatories_directors_uploads_model>
      <account_number>sample string 1</account_number>
      <client_number>sample string 2</client_number>
      <expiry_date>2025-12-06T05:13:09.3294673+01:00</expiry_date>
      <id_type>sample string 28</id_type>
      <is_primary>sample string 4</is_primary>
      <issue_date>2025-12-06T05:13:09.3294673+01:00</issue_date>
      <issued_by>sample string 27</issued_by>
      <issues_country>sample string 26</issues_country>
      <person_address>sample string 19</person_address>
      <person_address_type>sample string 18</person_address_type>
      <person_birth_date>2025-12-06T05:13:09.3294673+01:00</person_birth_date>
      <person_city>sample string 20</person_city>
      <person_country_code>sample string 22</person_country_code>
      <person_email>sample string 23</person_email>
      <person_first_name>sample string 6</person_first_name>
      <person_gender>sample string 8</person_gender>
      <person_id_number>sample string 12</person_id_number>
      <person_id_type>sample string 11</person_id_type>
      <person_issue_country>sample string 13</person_issue_country>
      <person_last_name>sample string 7</person_last_name>
      <person_nationality>sample string 14</person_nationality>
      <person_occupation>sample string 24</person_occupation>
      <person_passport_country>sample string 10</person_passport_country>
      <person_passport_number>sample string 9</person_passport_number>
      <person_phone_number>sample string 17</person_phone_number>
      <person_state>sample string 21</person_state>
      <person_tax_number>sample string 25</person_tax_number>
      <person_title>sample string 5</person_title>
      <person_tph_comm_type>sample string 16</person_tph_comm_type>
      <person_tph_contact_type>sample string 15</person_tph_contact_type>
      <person_type>sample string 3</person_type>
    </account_signatories_directors_uploads_model>
    <account_signatories_directors_uploads_model>
      <account_number>sample string 1</account_number>
      <client_number>sample string 2</client_number>
      <expiry_date>2025-12-06T05:13:09.3294673+01:00</expiry_date>
      <id_type>sample string 28</id_type>
      <is_primary>sample string 4</is_primary>
      <issue_date>2025-12-06T05:13:09.3294673+01:00</issue_date>
      <issued_by>sample string 27</issued_by>
      <issues_country>sample string 26</issues_country>
      <person_address>sample string 19</person_address>
      <person_address_type>sample string 18</person_address_type>
      <person_birth_date>2025-12-06T05:13:09.3294673+01:00</person_birth_date>
      <person_city>sample string 20</person_city>
      <person_country_code>sample string 22</person_country_code>
      <person_email>sample string 23</person_email>
      <person_first_name>sample string 6</person_first_name>
      <person_gender>sample string 8</person_gender>
      <person_id_number>sample string 12</person_id_number>
      <person_id_type>sample string 11</person_id_type>
      <person_issue_country>sample string 13</person_issue_country>
      <person_last_name>sample string 7</person_last_name>
      <person_nationality>sample string 14</person_nationality>
      <person_occupation>sample string 24</person_occupation>
      <person_passport_country>sample string 10</person_passport_country>
      <person_passport_number>sample string 9</person_passport_number>
      <person_phone_number>sample string 17</person_phone_number>
      <person_state>sample string 21</person_state>
      <person_tax_number>sample string 25</person_tax_number>
      <person_title>sample string 5</person_title>
      <person_tph_comm_type>sample string 16</person_tph_comm_type>
      <person_tph_contact_type>sample string 15</person_tph_contact_type>
      <person_type>sample string 3</person_type>
    </account_signatories_directors_uploads_model>
  </signatories>
</account_information_uploads_model>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP:200 for success else failure

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.