Skip to main content
POST
/usaspending/recipients

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
recipient_id
string
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}-[RPC]$
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:UsaspendingRecipient
name
string | null
alternate_names
string[]
duns
string | null
uei
string | null
recipient_level
enum<string> | null
Available options:
R,
P,
C
parent_id
string | null
parent_name
string | null
parent_duns
string | null
parent_uei
string | null
parents
object[]
business_types
string[]
location
object | null
total_transaction_amount
number | null
total_transactions
integer | null
total_face_value_loan_amount
number | null
total_face_value_loan_transactions
integer | null