Onboarding

Accept assigned agreement

Changed on

Accepts an assigned agreement. Agreement status transitions from PENDING to ACCEPTED.

Use the assignedAgreementId returned by GET /onboarding/v1/assigned-agreements?applicationId={id}. All assigned agreements must be accepted before onboarding can complete.

patch/onboarding/v1/assigned-agreements/{assignedAgreementId}

Request

Path parameters

assignedAgreementIdstring uuid required
Example:06d119bc-64f6-46b2-aea2-3ff94c4c616f

Assigned agreement ID returned by the assigned agreements endpoint.

Response

Agreement accepted

status'ACCEPTED' required
respondedAtstring date-time required

Example response

{
  "respondedBy": {
    "type": "USER",
    "username": "partner@example.com"
  }
}

Changes