Sign in
Enrollment

Enroll Business

post/Enrollment/EnrollWithKyb

Headers

PackageIdstring uuid required

Unique Package ID for this request

Request body

Frequencystring required

Alert interval Possible values are: Daily, Weekly, Monthly, Quarterly, Yearly

CustomerReferenceIdstring nullable

Optional, customer reference identifier

SkipInitialCallbackboolean

Optional, if true, skips the first initial callback.

ScheduleStartDatestring date-time nullable

Optional, set customized StartDate to delay and stagger schedule (UTC)

CallbackUrlstring uri nullable

Optional, call back url

Example request

{
  "Frequency": "Quarterly",
  "CallbackUrl": "https://webhook.site/826d1861-be7a-4664-8eae-019736a2733f"
}

Response

The newly added enrollment id

string required

Changes

No recorded changes to this endpoint across all 1 revision of this API.