groups

List groups

SecurityapiAuth

Request

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"label": "string",
"description": "string",
"icon": "http://example.com",
"tier": {"id": 0,
"level": 0,
"name": "string",
"description": "string",
"active": true,
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": null,
"currency": null,
"account_definition": null
}
]
},
"created": 0,
"updated": 0
},
"tiers": [{"id": 0,
"level": 0,
"name": "string",
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": null,
"name": null,
"label": null,
"tx_type": null
},
"currency": {"code": null,
"display_code": null,
"description": null,
"symbol": null,
"unit": null,
"divisibility": null,
"icon": null
},
"account_definition": {"name": null,
"label": null
}
}
]
},
"section": "system"
}
]
}
}

Retrieve group

SecurityapiAuth

Request

path Parameters

group_name

required

string^\w+$

Responses

200

get/3/groups/{group_name}/

Response samples

application/json

{"status": "success",
"data": {"name": "string",
"label": "string",
"description": "string",
"icon": "http://example.com",
"tier": {"id": 0,
"level": 0,
"name": "string",
"description": "string",
"active": true,
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account_definition": {"name": "string",
"label": "string"
}
}
]
},
"created": 0,
"updated": 0
},
"tiers": [{"id": 0,
"level": 0,
"name": "string",
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account_definition": {"name": "string",
"label": "string"
}
}
]
},
"section": "system"
}
}

List fees

SecurityapiAuth

Request

path Parameters

group_name

required

string^\w+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/fees/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
]
}
}

Retrieve fee

SecurityapiAuth

Request

path Parameters

fee_id required	string^\d+$
group_name required	string^\w+$

Responses

200

get/3/groups/{group_name}/fees/{fee_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
}

List permissions

SecurityapiAuth

Request

path Parameters

group_name

required

string^\w+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/permissions/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": {"property1": null,
"property2": null
}
}
]
}
}

Retrieve permission

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
permission_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/permissions/{permission_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": {"property1": null,
"property2": null
}
}
}

List tiers

SecurityapiAuth

Request

path Parameters

group_name

required

string^\w+$

query Parameters

active	boolean
level	integer
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
requirement	string

Responses

200

get/3/groups/{group_name}/tiers/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"level": 0,
"name": "string",
"description": "string",
"active": true,
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": null,
"name": null,
"label": null,
"tx_type": null
},
"currency": {"code": null,
"display_code": null,
"description": null,
"symbol": null,
"unit": null,
"divisibility": null,
"icon": null
},
"account_definition": {"name": null,
"label": null
}
}
]
},
"created": 0,
"updated": 0
}
]
}
}

Retrieve tier

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"level": 0,
"name": "string",
"description": "string",
"active": true,
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": 0,
"name": "string",
"label": "string",
"tx_type": "credit"
},
"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"account_definition": {"name": "string",
"label": "string"
}
}
]
},
"created": 0,
"updated": 0
}
}

List tier fees

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
tier_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/fees/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
]
}
}

Retrieve tier fee

SecurityapiAuth

Request

path Parameters

fee_id required	string^\d+$
group_name required	string^\w+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/fees/{fee_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
}

List tier limits

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
tier_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/limits/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
]
}
}

Retrieve tier limit

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
limit_id required	string^\d+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/limits/{limit_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
}

List tier requirement sets

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
tier_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirement-sets/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"parent": 0,
"name": "string",
"description": "string",
"condition": "all",
"min_condition_matches": 1,
"items": [{"id": 0,
"type": "resource",
"rule": {"resource": "address",
"condition": {"property1": null,
"property2": null
}
},
"name": "string",
"description": "string",
"weight": 2147483647,
"created": 0,
"updated": 0
}
],
"weight": 2147483647,
"created": 0,
"updated": 0
}
]
}
}

Retrieve tier requirement set

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
req_set_id required	string^\d+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirement-sets/{req_set_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"parent": 0,
"name": "string",
"description": "string",
"condition": "all",
"min_condition_matches": 1,
"items": [{"id": 0,
"type": "resource",
"rule": {"resource": "address",
"condition": {"property1": null,
"property2": null
}
},
"name": "string",
"description": "string",
"weight": 2147483647,
"created": 0,
"updated": 0
}
],
"weight": 2147483647,
"created": 0,
"updated": 0
}
}

List tier requirement set items

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
req_set_id required	string^\d+$
tier_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirement-sets/{req_set_id}/items/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"type": "resource",
"rule": {"resource": "address",
"condition": {"property1": null,
"property2": null
}
},
"name": "string",
"description": "string",
"weight": 2147483647,
"created": 0,
"updated": 0
}
]
}
}

Retrieve tier requirement set item

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
req_item_id required	string^\d+$
req_set_id required	string^\d+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirement-sets/{req_set_id}/items/{req_item_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "resource",
"rule": {"resource": "address",
"condition": {"property1": null,
"property2": null
}
},
"name": "string",
"description": "string",
"weight": 2147483647,
"created": 0,
"updated": 0
}
}

List tier requirementsDeprecated

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
tier_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirements/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
]
}
}

Retrieve tier requirementDeprecated

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
req_id required	string^\d+$
tier_id required	string^\d+$

Responses

200

get/3/groups/{group_name}/tiers/{tier_id}/requirements/{req_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"requirement": "first_name",
"label": "string"
}
}

➔ Next to metrics