Apiconsumer
Represents an API consumer.
access object
Represents the API consumer permissions and access rights.
TRUE if the API consumer has the administrator user type, FALSE otherwise. Administrators (admins) have all permissions and can perform any action in Mambu.
TRUE if the API consumer can authenticate and interact with Mambu APIs, FALSE otherwise. The API consumer may still require additional permissions for specific API requests.
TRUE if the API consumer permissions apply to all branches, FALSE if they only apply to specific branches.
TRUE if the API consumer (that has the credit officer access) can access entities (for example, clients or accounts) assigned to other credit officers, FALSE otherwise.
TRUE if the API consumer has the credit officer user type, FALSE otherwise. Credit officers have the option of having clients and groups assigned to them.
managedBranches object[]
The list of branches that can be managed by the API consumer. If the API consumer has the canManageAllBranches property set to TRUE, this list does not apply.
The encoded key of the branch, it is automatically generated.
Permissions for the API consumer. The non-admin API consumers and users are authorized to do actions based a set of permissions in order to access Mambu features. Permissions may be relevant for the API and/or the Mambu UI.
Possible values: [AUDIT_TRANSACTIONS, VIEW_EXCHANGE_RATES, CREATE_EXCHANGE_RATE, VIEW_LOAN_ACCOUNT_DETAILS, CREATE_LOAN_ACCOUNT, EDIT_LOAN_ACCOUNT, APPROVE_LOANS, DIBURSE_LOANS, APPLY_LOAN_FEES, ENTER_REPAYMENT, EDIT_PLANNED_FEES, EDIT_REPAYMENT_SCHEDULE, APPLY_LOAN_ADJUSTMENTS, BACKDATE_LOAN_TRANSACTIONS, APPLY_ACCRUED_LOAN_INTEREST, POST_TRANSACTIONS_ON_LOCKED_LOAN_ACCOUNTS, EDIT_PENALTY_RATE, VIEW_INVESTOR_FUNDS_DETAILS, CREATE_INVESTOR_FUNDS, EDIT_INVESTOR_FUNDS, DELETE_INVESTOR_FUNDS, SELL_LOAN_FRACTION, REQUEST_LOAN_APPROVAL, EDIT_LOAN_TRANCHES, REJECT_LOANS, WRITE_OFF_LOAN_ACCOUNTS, PAY_OFF_LOAN, REVERSE_LOAN_ACCOUNT_WRITE_OFF, CLOSE_LOAN_ACCOUNTS, LOCK_LOAN_ACCOUNTS, WITHDRAW_LOAN_ACCOUNTS, DELETE_LOAN_ACCOUNT, SET_DISBURSEMENT_CONDITIONS, RESCHEDULE_LOAN_ACCOUNT, REFINANCE_LOAN_ACCOUNT, EDIT_LOAN_TRANSACTIONS, BULK_LOAN_CORRECTIONS, EDIT_INTEREST_RATE, EDIT_REPAYMENT_METHOD_VALUE, EDIT_PERIODIC_PAYMENT_FOR_ACTIVE_ACCOUNT, UNDO_LOAN_ACCOUNT_CLOSURE, UNDO_REJECT_LOANS, UNDO_WITHDRAW_LOAN_ACCOUNTS, LINK_ACCOUNTS, EDIT_PRINCIPAL_PAYMENT_ACTIVE_REVOLVING_CREDIT, PERFORM_REPAYMENTS_WITH_CUSTOM_AMOUNTS_ALLOCATION, MANAGE_LOAN_ASSOCIATION, MAKE_WITHDRAWAL_REDRAW, ENTER_REFUND, EDIT_FEE_RATE, CREDIT_BALANCE_DEPOSIT, VIEW_SAVINGS_ACCOUNT_DETAILS, CREATE_SAVINGS_ACCOUNT, EDIT_SAVINGS_ACCOUNT, APPROVE_SAVINGS, MAKE_DEPOSIT, MAKE_BULK_DEPOSITS, MAKE_WITHDRAWAL, BACKDATE_SAVINGS_TRANSACTIONS, APPLY_SAVINGS_ADJUSTMENTS, MAKE_TRANSFER, MAKE_INTER_CLIENTS_TRANSFERS, CLOSE_SAVINGS_ACCOUNTS, REOPEN_SAVINGS_ACCOUNT, APPLY_SAVINGS_FEES, DELETE_SAVINGS_ACCOUNT, POST_TRANSACTIONS_ON_DORMANT_ACCOUNTS, EDIT_SAVINGS_TRANSACTIONS, BULK_DEPOSIT_CORRECTIONS, ACTIVATE_MATURITY, APPLY_ACCRUED_SAVINGS_INTEREST, LOCK_SAVINGS_ACCOUNT, UNLOCK_SAVINGS_ACCOUNT, UNDO_MATURITY, MAKE_EARLY_WITHDRAWALS, BLOCK_AND_SEIZE_FUNDS, WITHDRAW_BLOCKED_FUNDS, MAKE_BULK_CHANGE_INTEREST_AVAILABILITY, MANAGE_DEPOSIT_ACCOUNT_RECIPIENT, MANAGE_DEPOSIT_ASSOCIATION, BYPASS_ACCOUNT_OWNERSHIP_TRANSFER_VIEW_RESTRICTION, CREATE_CARDS, VIEW_CARDS, DELETE_CARDS, REVERSE_CARD_WITHDRAWAL_TRANSACTION, CARD_BALANCE_INQUIRY, CREATE_AUTHORIZATION_HOLD, UPDATE_AUTHORIZATION_HOLD, VIEW_AUTHORIZATION_HOLD, CREATE_CARD_TRANSACTION, CREATE_ACCOUNT_HOLD, UPDATE_ACCOUNT_HOLD, VIEW_ACCOUNT_HOLD, VIEW_SECURITIES_DETAILS, CREATE_SECURITIES, EDIT_SECURITIES, DELETE_SECURITIES, CREATE_LINES_OF_CREDIT, EDIT_LINES_OF_CREDIT, VIEW_LINE_OF_CREDIT_DETAILS, ADD_ACCOUNTS_TO_LINE_OF_CREDIT, REMOVE_ACCOUNTS_FROM_LINE_OF_CREDIT, APPROVE_LINE_OF_CREDIT, UNDO_APPROVE_LINE_OF_CREDIT, WITHDRAW_LINE_OF_CREDIT, UNDO_WITHDRAW_LINE_OF_CREDIT, REJECT_LINE_OF_CREDIT, UNDO_REJECT_LINE_OF_CREDIT, CLOSE_LINES_OF_CREDIT, DELETE_LINES_OF_CREDIT, VIEW_LOAN_PRODUCT_DETAILS, CREATE_LOAN_PRODUCT, DELETE_LOAN_PRODUCTS, EDIT_LOAN_PRODUCT, VIEW_SAVINGS_PRODUCT_DETAILS, CREATE_SAVINGS_PRODUCT, EDIT_SAVINGS_PRODUCT, DELETE_SAVINGS_PRODUCT, VIEW_CLIENT_DETAILS, CREATE_CLIENT, EDIT_CLIENT, DELETE_CLIENTS, VIEW_GROUP_DETAILS, CREATE_GROUP, EDIT_GROUP, DELETE_GROUP, CHANGE_CLIENT_TYPE, CHANGE_GROUP_TYPE, APPROVE_CLIENT, REJECT_CLIENT, EXIT_CLIENT, BLACKLIST_CLIENT, UNDO_CLIENT_STATE_CHANGED, ANONYMIZE_CLIENT, MANAGE_CLIENT_ASSOCIATION, MANAGE_GROUP_ASSOCIATION, EDIT_CLIENT_ID, EDIT_GROUP_ID, EDIT_BLACKLISTED_CLIENT_CFV, VIEW_ACCOUNTING_REPORTS, LOG_JOURNAL_ENTRIES, BOOKING_DATE_LOANS_GL, BOOKING_DATE_SAVINGS_GL, RECTIFY_ADJUSTMENT, VIEW_ACCOUNTING_RATES, CREATE_ACCOUNTING_RATES, VIEW_DOCUMENTS, CREATE_DOCUMENTS, EDIT_DOCUMENTS, DELETE_DOCUMENTS, VIEW_TASK, CREATE_TASK, EDIT_TASK, DELETE_TASK, VIEW_USER_DETAILS, CREATE_USER, EDIT_USER, DELETE_USER, VIEW_ROLE, CREATE_ROLE, EDIT_ROLE, DELETE_ROLE, RESEND_FAILED_MESSAGES, SEND_MANUAL_SMS, SEND_MANUAL_EMAIL, GET_MANAGE_CONFIGURATION_AS_CODE, PUT_MANAGE_CONFIGURATION_AS_CODE, MANAGE_RISK_LEVELS, MANAGE_EOD_PROCESSING, MANAGE_CURRENCIES, VIEW_INTELLIGENCE, CREATE_INDEX_RATE, VIEW_COMMENTS, CREATE_COMMENTS, EDIT_COMMENTS, VIEW_COMMUNICATION_HISTORY, DOWNLOAD_BACKUPS, IMPORT_DATA, VIEW_TRANSACTION_CHANNELS, CREATE_TRANSACTION_CHANNELS, EDIT_TRANSACTION_CHANNELS, DELETE_TRANSACTION_CHANNELS, POST_TRANSACTIONS_WITHOUT_OPENED_TILL, VIEW_CUSTOM_FIELD, VIEW_BRANCH_DETAILS, CREATE_BRANCH, EDIT_BRANCH, VIEW_CENTRE_DETAILS, CREATE_CENTRE, EDIT_CENTRE, DELETE_CENTRE, MANAGE_HOLIDAYS, MANAGE_INDEX_RATES, MANAGE_EVENTS_STREAMING, MANAGE_AUDIT_TRAIL, MANAGE_PAYMENTS, MANAGE_CARDS_CAPABILITY, CREATE_API_CONSUMERS_AND_KEYS, DELETE_API_CONSUMERS_AND_KEYS, EDIT_API_CONSUMERS_AND_KEYS, VIEW_API_CONSUMERS_AND_KEYS, MANAGE_NOTIFICATIONS, VIEW_MAMBU_FUNCTIONS, CREATE_MAMBU_FUNCTIONS, EDIT_MAMBU_FUNCTIONS, DELETE_MAMBU_FUNCTIONS, VIEW_MAMBU_FUNCTIONS_SECRETS, CREATE_MAMBU_FUNCTIONS_SECRETS, EDIT_MAMBU_FUNCTIONS_SECRETS, DELETE_MAMBU_FUNCTIONS_SECRETS, VIEW_PROFIT_SHARING_PROPOSALS, CREATE_PROFIT_SHARING_CASH_FLOWS, VIEW_PROFIT_SHARING_CASH_FLOWS, EDIT_PROFIT_SHARING_CASH_FLOWS, DELETE_PROFIT_SHARING_CASH_FLOWS, CREATE_PROFIT_SHARING_POOLS, VIEW_PROFIT_SHARING_POOLS, EDIT_PROFIT_SHARING_POOLS, DELETE_PROFIT_SHARING_POOLS, CREATE_PROFIT_SHARING_PRODUCT_SETTINGS, VIEW_PROFIT_SHARING_PRODUCT_SETTINGS, EDIT_PROFIT_SHARING_PRODUCT_SETTINGS, DELETE_PROFIT_SHARING_PRODUCT_SETTINGS, CREATE_RATE_SHEET, VIEW_RATE_SHEET]
The encoded key of the branch this API consumer is assigned to.
The date when the API consumer was created in UTC.
2016-09-06T13:37:50+03:00The encoded key of the entity, generated, globally unique
The ID of the API consumer.
The last time the API consumer was modified in UTC.
2016-09-06T13:37:50+03:00The API consumer name.
role object
Represents the role identifier.
The encoded key of the entity, generated automatically, globally unique.
The ID of the role, which can be generated and customized, but must be unique.
transactionLimits object
The API consumer transaction limits.
The API consumer transaction limits.
{
"access": {
"administratorAccess": true,
"apiAccess": true,
"canManageAllBranches": true,
"canManageEntitiesAssignedToOtherOfficers": true,
"creditOfficerAccess": true,
"managedBranches": [
{
"branchKey": "string"
}
],
"permissions": [
"AUDIT_TRANSACTIONS"
]
},
"assignedBranchKey": "string",
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"id": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"role": {
"encodedKey": "string",
"id": "string"
},
"transactionLimits": {}
}