The List referrals and Get a referral endpoint can be used to fetch a list of referrals or a specific one. They both return referral objects.

Scan Reports

Once a referral is completed, scan report files will be attached to it.

The referral object has an available_scan_reports_count attribute indicating how many scan reports are available.

The List referral's scan reports and Get one referral's scan report endpoints can be used to fetch the scan report files.

Scan Images

Similar to scan reports, scan images will also be available once the referral is completed.

The approved_scan_images_count attribute on the referral object indicates how many scan images are available.

The List referral's scan images and Get one referral's scan image endpoints can be used to generate links to these images.