Underwriting | Moov Documentation
Underwriting is a tool Moov uses to understand a business’s profile before allowing them to collect funds on our platform. Through underwriting, you can retrieve or update information about the business's transaction volume.
Retrieve underwriting details
Retrieve underwriting associated with a given Moov account.
To retrieve underwriting details, you'll need to specify the /accounts/{accountID}/profile.read scope when generating a token.
Parameters
| Name | Type |
|---|---|
accountID |
string |
Ask
moov.accounts.underwriting.get({accountID});
Update underwriting details
Update the account's underwriting by passing new values for one or more of the fields.
To update underwriting details, you'll need to specify the /accounts/{accountID}/profile.write scope when generating a token.
Parameters
| Name | Type |
|---|---|
accountID |
string |
underwriting |
Underwriting |
Ask
const underwriting = {
averageTransactionSize: 500,
maxTransactionSize: 1000,
averageMonthlyTransactionVolume: 500000
};
moov.accounts.underwriting.update({accountID, underwriting});