Welcome to Authz1 Knowledge Base
Limits Check Endpoint Request and Response
Request
Below is a sample Get request of the Authz1 Limits Check endpoint:
http://[host]:8080/v1/limits?subjectId=U000001&actionId=3&resourceId=A000000003&trxDateTime=2022-11-15T00:09:17-04:00&trxId=T2386685&trxAmount=100&unit=cadResponse
The response to the above request is:
{
"userId": "U000001",
"transactionId": "T2386685",
"transactionAmount": 100.0,
"unit": "cad",
"actionId": "3",
"passLimits": null,
"result": false,
"limits": [
{
"id": "L000000001",
"name": "TL1",
"type": "transactional",
"amount": 300.0,
"remainingAmount": 200.0,
"timePeriod": null,
"actionId": "3",
"resourceId": null,
"level": "Group",
"subjectId": "G000003",
"subjectName": "Group A3",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000027",
"name": "AL5",
"type": "aggregate_non_rolling",
"amount": 20000.0,
"remainingAmount": 19243.3701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000023",
"name": "AL1",
"type": "aggregate_rolling",
"amount": 10000.0,
"remainingAmount": 9231.7101,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000026",
"name": "AL4",
"type": "aggregate_non_rolling",
"amount": 18000.0,
"remainingAmount": 17648.9701,
"timePeriod": "w",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000006",
"subjectName": "Role A6",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000025",
"name": "AL3",
"type": "aggregate_non_rolling",
"amount": 15000.0,
"remainingAmount": 14648.9701,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000005",
"subjectName": "Role A5",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000024",
"name": "AL2",
"type": "aggregate_rolling",
"amount": 12000.0,
"remainingAmount": 11438.8701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Group",
"subjectId": "G000001",
"subjectName": "Group A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000028",
"name": "AL6",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9438.0701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000003",
"subjectName": "Role A3",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000029",
"name": "AL7",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9438.9701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000013",
"subjectName": "Role A13",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000030",
"name": "AL8",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9438.9701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000012",
"subjectName": "Role A12",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000032",
"name": "AL10",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9230.6101,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Global",
"subjectId": "U000001",
"subjectName": null,
"withinLimit": true,
"definedBy": "enterprise",
"effective": true
},
{
"id": "L000000016",
"name": "IL4",
"type": "individual_rolling",
"amount": 1000.0,
"remainingAmount": 784.37,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000002",
"subjectName": "Role A2",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000013",
"name": "IL1",
"type": "individual_rolling",
"amount": 4000.0,
"remainingAmount": 3574.37,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000046",
"name": "IL15",
"type": "individual_non_rolling",
"amount": 1500.0,
"remainingAmount": 1284.37,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Customer_CD",
"subjectId": "U000001",
"subjectName": null,
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000017",
"name": "IL5",
"type": "individual_non_rolling",
"amount": 2000.0,
"remainingAmount": 1784.37,
"timePeriod": "w",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000006",
"subjectName": "Role A6",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000020",
"name": "IL8",
"type": "individual_non_rolling",
"amount": 3500.0,
"remainingAmount": 3074.37,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000011",
"subjectName": "Role A11",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000034",
"name": "TL14",
"type": "transactional",
"amount": 500.0,
"remainingAmount": 400.0,
"timePeriod": null,
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000040",
"name": "AL12",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 2108.31,
"timePeriod": "w",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000039",
"name": "AL11",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 2076.03,
"timePeriod": "m",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000036",
"name": "IL11",
"type": "individual_rolling",
"amount": 3500.0,
"remainingAmount": -506.16,
"timePeriod": "m",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": false,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000037",
"name": "IL12",
"type": "individual_non_rolling",
"amount": 2500.0,
"remainingAmount": -1506.16,
"timePeriod": "w",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": false,
"definedBy": "customer",
"effective": true
}
]
}For detailed description of the request and response elements, please refer to Authz1 Limits API OpenAPI Spec (YAML).
For the business aspect description of the request and response of the Limits Check endpoint, please see the Limits Check Endpoint business description documentations.