Skip to main content
GET
Retrieve a submission

Authorizations

Authorization
string
header
required

One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.

Path Parameters

submission_id
string
required

The submission id, from GET /programs/{program_id}/submissions or the submission.awaiting_review event.

Response

The submission

A referral that O.J. has submitted to your program, with the package your reviewer needs. package links to every document, the calculations and the evidence receipts, and names the rules version the file was checked against. hosted_review_url is a page where a reviewer can read the package and record the decision without any integration. status moves from awaiting_review to offer or declined, and then to funded when you report funding.

id
string
required
Example:

"sub_01K5X9E5F6"

referral_id
string
required
program_id
string
required
status
enum<string>
required
Available options:
awaiting_review,
offer,
declined,
withdrawn,
funded
submitted_at
string<date-time>
required
object
string
Allowed value: "submission"
business
object
requested_amount
integer

A dollar amount expressed in whole US cents, so $85,000.00 is 8500000. Cents avoid rounding errors that decimals cause in some languages.

package
object
hosted_review_url
string<uri>

For your reviewer. A magic link that expires and is renewed on each read.

decision
object
funded
object
updated_at
string<date-time>