Skip to main content
POST
Create Requestor

Authorizations

Authorization
string
header
required

API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...

Body

application/json

Create an independent profile from the supplied configuration. Omitted document and correspondence fields start empty. It does not copy or replace the organization default.

name
string
required

Nonblank display name used for this profile.

Required string length: 1 - 500
provider_invoice_limit
number | null

Provider invoice approval limit in USD. Null uses $100; 0 prevents automatic payment of positive provider costs.

Required range: x >= 0
letter_of_rep
object | null
rfc_form
object | null
affidavits
object

Generic fallback and exact-family documents are independent. Set generic to null to remove it. Referenced PDFs must be readable, unencrypted, and at most 25 MiB.

correspondence
object | null

Omitted settings stay unchanged on update. Null clears nullable settings. A supplied notice replaces the previous notice; supplied billing_request fields merge with existing fields.

Response

Profile created

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"111111111111111111111111"

name
string | null
required

Name override, or null to use the organization name.

is_default
boolean
required

Whether this profile is selected when creation omits both Requestor fields.

provider_invoice_limit
number | null
required

Provider invoice approval limit in USD. Null uses $100; 0 prevents automatic payment of positive provider costs.

Required range: x >= 0
effective_provider_invoice_limit
number
required

Applied approval limit in USD after resolving null to $100.

Required range: x >= 0
letter_of_rep
object | null
required

Document metadata returned with a Requestor.

rfc_form
object | null
required

Document metadata returned with a Requestor.

affidavits
object
required
correspondence
object | null
required

Omitted settings stay unchanged on update. Null clears nullable settings. A supplied notice replaces the previous notice; supplied billing_request fields merge with existing fields.

created_at
string<date-time>
required
updated_at
string<date-time>
required