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

Retrieve underwriting details

Retrieve underwriting associated with a given Moov account.

Read our underwriting guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.read scope.

GET
/accounts/{accountID}/underwriting
cURL PHP Python TypeScript Java 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/underwriting" \
  -H "Authorization: Bearer {token}" \

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('v2024.01.00')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->underwriting->get(
    accountID: 'efe07546-f697-4da5-bf73-d9987efd4cdd'
);

if ($response->underwriting !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.underwriting.get(account_id="efe07546-f697-4da5-bf73-d9987efd4cdd")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  xMoovVersion: "v2024.01.00",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.underwriting.get({
    accountID: "efe07546-f697-4da5-bf73-d9987efd4cdd",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.Moov;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.GetUnderwritingResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("v2024.01.00")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetUnderwritingResponse res = sdk.underwriting().get()
                .accountID("efe07546-f697-4da5-bf73-d9987efd4cdd")
                .call();

        if (res.underwriting().isPresent()) {
            // handle response
        }
    }
}
200 401 403 404 429 500 504
The request completed successfully.
Example
Describes underwriting values (in USD) used for card payment acceptance.
{
  "averageTransactionSize": 0,
  "maxTransactionSize": 0,
  "averageMonthlyTransactionVolume": 0,
  "status": "approved",
  "volumeByCustomerType": {
    "businessToBusinessPercentage": 0,
    "consumerToBusinessPercentage": 0
  },
  "cardVolumeDistribution": {
    "ecommercePercentage": 0,
    "cardPresentPercentage": 0,
    "mailOrPhonePercentage": 0,
    "debtRepaymentPercentage": 0
  },
  "fulfillment": {
    "hasPhysicalGoods": true,
    "isShippingProduct": true,
    "shipmentDurationDays": 0,
    "returnPolicy": "none"
  },
  "geographicReach": "international-only",
  "businessPresence": "commercial-office",
  "pendingLitigation": "bankruptcy-or-insolvency",
  "volumeShareByCustomerType": {
    "business": 0,
    "consumer": 0,
    "p2p": 0
  },
  "collectFunds": {
    "ach": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    },
    "cardPayments": {
      "cardAcceptanceMethods": {
        "inPersonPercentage": 0,
        "mailOrPhonePercentage": 0,
        "onlinePercentage": 0
      },
      "currentlyAcceptsCards": true,
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      },
      "fulfillment": {
        "method": "bill-or-debt-payment",
        "timeframe": "immediate"
      },
      "refundPolicy": "conditional-refund"
    }
  },
  "moneyTransfer": {
    "pullFromCard": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    },
    "pushToCard": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    }
  },
  "sendFunds": {
    "ach": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    },
    "pushToCard": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    },
    "rtp": {
      "estimatedActivity": {
        "averageTransactionAmount": 0,
        "maximumTransactionAmount": 0,
        "monthlyVolumeRange": "under-10k"
      }
    }
  }
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Response

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

averageMonthlyTransactionVolume

integer<int64>

averageTransactionSize

integer<int64>

businessPresence

string<enum>
Possible values: commercial-office, home-based, mixed-presence, mobile-business, online-only, retail-storefront

cardVolumeDistribution

object
Show child attributes

cardPresentPercentage

integer<int32> required

debtRepaymentPercentage

integer<int32> required

ecommercePercentage

integer<int32> required

mailOrPhonePercentage

integer<int32> required

collectFunds

object
Show child attributes

ach

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

cardPayments

object
Show child attributes

cardAcceptanceMethods

object
Describes the distribution of card transactions by payment method.
Show child attributes

inPersonPercentage

integer<int32>
Percentage of card transactions that are in-person payments. Minimum value is 0, maximum is 100.

mailOrPhonePercentage

integer<int32>
Percentage of card transactions that are mail or phone payments. Minimum value is 0, maximum is 100.

onlinePercentage

integer<int32>
Percentage of card transactions that are online payments. Minimum value is 0, maximum is 100.

currentlyAcceptsCards

boolean

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

fulfillment

object
Show child attributes

method

string<enum>
Possible values: bill-or-debt-payment, digital-content, donation, in-person-service, local-pickup-or-delivery, other, remote-service, shipped-physical-goods, subscription-or-membership

timeframe

string<enum>
Possible values: immediate, other, over-30-days, pre-order, recurring-schedule, scheduled-event, within-30-days, within-7-days

refundPolicy

string<enum>
Possible values: conditional-refund, custom-policy, event-based-policy, full-refund-extended-window, full-refund-within-30-days, no-refunds, partial-refund, prorated-refund, store-credit-only

fulfillment

object
Show child attributes

hasPhysicalGoods

boolean required

isShippingProduct

boolean required

returnPolicy

string<enum> required
Possible values: none, exchangeOnly, withinThirtyDays, other

shipmentDurationDays

integer<int64> required

geographicReach

string<enum>
Possible values: international-only, us-and-international, us-only

maxTransactionSize

integer<int64>

moneyTransfer

object
Show child attributes

pullFromCard

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

pushToCard

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

pendingLitigation

string<enum>
Possible values: bankruptcy-or-insolvency, consumer-protection-or-class-action, data-breach-or-privacy, employment-or-workplace-disputes, fraud-or-financial-crime, government-enforcement-or-investigation, intellectual-property, none, other, personal-injury-or-medical

sendFunds

object
Show child attributes

ach

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

pushToCard

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

rtp

object
Show child attributes

estimatedActivity

object
Show child attributes

averageTransactionAmount

integer<int64>

maximumTransactionAmount

integer<int64>

monthlyVolumeRange

string<enum>
The low value in each range is included. The high value in each range is excluded.
Possible values: under-10k, 10K-50K, 50K-100K, 100K-250K, 250K-500K, 500K-1M, 1M-5M, over-5m

status

string<enum> deprecated
Possible values: approved, rejected, pendingReview, pending, notRequested

volumeByCustomerType

object
Show child attributes

businessToBusinessPercentage

integer<int32> required

consumerToBusinessPercentage

integer<int32> required

volumeShareByCustomerType

object
Show child attributes

business

integer<int32>

consumer

integer<int32>

p2p

integer<int32>