Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync directory API

The directory API from Roadsync — 1 operation(s) for directory.

Roadsync directory API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include directory. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 17 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

1 operations 1 paths 17 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync directory API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

directory 1
GET
/payee-candidates
Search Payee Candidates
get-payee-candidates 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

id
integer
The id number of the object being returned.
payeeName
string
The name of the Carrier or Factoring Company.
postalCode
string
A valid postal code in the United States.
city
string
A valid city in the United States.
phoneNumber
string
A valid phone number belonging to a person or company.
firstName
string
The first name of a contact or user.
dotNumber
string
U.S. Department of Transportation Number is an up to ten-digit assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will…
mcNumber
string
Motor Carrier Number is a a nine-digit identifier assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will be validated.
availablePaymentTypes
array
A list of the availablepayment methods a Payee is able to receive. Possible values are PAPERCHECK, ACH, RTP
addressLineTwo
string
If necessary, add a second line of the address in the United States.
state
string
A valid 2 character state code in the United States.
lastName
string
The last name of a user or contact.
paymentTarget
A valid Payee payment target.
addressLineOne
string
The valid address of a person or business in the United States.
emailAddress
string
A valid email belonging to the person or company.
isVerified
boolean
A verified Payee is visible to all brokers in the RoadSync Pay environment. Some partners are allowed to verify a Payee by setting the isverified flag to true…
fundingSourceId
Id representing the funding source (papercheck, ach or wallet).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-directory-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API
Roadsync ping API