The available scopes below describe what endpoints are available to each API scope. It is worth mentioning that these may change as future development takes place. When making a call to an endpoint an API scope does not have access to, an unauthorized response is expected.

Deposit API Access

v1/customers GET
v1/customers/beneficial-owners GET
v1/customer-contacts/role-options
v1/customer-contacts GET
v1/document-associations POST
v1/document-associations GET
v1/document-folders GET
v1/documents POST
v1/documents GET
v1/documents/{id:int}/content

Appraisals API Access

v1/customers GET
v1/customer-contacts/role-options
v1/customer-contacts GET
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/collaterals PATCH
v1/document-associations POST
v1/document-associations GET
v1/document-folders GET
v1/documents POST
v1/documents DELETE
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/documents/{id:int}/content
v1/proposed-liens GET
v1/liens GET

Loan Boarding API Access

v1/customers GET
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/loan-originations
v1/proposed-loan-file

Construction Vendor API Access

v1/customers GET
v1/customers/beneficial-owners GET
v1/customer-contacts/role-options
v1/customer-contacts GET
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/document-associations POST
v1/document-associations GET
v1/document-folders GET
v1/document-folders POST
v1/documents POST
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/events
v1/proposed-liens GET
v1/liens GET

Decisioning API Access

v1/customers GET
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/document-associations PATCH
v1/document-associations GET
v1/document-folders GET
v1/document-folders POST
v1/document-folders PATCH
v1/documents POST
v1/documents PATCH
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/documents/{id:int}/content
v1/proposed-liens GET
v1/liens GET
v2/business-financials GET
v1/financial-information
v1/loan-application-proposed-loan-mappings GET
v1/loan-applications GET
v1/loan-roles/by-proposed-loan-id/{proposedLoanId:int}
v1/loan-roles/by-portfolio-loan-Id/{portfolioLoanId:int}
v1/industry-data
v1/sector-codes
v1/entities GET
v1/entity-group-summary GET
v1/charm-loan-score

CRM API Access

v1/customers GET
v1/customers POST
v1/customers PATCH
v1/customers DELETE
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/proposed-loans POST
v1/proposed-loans PATCH
v1/proposed-loans DELETE
v1/proposed-liens GET
v1/liens GET

Document API Access

v1/customers GET
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/document-associations POST
v1/document-associations PATCH
v1/document-associations GET
v1/document-folders GET
v1/document-folders POST
v1/document-folders PATCH
v1/documents POST
v1/documents DELETE
v1/documents PATCH
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information

Loan App Document API Access

Workflow Automation API Access

v1/customers GET
v1/customers POST
v1/customers PATCH
v1/customers DELETE
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/collaterals PATCH
v1/collaterals POST
v1/collaterals DELETE
v1/document-associations POST
v1/document-associations DELETE
v1/document-associations PATCH
v1/document-associations GET
v1/documents POST
v1/documents DELETE
v1/documents PATCH
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/portfolio-loans POST
v1/portfolio-loans PATCH
v1/portfolio-loans DELETE
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/proposed-loans POST
v1/proposed-loans PATCH
v1/proposed-loans DELETE
v1/workflows
v1/workflow-loan-mappings
v1/workflow-next-steps
v1/workflow-phases
v1/workflow-reason-option
v1/workflow-reason-option-mapping
v1/workflow-role-settings
v1/workflow-role-user-settings
v1/workflow-steps
v1/workflow-step-list-items
v1/workflow-step-owner-mappings
v1/workflow-templates
v1/workflow-template-phases

Collateral API Access

v1/customers GET
v1/customers PATCH
v1/collaterals GET
v1/collaterals/basic-information
v1/portfolio-loans/{id:int}/collaterals
v1/collaterals PATCH
v1/document-associations POST
v1/document-associations DELETE
v1/document-associations PATCH
v1/document-associations GET
v1/document-folders GET
v1/document-folders POST
v1/document-folders PATCH
v1/documents POST
v1/documents DELETE
v1/documents PATCH
v1/documents GET
v1/portfolio-loans GET
v1/portfolio-loans/basic-information
v1/portfolio-loans/summary-information
v1/portfolio-loans/past-due-loans
v1/portfolio-loans/maturing-loans
v1/proposed-loans GET
v1/proposed-loans/basic-information
v1/proposed-loans/summary-information
v1/documents/{id:int}/content
v1/events
v1/proposed-liens GET
v1/liens GET
v1/collaterals/properties
v1/collateral-widgets

Collateral Limited Scope

GET/v1/collateral-widgets
POST/v1/collateral-widgets
GET/v1/collateral-widgets/{id}
DELETE/v1/collateral-widgets/{id}
PATCH/v1/collateral-widgets/{id}
GET/v1/collateral-widgets/values/{id}/{collateralId}
POST/v1/collateral-widgets/bulk
PATCH/v1/collateral-widgets/bulk
GET/v1/collateral-widgets/available-fields
GET/v1/collateral-widgets/status/{widgetId}/{collateralId}
PATCH/v1/collateral-widgets/status/{widgetId}/{collateralId}
GET/v1/document-associations
POST/v1/document-associations
GET/v1/document-associations/{id}
DELETE/v1/document-associations/{id}
PATCH/v1/document-associations/{id}
GET/v1/document-folders/{id}
PATCH/v1/document-folders/{id}
GET/v1/document-folders
POST/v1/document-folders
POST/v1/documents

Online Banking API Access

v1/online-portal/loan-applications/{id:int}/validate
v1/online-portal/borrower-access-restrictions/current-user
v1/online-portal/users
v1/online-portal/customers