Create an Entity Onboarding Session

Changed on
post/entity_onboarding_sessions

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/entity_onboarding_sessions
  • Auth
    HTTP bearer

Request body

entity_idstring

The identifier of an existing Entity to associate with the onboarding session. If provided, the onboarding form will display any outstanding tasks required to complete the Entity's onboarding.

program_idstring required

The identifier of the Program the Entity will be onboarded to.

redirect_urlstring required

The URL to redirect the customer to after they complete the onboarding form. The redirect will include entity_onboarding_session_id and entity_id query parameters.

Example request

{
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "redirect_url": "https://example.com/onboarding/session"
}

Response

Entity Onboarding Session

created_atstring date-time required

The ISO 8601 date and time at which the Entity Onboarding Session was created.

entity_idstring nullable required

The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.

expires_atstring date-time required

The ISO 8601 date and time at which the Entity Onboarding Session will expire.

idstring required

The Entity Onboarding Session's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

program_idstring required

The identifier of the Program the Entity will be onboarded to.

redirect_urlstring required

The URL to redirect to after the onboarding session is complete. Increase will include the query parameters entity_onboarding_session_id and entity_id when redirecting.

session_urlstring nullable required

The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.

status'active' | 'expired' required

The status of the onboarding session.

type'entity_onboarding_session' required

A constant representing the object's type. For this resource it will always be entity_onboarding_session.

Example response

{
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "expires_at": "2020-02-01T05:59:59Z",
  "id": "entity_onboarding_session_wid2ug11fsmvh3k9hymd",
  "idempotency_key": null,
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "redirect_url": "https://example.com/onboarding/completed",
  "session_url": "https://onboarding.increase.com/onboarding/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz",
  "status": "active",
  "type": "entity_onboarding_session"
}

Changes

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

  • 8bbf0093efa6Revision changes
    • info

      endpoint added