Expanded Carrier API - Detail of results

Try it: Here

Nodes

Header

🚧

Node Availability:

All Queries

🚧

Update Interval:

N/A

📘

Description:

The Header node will always accompany a successful call to the RMIS server, even if the result is not successful.

The Result node will show if the API call has a successful result. The API will return a collection of error messages if an error is detected.

The most common error is caused by the caller requesting a carrier that does not exist in the RMIS system, or a carrier that is not attached to the calling client.

The version node will return the version of the API which will determine the nodes returned.

Fields

Field NameData TypeMax SizeCan be Null?Description
TimestampString50NoDate/Time of API Reply using RMIS Server Time (Pacific Time Zone)
APIString50NoName of API
VersionString50NoVersion ID of called API and result format
ResultString50NoSUCCESS or ERROR

Carrier

🚧

Node Availability:

All Queries (some fields excepted, see below)

🚧

Update Interval:

Data is updated during the regular course of business, the information in the Carrier section reflects the data in the RMIS system at the time of the query.

📘

Description:

The Carrier node contains basic information about the carrier queried.

Certain fields will always contain a value, while other fields will contain a value only if RMIS has acquired the data.

Other fields are only returned if the client/carrier has participated in the RMIS CRS+ program and has completed a profile package as part of an onboarding process with the client and the calling client participates in the CRS+ program.

The Carrier information is sourced either from government sources (eg. FMCSA) or by RMIS through direct acquisition.

Fields

Field Name

Data Type

Can be Null?

Description

CompanyName

String

No

Carrier’s common name

RMISCarrierID

Integer

No

RMIS unique ID for the carrier

TaxID

String

Yes

Obsolete. This node will always be blank.
Note: typically TaxID information will be shown in the < W9> section if available (only to CRS+customers).

MCNumber

String

Yes

Unique number for Interstate carriers provided by the US DOT

DOTNumber

String

Yes

Unique number for carriers provided by the US DOT for Interstate and some Intrastate carriers

Address1

String

Yes

Mailing address of carrier gathered either via the US DOT, if the DOT has not mailing address on file, the physical address is used.

Address2

String

Yes

City

String

Yes

St

String

Yes

State Code or Province Code

Zip

String

Yes

ZipCode or Can Postal Code

Contact

String

Yes

Primary contact information for carrier

Title

String

Yes

Phone

String

Yes

Email

String

Yes

Payto

String

Yes

Remittance Address if provided, typically only available for carriers that have participated in our CRS+ process.

PaytoAddress

String

Yes

PaytoCity

String

Yes

PaytoSt

String

Yes

PaytoZip

String Yes

ClientsCarrierID

String

Yes

Client’s ID for a carrier mapped into the RMIS System. Can be null if client has not mapped an ID into the system. Some clients may map more than one ID per carrier. The first ID will be shown in this field, but all fields will be shown in the

<

ClientsCarrierIDs> node. This field is kept for backward compatibility.

insdIntraStateNumber

String

Yes

State carrier ID for intrastate carrier. Note: not all states provide state IDs. Will always be null for interstate carriers.

insdIntraStateState

String

Yes

State/Province code for intrastate carrier. Will always be null for interstate carriers.

DUNs

String

Yes

Carrier’s self reported Dun and Bradstreet ID. (Only provided for carriers participating in selected CRS+ programs.)

PaytoAddress2

String

Yes

Remit address line 2 if available.

PaytoCountry

String

Yes

Remit country code. Usually “USA” or “CAN”

Contacts

Can be empty but not null

Collection of

<

Contact> elements. Only provided when carrier has participated in CRS+ program, will otherwise be empty.

ClientsCarrierIDs

Can be Empty but not null

Collection of

<

ClientsCarrierID> elements. Will contain a collection of 0 or many client IDs mapped to this carrier in the RMIS system.


Carrier > Contacts

📘

Description

Contacts This is a collection of individual Contacts nodes. Typically this will only be provided by carriers that have been through the CRS+ process.

Fields

Field NameData TypeMax SizeCan be Null?Description
Contact TypeString50NoThe Type of Contact: eg. CORPORATE, SALES, DISPATCH, etc.
CompanyNameString50YesRecap of the Company Name for this contact.
NameString50YesFull name provided by the contact.
TitleString50Yes
PhoneString50Yes
FaxString50Yes
CellString50Yes
EmailString50Yes

Carrier > ClientsCarrierIDs

📘

Description:

ClientsCarrierIDs This is a collection of individual ClientsCarrierIDs nodes. This will be empty if there are no mapped client IDs for this carrier for the client.

Fields

Field NameData TypeMax SizeCan be Null?Description
ClientsCarrierIDString50YesClient’s carrier ID, mapped to this carrier, if provided.

Agreement

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration, and may be updated later by carrier.

📘

Description:

The agreement node will contain the information provided by the carrier during registration or subsequent visits to the site after they have electronically agreed to the document.

The information shown in this node will be the most recent instance the carrier made an agreement. If the client’s CRS+ system contains multiple documents, this refers to the MAIN AGREEMENT ONLY.

Note: RMIS stores historical versions of each agreement including full HTML text of the agreement. This can be accessed via the website only and is not included in the API due to size/performance considerations.

Fields

Field NameData TypeMax SizeCan be Null?Description
DateDateTime50NoMost recent date/time the carrier has agreed to the main document.
ContactString50NoCorporate Contact Name provided by the carrier.
TitleString50YesCorporate Contact’s title.
AgreeString50NoWhether the carrier agreed to the document. (In most systems the carrier cannot continue with registration if they do not agree.)

W9

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration, and may be updated later by carrier.

If client has subscribed to IRS TIN Validation, the record can also be updated with validation test results.

📘

Description:

The W9 node will contain the W9 information provided by the carrier during registration or the most recently submitted W9 if the carrier updated their W9 after registration.

If the carrier has not provided a W9 this element will be empty: <W9>.

TIN Validation is an optional program where RMIS can validate Company Names and Tax ID Numbers (TIN) against the IRS database.

The fields returned by the API closely mimic the fields on the IRS paper W9.

Note: All tax IDs are stored in an encrypted state in the RMIS database. The Tax IDs are decrypted for presentation to the API. It is the client’s responsibility to ensure that their system protects this information properly.

Fields

Field NameData TypeMax SizeCan be Null?Description
TimeStampDateTime50NoDate/time that the W9 was submitted to RMIS.
TaxIDInteger50NoThe unencrypted TaxID provided. Note: a user can either provide an SSN or a EIN. Whichever is supplied will be shown in this field.
CoNameString50NoCompany name provided by the carrier on their W9. This may be different from their DOT company name. Note: for IRS purposes, this is the name that must match the IRS name on the carrier’s tax return.
BusinessNameString50YesThis is the BusinessName or DBA name. This is NOT used for IRS matching purposes.
CompanyTypeString50YesThis is the IRS ‘Federal Tax Classification’ such as Individual/sole proprietor, C Corporation, Partnership, etc.
IsLimitedLiabCoString50YesTrue or False
LimitedLiabTaxClassString50YesString entered if “Limited liability company” is checked.
IsExemptPayeeString50YesTrue or False depending on if “Exempt Payee” is checked on W9 form.
AddressString50YesAddress entered on W9 form.
CityString50Yes
StString50Yes
ZipString50Yes
ContactNameString50YesMatches the contact who completed the online W9.
TINIsValidString50YesAvailable with TIN matching ONLY. Will be true/false. True means that CoName and TaxID match the IRS records.
TINValidationReasonString50YesResult of test. Will usually be “TIN and Name combination matches IRS records.” When there is a good match. If match fails, will usually be “TIN and Name combination does not match IRS records.” Or “TIN entered is not currently issued.”
TINCheckedDateString50YesDateTime RMIS validated the TIN with the IRS.
TINCheckedByString50YesThe name of the person or automated process that performed the IRS match.
TaxClassOtherString50YesTaxClass if provided on W9, usually blank.
TaxID-EINString50YesFor systems that require SSNs and EINs to be stored separately. If an EIN is supplied, it will be shown here, and SSN will be blank.
TaxID-SSNString50YesFor systems that require SSNs and EINs to be stored separately. If an SSN is supplied, it will be shown here, and EIN will be blank.

CarrierProfile

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The CarrierProfile node will contain the profile information self-reported by the carrier during CRS+ registration.

The first part of the note will list the ‘flat’ data entered by the carrier, and then the collection type data will be displayed including <OperatingArea> (Lane) data, <Modes>, <Commodities>, and <AdditionalFields> which contain custom data requested by individual customers.

Note: Since each customer’s website is developed independently and with different requirements, not all of the fields listed in the API field list will be available for your account. Please consult your website specification to determine if a field is being requested/captured on your registration website.

Note: these values are all self-reported by the carrier.

Fields

Field NameData TypeMax SizeCan be Null?Description
YearsInBusinessInteger50Yes
FlatBedsInteger50Yes
DryVansInteger50Yes
RefrigeratedVansInteger50Yes
RGNInteger50Yes
StepDecksInteger50Yes
MaxiInteger50Yes
DoubleDropsInteger50Yes
PayeeTypeString50Yes
PaymentMethodString50YesCarrier’s preferred method for receiving payment.
AccountsPayableContactString50YesObsolete. This data is now usually captured in the Carrier.Contacts node.
AccountsPayablePhoneString50Yes
DispatchContactString50YesObsolete. This data is now usually captured in the Carrier.Contacts node.
DispatchPhoneString50Yes
DrAfterHrsContactString50YesObsolete. This data is now usually captured in the Carrier.Contacts node.
DrAfterHrsPhoneString50Yes
OtherContact String50YesObsolete. This data is now usually captured in the Carrier.Contacts node.
ExpectFirstMoveTimeString50YesCarrier’s expectation of when the first load needs to move after registration, used in client’s software to prioritize processing. Typical options are: Within 4 Hours Within 24 Hours Greater than 24 Hours
EmailReceivedString50YesDoes carrier consent to receive emails from the client.
PreferredOriginsString50YesObsolete. Superceded by Operating Areas collection.
PreferredDestinationsString 50YesObsolete. Superceded by Operating Areas collection.
DifficultiesLoadsStateString 50YesObsolete. Superceded by Operating Areas collection.
PreferredLanesString50YesObsolete. Superceded by Operating Areas collection.
CompanyRepString50Yes
IsSpecialContractString50Yes
PrimaryEquipmentTypeString50Yes
DaysToPayString50YesObsolete. This data is now usually captured in the Carrier.Contacts node.
FactoryString50YesDoes the carrier use a Factoring Company. (Spelling should be Factor, but misspelling is preserved for backward compatibility.)
SCACString50Yes
HasSmartwayCertString50YesCarrier self-reported certification.
HasFastCertString50YesCarrier self-reported certification.
HasCarbCertString50YesCarrier self-reported certification.
HasTwicCertString50YesCarrier self-reported certification.
HazMatCertifiedString50YesCarrier self-reported certification.
HazMatExpirationDateString50YesIf carrier self-reports HazMat certification, they will also self-report the expiration date.
HazMatCertVerifiedByRMISString50YesIf client subscribes to HazMat verification, RMIS will indicate in this field if the HazMat has been verified via PHMSA.gov.If the client does not subscribe, the value will always be false.
HasSafetyPermitHM232String50YesCarrier self-reported certification.
TractorCountInteger50Yes
IntermodalTrailerCountInteger50Yes
TankerTrailerCountInteger50Yes
BulkTrailerCountInteger50Yes
OtherTrailerCountInteger50Yes
MinorityWomanOwnedString50YesDiversity Information: Carrier self- reports if they are a minority or woman owned enterprise. If the carrier reports this, the type will be shown in this field. Example: Woman Owned, Veteran Owned, etc.
SmallBusinessTypeString50YesDiversity Information: Carrier self- reports if they declare themselves to be a Small Business.
DiversityCertAgencyString50YesIf the carrier reports themselves to be minority/woman owned, they can report which agency has certified them.
SafetyMsgAgreementString50YesObsolete. Not currently used.
NoW9String50YesCarrier self-reports that they do not require a W9. Only used for clients who have a WC waiver page on their registration.
WcWaiverDateString50YesDate that carrier says they do not require WC coverage. Only used for clients who have a WC waiver page on their registration.
WcWaiverContactString50YesCarrier contact certifying that carrier does not require WC coverage. Only used for clients who have a WC waiver page on their registration.
Vans48footInteger50Yes
Reefer48footInteger50Yes
Vans53footInteger50Yes
Reefer53footInteger50Yes
CompanyDriversInteger50Yes
TeamsInteger50Yes
OwnerOperatorsInteger50Yes
HasMexInterchangeString50YesCarrier self-reports that it has Mexican Interchange authority.
HasCanAuthString50YesCarrier self-reports that it has Canadian Authority.
PadWrapString50Yes
StrapsString50Yes
TriAxleVansString 50Yes
VentedVansString50Yes
HeatedVansInteger50Yes
GarmentTrailerInteger50Yes
SuperVanInteger50Yes
WalkingFloorInteger50Yes
OpenTopInteger50Yes
StraightTrucksInteger50Yes
CargoVanInteger50Yes
HopperInteger50Yes
DumpInteger50Yes
HasCTPATCertString50YesCarrier self-reported certification.
WcWaiverContactString50YesCarrier contact certifying that carrier does not require WC coverage. Only used for clients who have a WC waiver page on their registration.
OperatingAreaXMLSee below
ModesXMLSee below
CommoditiesXMLSee below
CorrectiveActionPlansXMLSee below
AdditionalFieldsXMLSee below

Operating Areas

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The OperatingArea node will contain a collection of US States, Canadian Provinces or Mexican States as reported by the carrier.

Each area is listed as a code. Both Truck regions and Intermodal ports/ramps are included, and are identified by code.

Operating Areas Codes

The XML will describe a simple collection of each operating area that the carrier selected.

Fields

Field NameData TypeMax SizeCan be Null?Description
AreaString50YesCode corresponding to the state, province, ramp, or port selected.

Modes

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The Modes node will contain a collection of transportation modes the carrier identifies that they service.

The XML will describe a simple collection of each mode. Each mode is listed as a code. The description of the code is included here.


Commodities

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The Commodities node will contain a collection of commodities the carrier identifies that they can carry.

The XML will describe a simple collection of each commodity.

Each commodity is listed as a code. The description of the code is included here.


CorrectiveActionPlans

🚧

Node Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The CorrectiveActionPlans node will contain a collection of corrective action plans.

Corrective Action Plans are only captured if

  • The client elects to capture them in their registration system
    • AND
  • The carrier fails the business requirements dictated by the client.

If the carrier was required to submit a CAP, it will be shown in this section. The XML will describe a simple collection of each CAP on file.


AdditionalFields

🚧

Section Availability:

CRS+ ONLY

🚧

Update Interval:

Provided during CRS+ registration.

📘

Description:

The AdditionalFields node will contain a collection of ‘additional fields’ which are the mechanism RMIS uses to convey special information requested by a client that is not part of the standard XML result set. Additional fields will only be provided to a client if they are part of the initial registration website specification.

Additional fields will always be in the format below, each special field will be within an <AdditionalField> node with a <Description> and <Value> field. The description will be the special field, and the value will be the result captured by the website.


Coverages

🚧

Node Availability:

All

🚧

Update Interval:

Certificate data is updated as it is received from a carrier’s insurance producers.

NOTE: RMIS proactively requests certificate updates during new carrier onboarding, and prior to a coverage’s expiration date.

📘

Description:

The Coverages node contains the insurance information on file at RMIS for a carrier. It is appropriate to report this information by coverage instead of certificate since the coverage is the actual unit of work, and a carrier’s active coverages can be supplied on multiple certificates from multiple insurance producers (insurance agents).

RMIS will return all ACTIVE coverages on file. Note: active means the most recent coverage on file for that carrier, and does NOT mean that the coverage is IN FORCE. Therefore it is possible that a carrier can have multiple coverages and that some are in force, and others may be expired or canceled.

NOTE: RMIS endeavors to acquire current coverage information for carriers being monitored, however, RMIS is NOT responsible for information it has NOT been sent by a carrier’s producer. Reasons for not receiving updated information include (but are not limited to): RMIS not being informed of a change of producer by a carrier, a producer not sending timely updates of certificate updates, cancellations or renewals, or producers that refuse to send information to third parties.

Starting with version 6 of the API, RMIS will always return records for the 5 major coverages (Cargo, Auto, General, Worker’s Comp and Excess). If the carrier does NOT have one or more of those coverages on file, RMIS will send an EMPTY record for that coverage. This feature helps some client software packages to force that coverage to be shown as missing and helps prevent old coverage data from being displayed. This API behavior can be overridden using the custom argument and setting “ForceCoverage=0”.

The XML result of the coverage node contains:

Coverage Information
Limits Coverage Details (Checkboxes)

Fields

Field NameData TypeMax SizeCan be Null?Description
Coverage Node HeaderString50YesThe coverage node contains two attributes for easy parsing: CoverageDescription and Status. These are also expressed as nodes within the coverage, and are identical.
CoverageDescriptionString50NoThe type of coverage. Eg. Cargo, Auto, etc. Each carrier will only have ONE active coverage type at a time.
StatusInteger50YesThere are four basic statuses: Valid, Due-To-Expire, No- Current-Info and Empty.

Valid = the coverage is currently in force;
Due-To-Expire = the coverage is in force, but is within 30 days of expiration;
No-Current-Info = the coverage might be expired, cancelled or not yet effective.
Empty = there is no coverage for this type on file in the RMIS system.
EffectiveDateDate50YesThe effective date of the coverage.
ExpirationDateDate50YesThe expiration date of the coverage.
CancelDateDate50YesThe cancellation date of the coverage, if not cancelled, will be empty.
PolicyNumberString50YesThe policy number of the coverage.
ProducerString50YesThe Insurance Producer (Insurance Agent) of the coverage.
ProducerPhoneString50Yes
ProducerFaxString50Yes
ProducerEmailString50Yes
UnderwriterString50YesThe Insurance Company that is providing the coverage.
ConfidenceString50YesA value of “High” or “Low” describes if RMIS believes that this Producer has a history of providing reliable certificate updates, or if the certificate updates are expected to be supplied.

HIGH = RMIS has good experience with this producer and RMIS is named as the Certificate Holder.

LOW = RMIS is not listed as the Certificate Holder (so might not receive updates) or the Producer is known to not supply timely updates to RMIS.
RMISCertIDString50YesThe RMIS internal ID for the host certificate. (Used for troubleshooting.)
RMISCovgIDString50YesThe RMIS internal ID for this coverage. (Used for troubleshooting.)
LastCertUpdateDate50Yes The last date and time RMIS updated this coverage in the RMIS system.
ConfidenceMsgString500YesInformation about the confidence of the certificate suitable for displaying in the client’s software. For display purposes only.
RMISImageIDInteger50YesThe unique ID in the RMIS system of the scanned image of the Certificate that hosts this coverage. Clients can use this ID to fetch the image file using the RMIS Image API.

The ImageID may be empty if the certificate does not show RMIS as the Certificate Holder.
<Limit>Will contain a list of limit records depending on how many limits are listed on the certificate. See description below.
<CoverageDetail>Will contain a list of Coverage ‘Categories.’ This will contain the collection of checked checboxes within this coverage.

Example, if a coverage has 2 checkboxes set on the certificate the <CoverageDetail> node will have 2 records. UNCHECKED boxes will have NO records.

See description below.

Coverages > Limits

Fields

Field NameData TypeMax SizeCan be Null?Description
Limit Node HeaderString50NoThe limit node contains three attributes for easy parsing:
LimitDescription = the name of the limit as shown on the certificate.
Note: Limit descriptions can vary wildly, RMIS will always list the limit AS SHOWN on the certificate.
LimitAmount = the amount of the limit.
IsCargoSynonym = Since limit descriptions can vary so dramatically,
RMIS will tag certain limits as a “Cargo Synonym” if it is know that this limit can be evaluated as a CARGO limit.
Example “Load Limit” can be used as a Cargo limit, and the “IsCargoSynonym” will be True.
IsAutoSynonym = Since limit descriptions can vary so dramatically, RMIS will tag certain limits as a “Auto Synonym” if it is know that this limit can be evaluated as an AUTO limit.
Example “Limit of Liability” can be used as an Auto limit, and the “IsAutoSynonym” will be True.

The synonym system assists client software in evaluating if a limit can be used to meet Cargo or Auto business rules.
LimitDescriptionString50NoThe name of the limit as shown on the certificate. Note: Limit descriptions can vary wildly, RMIS will always list the limit AS SHOWN on the certificate.
LimitAmountDecimal50NoAmount of the Limit in US Dollars. If the coverage is empty, the limit will be shown as 0.
RMISLimitIDInteger50NoThe internal unique ID in the RMIS system for this limit. (Used for troubleshooting.)

Coverages > CoverageDetail

Fields

Field Name

Data Type

Max Size

Can be Null?

Description

Description

String

50

No

The description will describe the value shown on the certificate. This is typically the name of the CHECKBOX on the certificate that is CHECKED or TRUE.

  • *NOTE:** checkboxes that are NOT checked or empty are NOT shown in the XML result as a record.

Schedule Of Vehicles > VIN

🚧

Section Availability

All

📘

Description

This node contains information on the equipment associated with this carrier.

Fields

Field NameData Type
VINNumberString
YearString
MakeString
ModelString
ManufacturerString
VehicleTypeString
GVWRString

DOT

🚧

Section Availability:

All

🚧

Update Interval:

RMIS receives updates from the DOT/FMCSA nightly (Monday – Friday) with updates to carrier Authority data.

📘

Description:

The DOT node contains information from the DOT/FMCSA “Carrier” record which is used primarily for carrier contact information and authority data (Also called Licensing and Insurance L&I). This data is also useful for cross referencing USDOT# and MC# (Docket Number). This data is passed exactly as is provided by the DOT/FMCSA.

Most of the fields are self-explanatory, any fields with special considerations are noted below.

Fields

Field Name

Data Type

Max Size

Can be Null?

Description

dot_DocketNumber

String

50

No

MC# / Docket Number

dot_USDOTNumber

String

50

No

US DOT Number

dot_CommonAuthority

String

1

Yes

Common Carrier Authority A = Active N = None

*

this data is used by RMIS to determine if carrier has current authority

dot_ContractAuthority

String

1

Yes

Contract Carrier Authority A = Active N = None

*

this data is used by RMIS to determine if carrier has current authority

dot_BrokerAuthority

String

1

Yes

Broker Authority A = Active N = None

dot_PendingCommonAuthority

String

1

Yes

dot_PendingContractAuthority

String

1

Yes

dot_PendingBrokerAuthority

String

1

Yes

dot_CommonAuthRevocation

String

1

Yes

dot_ContractAuthRevocation

String

1

Yes

dot_BrokerAuthorityRevocation

String

1

Yes

dot_Passenger

String

50

Yes

dot_HouseholdGoods

String

50

Yes

dot_BIPDRequired

String

50

Yes

dot_CargoRequired

String

50

Yes

dot_BondSuretyRequired

String

50

Yes

dot_BIPDOnFile

String

50

Yes

dot_CargoOnFile

String

50

Yes

dot_BondSuretyOnFile

String

1

Yes

dot_AddressStatus

String

1

Yes

dot_DBAName

String

1

Yes

dot_LegalName

String

1

Yes

dot_Business_Addr

String

1

Yes

dot_Business_City

String

1

Yes

dot_Business_St

String

50

Yes

dot_Business_Country

String

50

Yes

dot_Business_Zip

String

50

Yes

dot_Business_Phone

String

50

Yes

dot_Business_Fax

String

50

Yes

dot_Mailing_Addr

String

50

Yes

dot_Mailing_City

String

50

Yes

dot_Mailing_St

String

50

Yes

dot_Mailing_Country

String

50

Yes

dot_Mailing_Zip

String

50

Yes

dot_Mailing_Phone

String

50

Yes

dot_Mailing_Fax

String

50

Yes

dot_dateLastUpdated

Date

50

Yes

The Date/Time that RMIS last received an update for this carrier from the DOT/FMCSA.


DOTTestingInfo

🚧

Section Availability:

All

🚧

Update Interval:

Safety and Operating Status data are updated in real time when the RMIS API is called via the FMCSA website.

If the FMCSA website is unavailable/down, the data is fetched from the last known good update from the RMIS database.

RMIS updates all ATTACHED carriers every 24 hours via the FMCSA website (attached means the carrier is currently being monitored with an RMIS client.

RMIS also receives an update of ALL carriers every 30 days from the DOT via their CENSUS file. (Note that the monthly CENSUS file from the DOT can be out-dated by up to 3 weeks.)

📘

Description:

The DOTTestingInfo node contains information that helps clients quickly fetch important information regarding DOT safety data, primarily SAFETY RATING and OPERATING STATUS.

NOTE: due to changes in the DOT/FMCSA reporting, many of the fields in this section are obsolete and are no longer provided. They are still displayed in the XML result for backward compatibility purposes.

Fields

Field NameData TypeMax SizeCan be Null?Description
VehicleOOSString50YesObsolete, replaced by CSA SMS data. Will always be empty.
DriverOOSString50YesObsolete, replaced by CSA SMS data. Will always be empty.
HazmatOOSString50YesObsolete, replaced by CSA SMS data. Will always be empty.
SafetyRatingDateDate50YesRating date as reported by the FMCSA.
SafetyRatingString50YesCurrent Safety Rating
Most common results are:
Satisfactory (“S” on Census file)
None (“N” on Census file)
Conditional (“C” on Census file)
UnSatisfactory (“U” on the Census file)

Note: A SafetyRating of “Insuf. Data” can be shown if the carrier’s rating is no longer being being shown by the FMCSA due to an OPERATING STATUS of OUT- OF-SERVICE or other reason.
SafetyReviewDateDate50YesReview date as reported by the FMCSA.
SafetyReviewTypeString50YesRating type as reported by the FMCSA.
DriverSEAString50YesObsolete, replaced by CSA SMS data. Will always be empty.
VehicleSEAString50YesObsolete, replaced by CSA SMS data. Will always be empty.
SafetyManagementSEAString50YesObsolete, replaced by CSA SMS data. Will always be empty.
TotalTrucksString50YesObsolete, replaced by CSA SMS data. Will always be empty.
TotalAccidentsString50YesObsolete, replaced by CSA SMS data. Will always be empty.
RatioDec50YesObsolete, replaced by CSA SMS data. Will always = “0.0”
OperatingStatusString50YesOperating status from the FMCSA website. Common values are:
OUT-OF-SERVICE: Carrier is under any type of out-of-service order and is not authorized to operate.
AUTHORIZED FOR { Passenger, Property, HHG }: This will list the specific operating authorities the carrier (or broker) is allowed to operate.
NOT AUTHORIZED: Carrier does not have any operating authority and is not authorized to operate.
ACTIVE: Carrier is authorized to operate.

For more information, see:
http://safer.fmcsa.dot.gov/saferhelp.aspx#OOS
OutOfServiceDateDate50YesIf the FMCSA has marked a carrier as out of date the OutOfService date will be shown. For carriers that are in service this field will be empty.

DOTSMSSafetyCollection

🚧

Section Availability:

All

🚧

Update Interval:

FMCSA Safety Measurement System (SMS) data is updated monthly as issued by the FMCSA (http://ai.fmcsa.dot.gov/sms/).

📘

Description:

The DOTSMSSafetyCollection node contains information from the FMSCA SMS system.

Fields

Field NameData TypeMax SizeCan be Null?Description
dotSmsSafety_USDotNumberString50NoUS DOT Number
dotSmsSafety_InspTotalInt50YesInspection Total
dotSmsSafety_DriverInspTotalInt50YesDriver Inspection Total
dotSmsSafety_DriverOosInspTotalInt50YesDriver Out Of Service Inspection Total
dotSmsSafety_VehicleInspTotalInt50YesVehicle Inspection Total
dotSmsSafety_VehicleOosInspTotalInt50YesVehicle Out Of Service Inspection Total
dotSmsSafety_UnsafeDrivingPercentileDec50YesUnsafe Driving Percentile
dotSmsSafety_UnsafeDrivingRoadsideAlertString1YesUnsafe Driving Roadside Alert Y /N
dotSmsSafety_UnsafeDrivingSeriousViolationString1YesUnsafe Driving Serious Violation Y /N
dotSmsSafety_UnsafeDrivingBasicAlertString1YesUnsafe Driving Basic Alert Y /N
dotSmsSafety_FatiguedDrivingPercentileDec50YesHours of Service Percentile (Was Fatigued Driving)
dotSmsSafety_FatiguedUnsafeDrivingRoadsideAlertString1YesHours of Service Roadside Alert Y /N (Was Fatigued Driving)
dotSmsSafety_FatiguedDrivingSeriousViolationString1YesHours of Service Serious Violation Y /N (Was Fatigued Driving)
dotSmsSafety_FatiguedDrivingBasicAlertString1YesHours of Service Basic Alert Y /N (Was Fatigued Driving)
dotSmsSafety_DriverFitnessPercentileDec50YesDriver Fitness Percentile
dotSmsSafety_DriverFitnessDrivingRoadsideAlertString1YesDriver Fitness Roadside Alert Y /N
dotSmsSafety_DriverFitnessSeriousViolationString1YesDriver Fitness Serious Violation Y /N
dotSmsSafety_DriverFitnessBasicAlertString1YesDriver Fitness Basic Alert Y /N
dotSmsSafety_ControlledSubstancePercentileDec50YesControlled Substance Percentile Y /N
dotSmsSafety_ControlledSubstanceRoadsideAlertString1YesControlled Substance Roadside Alert Y /N
dotSmsSafety_ControlledSubstanceSeriousViolationString1YesControlled Substance Serious Violation Y /N
dotSmsSafety_ControlledSubstanceBasicAlertString1YesControlled Substance Basic Alert Y /N
dotSmsSafety_VehicleMaintPercentileDec50YesVehicle Maintenance Percentile
dotSmsSafety_VehicleMaintRoadsideAlertString1YesVehicle Maintenance Roadside Alert Y /N
dotSmsSafety_VehicleMaintSeriousViolationString1YesVehicle Maintenance Serious Violation Y /N
dotSmsSafety_VehicleMaintBasicAlertString1YesVehicle Maintenance Basic Alert Y /N
dotSmsSafety_UpdateDateDate50YesDate RMIS last updated its database from the FMCSA.

DOTCensusCollection

🚧

Section Availability:

All - (Off /Hidden by default, can be enabled using custom settings)

🚧

Update Interval:

Carrier Census data is updated monthly by the FMCSA.

📘

Description:

The DOTCensusCollection node contains information from the DOT Census File.

Note: This data is normally NOT used by our clients using the API. The main exception is the “Rating” field which contains the FMCSA Safety Rating for the carrier. However, this field is already displayed in the <DOTTestingInfo> node shown above. It is recommended that clients use the <DOTTestingInfo> for Safety Rating information.

If a client would like to fetch Census information, they can do so using the “&Custom=1&DOTCensus=1” custom URL arguments.

For information about field descriptions, they can be found on the FMCSA website here:

http://mcmiscatalog.fmcsa.dot.gov/beta/Catalogs&Documentation/documentation/census/recordLayout.asp


DOTInsuredCollection

🚧

Section Availability:

All - (Off/Hidden by default, can be enabled using custom settings)

🚧

Update Interval:

Updated records are sent to RMIS daily (Monday – Friday) by the FMCSA.

📘

Description:

The DOTInsuredCollection node contains information from the FMCSA L&I Insurance History dataset.

Note: This data is normally NOT used by our clients using the API. If interested in using this information, please contact support.


DOTActPendInsCollection

🚧

Section Availability:

All - (Off/Hidden by default, can be enabled using custom settings)

🚧

Update Interval:

Updated records are sent to RMIS daily (Monday – Friday) by the FMCSA.

📘

Description:

The DOTActPendInsCollection node contains information from the FMCSA L&I Active Pending Insurance dataset.

Note: This data is normally NOT used by our clients using the API. If interested in using this information, please contact support.


CertificationStatus

🚧

Section Availability:

All

📘

Description:

This node contains information related to the carriers certification status related to the clients business and gate rules.

Fields

Field NameData Type
StatusDateString
IsCertifiedBoolean
NonCertifiedReasonsArray
NonCertifiedReasons > ReasonString
CertificationNotesArray
CertificationNotes > NoteString
EntitiesCertifiedInteger
EntititiesNotCertifedInteger
EntityCertificationArray
EntityCertification > EntityNode
Entity > EntityDescripString
Entity > IsCertifiedBoolean
Entity > EntityCodeString
Entity > EntityIDInteger