Info

Welcome to the generated API reference. Get Postman Collection

Authentication

API documentation for Authenticating and retreiving a bearer token. client_id, client_secret, username and password for authenication will be provided by MPAO. For any enquiries drop us an email at [email protected].

Requesting Tokens

You may request an access token by issuing a POST request to the /oauth/token route with the following parameters

Example request:

curl -X GET -G "https://auth.pension.gov.mv/oauth/token" \
    -H "Content-Type: application/json" \
    -d '{"grant_type":"Pe9kdtnP8PRiJLAQ","client_id":"KoHfrACZrXSJaq0K","client_secret":"29tlW30xEBjMydOx","username":"v40wqbsaEiWh1PRO","password":"CIw3M41FJnz7c4Dz","scope":"S3NjAX6cNNOmLpp2"}'

const url = new URL("https://auth.pension.gov.mv/oauth/token");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "grant_type": "Pe9kdtnP8PRiJLAQ",
    "client_id": "KoHfrACZrXSJaq0K",
    "client_secret": "29tlW30xEBjMydOx",
    "username": "v40wqbsaEiWh1PRO",
    "password": "CIw3M41FJnz7c4Dz",
    "scope": "S3NjAX6cNNOmLpp2"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "token_type": "Bearer",
    "expires_in": 28800,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjAzZjRlZjE0NjE3ZjU3ZDY1ODc3YWE5ZjY0ZmFmYmJjZWRjMGFlNDE0MGFjMWE3NmY5OTRhY2E2MGFhZDcwZTJkZjg4Y2VlZGJlMWI4OWI4In0.eyJhdWQiOiIzIiwianRpIjoiMDNmNGVmMTQ2MTdmNTdkNjU4NzdhYTlmNjRmYWZiYmNlZGMwYWU0MTQwYWMxYTc2Zjk5NGFjYTYwYWFkNzBlMmRmODhjZWVkYmUxYjg5YjgiLCJpYXQiOjE1NTMwMTMwMzEsIm5iZiI6MTU1MzAxMzAzMSwiZXhwIjoxNTUzMDQxODMxLCJzdWIiOiIxOTM4ODQiLCJzY29wZXMiOlsiKiJdfQ.xXwRPkB9qFNtsam5ZPTO4vQpDmE2HkjxxTYv1pjRNDr_RlxYBn0rvnnKN-nWra3kfTSsEA1PEdl7ipaMqmKUp6bRkzNhyeKIdbDETX9DhCQs34tJJ0578S8TXnyuJdqbjTn7XvZE48B8dU5qLP7kmjwoAT5JBjXzRj1a5vzPvu5MB9eqSVDR6_XP1gxVXFVkCUu7_wtSAvD1IUnVn6UWceo4MrNwK__vC_TeDba0XWt_ALrTaX_u1-eOwKzoY4MUOTkWLt7SMbhb6N_uv9fD5N44JR4Ej_rNPxAxdhcJyxhUuFuGtIzIuw3T-8fAcgm9LD3Rav5EhZZ6FC2yCUkEPYm9r4ZQrl0mFOtkGaR7u443WaKgMARqFCyhiIvR5ZI_R89zir5Uyb1pDrlvRdTsow3CpCh0-mYwvGVSI5Wbq4qAEs6JTp-qmzxDua5KCe_MpKZt5JK3t7AD8IUZ6oU0LpoAjzxlZKSo4vW4AIq4XXRlZJqvDgpjb-RgaztOIDOO9V_GvCwUMyDEjAps4fOFNMXk34knA4gfIPocb_6gzjMetGC0Sas3lPAPMmVswXspTCV-uV-OULjPw645vA2zeyTt4q0OonKU-msh6SEw4ModtrMzfSEkPdhCSuYBU6X0oklQjLHp6E24OMNta41-ib0M3b0KuVW05S9dOy_EF3o",
    "refresh_token": "def50200fd16f6f9c5d3dcc8243a8d8caf5d81c6aae3a32dbec377b6f7ee91f9913dde1423d87aa4346b7e65ef10030348e3f7b0f21321dbc9f2f9a329f2a9132013dc9c561fbf00065e8cf6e2fea8e77600f04793bda44e2798299a1e7fcc852fb30bef11654de888d49baa01edbb458b33754366741d0effe7648861f62947ca0916290b29c4a31e88cba394daec04e8d447074388c4af31fa68e715792c515b46ef0bcdedf05cb2638f7be77b89f9dfe87c17c87e77e3cb79b52a1ab21d493f6bb5656330739636580ec5564072446cca7589fb3ef1ba2954a361126ab8c83cea2e63763303b74a7710a7156d7a76250bbba2f4e2149502f7581219564e04407da825acaa5e97fa40eb0c915473e8d86457f0bf8f8a6468f4548dab5f8fb880edc5e10c0db4a39e1ec88a83b3e3200e15dce01117eaa08bd29dcc75f8ffdff81942ebe29df23d38908d988ea05d197ae024f529d14fce9db460ba53fe9915326b1637e141222e30"
}

HTTP Request

GET https://auth.pension.gov.mv/oauth/token

Body Parameters

Parameter	Type	Status	Description
grant_type	string	optional	required. grant_type should be 'password'
client_id	string	required	The client id provided by MPAO.
client_secret	string	required	The client secret provided by MPAO.
username	string	required	The username provided by MPAO.
password	string	required	The password provided by MPAO.
scope	string	optional	optional Requesting Scopes. By default all scopes are granted.

Refreshing Tokens

You may refresh an access token by issuing a POST request to the /oauth/token route with the following parameters

Example request:

curl -X GET -G "https://auth.pension.gov.mv/oauth/token/refresh" \
    -H "Content-Type: application/json" \
    -d '{"grant_type":"pLdzMDjbF81Y0tF0","client_id":"bgQrdbhPyg8WXJUw","client_secret":"b2xw5ds1lhhz5sYz","refresh_token":"PzMIYKso8UkmIYnf"}'

const url = new URL("https://auth.pension.gov.mv/oauth/token/refresh");

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "grant_type": "pLdzMDjbF81Y0tF0",
    "client_id": "bgQrdbhPyg8WXJUw",
    "client_secret": "b2xw5ds1lhhz5sYz",
    "refresh_token": "PzMIYKso8UkmIYnf"
}

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "token_type": "Bearer",
    "expires_in": 28800,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjQyYmIwYTBjOTIyNWQ1OWU2ZjU4ZDM4MDcxOTVmNjEwZDg1ZjE0MGRjY2JlZjg0YjYzYjBmMjRhZjVkY2I0NDZmNTAyMmNkOGJjOWM3ZWEzIn0.eyJhdWQiOiIzIiwianRpIjoiNDJiYjBhMGM5MjI1ZDU5ZTZmNThkMzgwNzE5NWY2MTBkODVmMTQwZGNjYmVmODRiNjNiMGYyNGFmNWRjYjQ0NmY1MDIyY2Q4YmM5YzdlYTMiLCJpYXQiOjE1NTMwMTMxNTYsIm5iZiI6MTU1MzAxMzE1NiwiZXhwIjoxNTUzMDQxOTU2LCJzdWIiOiIxOTM4ODQiLCJzY29wZXMiOlsiKiJdfQ.sO68pH_7L9KnM3Xxw2vwGj5QjYFwP9ejOLvjGDhv-biBPXguPQ917Oj8vnbzt8ey6tZiPxc9sXHrgYeG1-iq5w2r6ku313pHmkphZ2D4-lv2hrASAFDyTNNQvVn0uY2phhZMZwK2hqJgjRbo1wB5UH4UHv5Y5DOEDRLme8i5XCTdfEeO697i1b6oclpX-PICfJI0FL0u29nQtkurzxeEaxX_lRHAv8n4xTCuYwZeXsut2J7C0Fl7bvpkXMfSF_yH1s9zfYKtDNsQaNmmMfY3-RE9ZuRd_SQ5j8wou8xwbvcO08CCtQWeUzfvdERjlkbdv5dciXG8qMobazCvaH3X3ciOIm8hxG9K3RKbRUVlP51viSzAW-BT5npwpLhRRuo3QS-jJlMEDj4XcIIMlt7_fw8rvUGZdwQ0FWPZxieJ6dX1HarFxADJgmeiJvsdq8Mjqf_YSQVx_5pvPNETo-Hv9YCiOH25CAH0JZC_UUGsjqLdYi18ESMyo2qdSZOdQJNB-aoTzBcyap2RjsV0YXt4EPbUp19YlQq-sopeJteXM5-poZHZoY8KPk4FIjIM-IxGR2Kcp3eOC7uaeQk7DN8OwCna512CcD-OBk7NF_bNr6WpDniRwGZoJ3O9egYrVg9Vv8R301zA2xkfxtSCC3l8S69Y5pVs0uWdi9VTNpQ-LjM",
    "refresh_token": "def5020083106914b3be364cd4ce4bc2da9e2106c7b10cb1d77e0472e8ec10eaa78d3d28931fc0dab948901949e9f58125b6259077ed5cc7c8bc48c2afe87afe4964e4311a25c95486f34fe52c84c77c7988a3175a74937d1ede2f8856930f18836390054896fdde2885f9b32696c38c9e5c5df59372ab2e0a8eae55ba2cb1ff916fb6d790e1eafa480ffedbc297c220bb70191a8c1522d87ae5bc6e578c69bd035567972a54e56b97864f5e64e33f68b6252c4ff113bad6c585f84e9c8ba44e33e10de640ba0ee5fef3c4d29c6764b72340866b618a90199ebe37409c71134743c8e8c98dfe795bb1a3f3bb433bc01720208ef9c12ab407446bae84ff9c2329e01ec82933ec10fdc80fd0a4960046f4447868ec9705181eacdbcc587fbbf86a560d7455f9fa1712a374ef585b26ecfe25ddb8fb621b9aeb84a6b3978f8cc1c2e7483d1a1a3b151613c2350ac27a685dcadc739a0acc0c01f1dc164b156b4fe5c564fcc5aa8cab1f3f"
}

HTTP Request

GET https://auth.pension.gov.mv/oauth/token/refresh

Body Parameters

Parameter	Type	Status	Description
grant_type	string	optional	required. grant_type should be 'refresh_token'
client_id	string	required	The client id provided by MPAO.
client_secret	string	required	The client secret provided by MPAO.
refresh_token	string	required	The username provided by MPAO.

Benefits

APIs to interact with Benefits

Hajj Eligibility

Requires authentication Retrieve an individuals's hajj eligibility.

Example request:

curl -X POST "http://public-api.pension.test/api/v1/hajj-eligibility?nic=laborum" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/hajj-eligibility");

    let params = {
            "nic": "laborum",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "nic": "A0X0X0X",
        "eligible": true
    }
]

HTTP Request

POST api/v1/hajj-eligibility

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.

Employment

APIs to interact with Employment

Active Employment

Requires authentication Retrieve an individuals current active employments.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/active-employment" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/active-employment");

    let params = {
            "nic": "Bk9MBl6wPYK6e87c",
            "dob": "hpatvsN13ca5CZJg",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "identifier": "A0X0X0X",
        "birth_date": "1985-09-14",
        "name": "John Doe",
        "commencing_date": "2015-01-01",
        "termination_date": null,
        "basic_salary": "11000.00",
        "employer_name": "Anti-Corruption commission"
    }
]

HTTP Request

GET api/v1/active-employment

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.
dob	required	DOB of the Individual.

Employment History

Requires authentication Retrieve an individuals employment history.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/employment-history" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/employment-history");

    let params = {
            "nic": "AFkAzsKW1j22PI4d",
            "dob": "nZnPpvNODcj6jVem",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "identifier": "A0X0X0X",
        "name": "Jon Doe",
        "commencing_date": "2015-01-01",
        "termination_date": null,
        "basic_salary": "11000.00",
        "employer_name": "Anti-Corruption commission",
        "employment_status": "Active"
    },
    {
        "identifier": "A0X0X0X",
        "name": "Jon Doe",
        "commencing_date": "2012-04-04",
        "termination_date": "2014-12-31",
        "basic_salary": "7035.00",
        "employer_name": "Department Of Judicial Administration",
        "employment_status": "Terminated"
    },
    {
        "identifier": "A0X0X0X",
        "name": "Jon Doe",
        "commencing_date": "2011-06-13",
        "termination_date": "2012-04-04",
        "basic_salary": "7035.00",
        "employer_name": "High court of Maldives",
        "employment_status": "Terminated"
    }
]

HTTP Request

GET api/v1/employment-history

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.
dob	required	DOB of the Individual.

Last Contribution

Requires authentication Retrieve an individuals latest contribution month.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/last-contribution" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/last-contribution");

    let params = {
            "nic": "QTCYHazt97tJT7Wb",
            "dob": "JtJDESOS4ixkqOo7",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "identifier": "A0X0X0X",
        "birthDate": "1985-09-14",
        "employer_name": "Maldives Pension Administration Office",
        "last_contribution_month": "2018-11"
    }
]

HTTP Request

GET api/v1/last-contribution

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.
dob	required	DOB of the Individual.

Employment Status

Requires authentication Retrieve an individuals's employment status.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/employment-status?nic=excepturi" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/employment-status");

    let params = {
            "nic": "excepturi",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "nic": "A0X00X",
    "employment-record": [
        {
            "identifier": "A0X00X",
            "birth_date": "1900-01-01",
            "name": "John Doe",
            "commencing_date": "2020-01-01",
            "termination_date": null,
            "basic_salary": "10000.00",
            "employer_name": "Maldives Pension Administration Office"
        }
    ]
}

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/employment-status

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.

Employment Report

Requires authentication Retrieve an individuals's last contribution

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/employment-reports?nic=aliquid" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/employment-reports");

    let params = {
            "nic": "aliquid",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "from_date": "2020-01-01",
        "to_date": "2020-12-21",
        "identifier": "A0X0X0X",
        "commencing_date": "2015-01-01",
        "termination_date": null,
        "employer": "Maldives Pension Administration Office",
        "employment_status": "Active",
        "zero_contribution_months": [
            "yyyyMM",
            "yyyyMM"
        ],
        "last_contribution_month": "2017-01"
    }
]

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/employment-reports

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.

Search employers

Requires authentication Retrieve an individuals current active employments.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/employers/search?query=ullam" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/employers/search");

    let params = {
            "query": "ullam",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "employer_id": "99999999",
        "name": "Maldives Pension Administration Office"
    }
]

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/employers/search

Query Parameters

Parameter	Status	Description
query	optional	search term

Employee Count

Requires authentication Retrieve number of active employees

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/employers/employee-count?employer_id=minus" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/employers/employee-count");

    let params = {
            "employer_id": "minus",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "EmployerName": "Maldives Pension Administration Office",
    "CurrentEmployees": "99",
    "HasMoreThan30": true
}

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/employers/employee-count

Query Parameters

Parameter	Status	Description
employer_id	required	employer_id of the organisation.

Forms

APIs to interact with Forms

Form Submission Status

Requires authentication Retrieve an forms's submission status.

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/form-status?form_id=6&reference_number=20" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/form-status");

    let params = {
            "form_id": "6",
            "reference_number": "20",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "reference_number": "MPAO\/SCN-001\/2019\/8",
    "status": "Completed",
    "form_id": 14
}

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/form-status

Query Parameters

Parameter	Status	Description
form_id	required	Form Identification number.
reference_number	required	Form's reference number that was generated after submission.

Form Submission Status

Requires authentication Retrieve an forms's submission status.

Example request:

curl -X POST "http://public-api.pension.test/api/v1/form-status?form_id=14&reference_number=17" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/form-status");

    let params = {
            "form_id": "14",
            "reference_number": "17",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "reference_number": "MPAO\/SCN-001\/2019\/8",
    "status": "Completed",
    "form_id": 14
}

HTTP Request

POST api/v1/form-status

Query Parameters

Parameter	Status	Description
form_id	required	Form Identification number.
reference_number	required	Form's reference number that was generated after submission.

Members

APIs to interact with Members

Member contributions

Requires authentication Retrieve an individuals's contribution history

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/members/contributions?nic=mollitia&no-cache=quae&no-page=sapiente" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/members/contributions");

    let params = {
            "nic": "mollitia",
            "no-cache": "quae",
            "no-page": "sapiente",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "current_page": 1,
    "data": [
        {
            "Identifier": "A0X0X0X",
            "Employer Name": "Employer Name",
            "Contribution Month": "202101"
        }
    ]
}

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/members/contributions

Query Parameters

Parameter	Status	Description
nic	required	NIC of the individual.
no-cache	optional	optional prevents system cache.
no-page	optional	optional, prevents paging results, discouraged

Member RSA summary

Requires authentication Retrieve member rsa summary when an Identifier is provided

Example request:

curl -X GET -G "http://public-api.pension.test/api/v1/members/rsa-summary?identifier=ipsum&date_of_birth=non&no-cache=veniam" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://public-api.pension.test/api/v1/members/rsa-summary");

    let params = {
            "identifier": "ipsum",
            "date_of_birth": "non",
            "no-cache": "veniam",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "NIC": "A0X00X",
    "Date of birth": "01-01-1900",
    "RSA": {
        "investment_gain_loss": "50000.01",
        "closing_balance": "10000.00",
        "valuation_date": "05-05-2020"
    },
    "Benefits": {
        "total_balance": "10000.00",
        "pending_balance": null,
        "collateralizable": ".00",
        "collateral_value": ".00",
        "collateralizable_percent": 100,
        "hajju_eligible_value": "1000.00",
        "hajju_value": ".00"
    }
}

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/v1/members/rsa-summary

Query Parameters

Parameter	Status	Description
identifier	required	identifier of the individual (nic for locals and passport for foreigners).
date_of_birth	required	birth date fo the individual
no-cache	optional	optional ignores system cached data.

Errors

The API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Bad Request
401	Unauthorized -- Requires authentication / API key is invalid.
403	Forbidden -- Your application is not authorized to access the resource
404	Not Found -- The specified kitten could not be found
405	Method Not Allowed -- You tried to access a kitten with an invalid method
406	Not Acceptable -- You requested a format that isn't json
410	Gone -- The kitten requested has been removed from our servers
418	I'm a teapot
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarially offline for maintanance. Please try again later.