/carrier-status-job/

post

https://qa-b2b.selfdecode.com/service/b2b-integrations/carrier-status-job/

Start a new carrier status report job for a profile. Processing is asynchronous - poll the job or wait for the webhook notification before reading the result.

Body Params

pdf_file_name

string

length ≤ 255

Filename of returned pdf (if blank default used)

pdf_config

object

desired_status

string

enum

required

report_generated - Report Generated
pdf_generated - Pdf Generated

Allowed:

file_id

uuid

If you don't have a processed genome file against your profile, please provide file_id returned from upload-file endpoint. Once done, your profile would be linked with your processed genome file, and you won't need to pass file_id for any subsequent jobs you create for this profile.

profile_id

uuid

required

report_id

uuid

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

201