Skip to content

Create member

This endpoint is used to create new members for various organisations, ultimately stored within the member database (COLMS).

Reference - COLMS Create member docs

Method and endpoint

POST /v1/member

Headers

Header name Header value
Authorization Basic base64(username:password)
Content-type application-json

Company

Within the body of the request message is a company field that requires the specification of the organisation the new member is being created for.

Company name Field value
AfriForum afriforum
AfriForum International afriforum-international
FAK fak
Voortrekker Monument vtm
Kaapse Forum kaapseforum
SAAI Suider-Afrika Agri Inisiatief (SAAI)

Body

Request schema 

{
  "company": "string",
  "broker": "string",
  "external_ref": "string",
  "policy_number": "string",
  "id_type": "SA ID",
  "id_passport_no": "string",
  "title": "string",
  "fullnames": "string",
  "nickname": "string",
  "surname": "string",
  "branch": "string",
  "gender": "string",
  "birthdate": "string",
  "language": "string",
  "marital_status": "string",
  "membership_type": "Personal",
  "delivery_requirements": "string",
  "electronic_newsletter": "string",
  "preferred_comms": "Email",
  "magazine": "string",
  "neighborhood_watch": "string",
  "agent": "string",
  "inception_date": "string",
  "products": [
    {
      "product_name": "string",
      "product_amount": "string",
      "product_branch": "string",
      "product_inceptiondate": "string",
      "product_sales_date": "string",
      "campaign": "string"
    }
  ],
  "payment_details": {
    "debit_agent_ref": "string",
    "payment_method": "Debit Order",
    "collection_method": "Bank EFT",
    "payment_frequency": "Once off",
    "payment_day": "string"
  },
  "payfor_details": {
    "payfor": true,
    "payfor_memberid": "string"
  },
  "bank_details": {
    "account_holder": "string",
    "id_number": "string",
    "bank": "string",
    "branch_code": "string",
    "account_type": "string",
    "account_number": "string"
  },
  "contact": {
    "email": "string",
    "alt_email": "string",
    "cellphone": "string",
    "telhome": "string",
    "telwork": "string"
  },
  "address": {
    "physical": {
      "physical_address": "string",
      "building": "string",
      "unit": "string",
      "suburb": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "postal_code": "string"
    },
    "postal": {
      "postal_address": "string",
      "building": "string",
      "unit": "string",
      "suburb": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "postal_code": "string"
    }
  }
}
Sample request 
{
    "company": "afriforum",
    "broker": "CMO",
    "external_ref": "36ec733f7ccc497187d7503aace6f514",
    "policy_number": null,
    "id_type": "SA ID",
    "id_passport_no": "1234567890123",
    "title": "Mnr",
    "fullnames": "Johannes Marais",
    "nickname": "Johannes",
    "surname": "Marais",
    "branch": "Edenvale",
    "gender": "Male",
    "birthdate": "1999-08-06",
    "language": "English",
    "marital_status": "Single",
    "membership_type": "Personal",
    "delivery_requirements": "Physical_address",
    "electronic_newsletter": "English",
    "preferred_comms": "Email",
    "magazine": "None",
    "neighborhood_watch": null,
    "agent": null,
    "inception_date": "2024-03-04",
    "products":
    [
        {
            "product_name": "AfriForum Contribution",
            "product_amount": "100",
            "product_branch": "Edenvale",
            "product_inceptiondate": "2024-03-04",
            "product_sales_date": "2024-02-24",
            "campaign": null
        }
    ],
    "payment_details":
    {
        "debit_agent_ref": "36ec733f7ccc497187d7503aace6f514",
        "payment_method": "Debit Order",
        "collection_method": "EFT",
        "payment_frequency": "Monthly",
        "payment_day": "4"
    },
    "payfor_details":
    {
        "payfor": false,
        "payfor_memberid": ""
    },
    "bank_details":
    {
        "account_holder": "JH Marais",
        "id_number": "1234567890123",
        "bank": "Capitec Bank",
        "branch_code": "12345",
        "account_type": "Savings",
        "account_number": "0987654321"
    },
    "contact":
    {
        "email": "email@gmail.com",
        "alt_email": "",
        "cellphone": "1234567890",
        "telhome": "",
        "telwork": ""
    },
    "address":
    {
        "physical":
        {
            "physical_address": "123 Heya cresent",
            "building": "",
            "unit": "Ext7",
            "suburb": "Edenglen ",
            "city": "Edenvale",
            "province": "Gauteng",
            "country": "South Africa",
            "postal_code": "0000"
        },
        "postal":
        {
            "postal_address": "123 Heya cresent",
            "building": "",
            "unit": "Ext7",
            "suburb": "Edenglen",
            "city": "Edenvale",
            "province": "Gauteng",
            "country": "South Africa",
            "postal_code": "0000"
        }
    }
}

Sample response 

{
    "result": true,
    "membership_number": "630009694",
    "reference_no": "000000000079337",
    "message": "member info received successfully"
}