This library is SheerID REST API wrapper for JavaScript / TypeScript, based on SheerID REST API Reference (2.0.0)
This is still under development. We cannot be held responsible for any disadvantages caused by using this.
npm install sheerid-ts-apiInfo
- Retrieve build information
Verification
- Submit * data against program
- Get verification status
- Get verification status by Tracking ID
- Get the 10 most recent verification statuses by Tracking ID
- Get verification details
- Get verification metadata
- Replace verification metadata
- Refire verification webhook
- Label a verification request
- Retrieves a barcode image for a given reward code
- Purge personal data (PII) from a verification
- Reset the limits for the provided verification
- Begin verification flow
- Expire the provided verification
- Submit * data
- Skip submission of Social Security Number
- Start SSO process
- Cancel SSO verification
- Submit email loop response
- Cancel email loop verification
- Retry email loop
- Retrieve email loop token
- Resume email loop
- Allow user to submit an alternate email address
- Submit SMS code
- Retry SMS code
- Upload documents
- Cancel documents upload
- Upload documents (deprecated)
- Mark uploading documents as completed
- Modify the result of a verification via overriding
- Initiate Marketplace verification
- Submit marketplace verification data
- Get organization details
Program
- Get program theme
- Get the verification steps the given program may encounter in the verification flow.
- Get organization
- Establish verification limit
- Delete verification limit
- Create verification webhook
- Delete verification webhook
- Sends a link to the program
Report
- Generate a verification report
- Generate verification report for re-verification task
- Retrieve report generation status
- Download report
- List reporting fields
Conversion
- Store conversion information
- Store conversion information by Tracking ID
Addschool
- Submit an add school request
- Search for eligible schools by domain name as part of the add school flow
- Search for eligible schools by name as part of the add school flow
Info
- Retrieve build information
Verification
- Submit * data against program
- Get verification status
- Get verification status by Tracking ID
- Get the 10 most recent verification statuses by Tracking ID
- Get verification details
- Get verification metadata
- Replace verification metadata
- Refire verification webhook
- Label a verification request
- Retrieves a barcode image for a given reward code
- Purge personal data (PII) from a verification
- Reset the limits for the provided verification
- Begin verification flow
- Expire the provided verification
- Submit * data
- Skip submission of Social Security Number
- Start SSO process
- Cancel SSO verification
- Submit email loop response
- Cancel email loop verification
- Retry email loop
- Retrieve email loop token
- Resume email loop
- Allow user to submit an alternate email address
- Submit SMS code
- Retry SMS code
- Upload documents
- Cancel documents upload
- Upload documents (deprecated)
- Mark uploading documents as completed
- Modify the result of a verification via overriding
- Initiate Marketplace verification
- Submit marketplace verification data
- Get organization details
Program
- Get program theme
- Get the verification steps the given program may encounter in the verification flow.
- Get organization
- Establish verification limit
- Delete verification limit
- Create verification webhook
- Delete verification webhook
- Sends a link to the program
Report
- Generate a verification report
- Generate verification report for re-verification task
- Retrieve report generation status
- Download report
- List reporting fields
Conversion
- Store conversion information
- Store conversion information by Tracking ID
Addschool
- Submit an add school request
- Search for eligible schools by domain name as part of the add school flow
- Search for eligible schools by name as part of the add school flow
MIT