Skip to main content
PATCH
Update Requestor

Authorizations

Authorization
string
header
required

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

Path Parameters

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

"111111111111111111111111"

Body

application/json

Update supplied fields only. Null clears nullable document slots/settings; arrays replace their corresponding collection. Changes affect existing linked retrievals.

name
string | null

Name override. Null restores the organization-name fallback; omission preserves the name.

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 updated

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