Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Underwriting

Update underwriting details

Update the account’s underwriting by passing new values for one or more of the fields. Read our underwriting guide to learn more.

To use this endpoint from a browser, you’ll need to specify the /accounts/{accountID}/profile.write scope when generating a token.
PUT
/accounts/{accountID}/underwriting
cURL 
1
2
3
4
5
6
7

curl -X PUT "https://api.moov.io/accounts/{accountID}/underwriting" \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "averageTransactionSize":10000,
    "maxTransactionSize":50000,
    "averageMonthlyTransactionVolume":250000
  }'\
200 404 409 422
The underwriting details were successfully updated.
Describes underwriting values (in USD) used for card payment acceptance.
{
  "averageMonthlyTransactionVolume": 250000,
  "averageTransactionSize": 10000,
  "cardVolumeDistribution": {
    "cardPresentPercentage": 20,
    "debtRepaymentPercentage": 20,
    "ecommercePercentage": 20,
    "mailOrPhonePercentage": 20
  },
  "fulfillment": {
    "hasPhysicalGoods": true,
    "isShippingProduct": true,
    "returnPolicy": "none",
    "shipmentDurationDays": 7
  },
  "maxTransactionSize": 50000,
  "status": "approved",
  "volumeByCustomerType": {
    "businessToBusinessPercentage": 20,
    "consumerToBusinessPercentage": 20
  }
}
Empty response for unauthorized or any other returned http status code.
The account is currently in a state where underwriting details cannot be updated.
The request body could not be processed.

Path parameters

accountID

string <uuid> required
ID of the account.

Body

application/json
Describes underwriting values (in USD) used for card payment acceptance.

averageMonthlyTransactionVolume

integer<int64>

averageTransactionSize

integer<int64>

cardVolumeDistribution

object
right_key Show child attributes

cardPresentPercentage

integer<int64>

debtRepaymentPercentage

integer<int64>

ecommercePercentage

integer<int64>

mailOrPhonePercentage

integer<int64>

fulfillment

object
right_key Show child attributes

hasPhysicalGoods

boolean

isShippingProduct

boolean

returnPolicy

string<enum>
Describes the return policy.
Possible values: none, exchangeOnly, withinThirtyDays, other

shipmentDurationDays

integer<int64>

maxTransactionSize

integer<int64>

volumeByCustomerType

object
right_key Show child attributes

businessToBusinessPercentage

integer<int64>

consumerToBusinessPercentage

integer<int64>

Response

application/json
Describes underwriting values (in USD) used for card payment acceptance.

averageMonthlyTransactionVolume

integer<int64>

averageTransactionSize

integer<int64>

cardVolumeDistribution

object
right_key Show child attributes

cardPresentPercentage

integer<int64>

debtRepaymentPercentage

integer<int64>

ecommercePercentage

integer<int64>

mailOrPhonePercentage

integer<int64>

fulfillment

object
right_key Show child attributes

hasPhysicalGoods

boolean

isShippingProduct

boolean

returnPolicy

string<enum>
Describes the return policy.
Possible values: none, exchangeOnly, withinThirtyDays, other

shipmentDurationDays

integer<int64>

maxTransactionSize

integer<int64>

status

string<enum> deprecated
This field is deprecated and will be removed in a future release.
Possible values: approved, rejected, pendingReview, pending, notRequested

volumeByCustomerType

object
right_key Show child attributes

businessToBusinessPercentage

integer<int64>

consumerToBusinessPercentage

integer<int64>