Retrieve section data for an application

GET /v1/onboarding/partner/applications/{applicationId}/sections/{sectionName}

Retrieve section data for an application

cURL

curl --request GET \
  --url https://api-sandbox.circle.com/v1/onboarding/partner/applications/{applicationId}/sections/{sectionName} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {},
  "sectionName": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

applicationId · string<uuid> · required

Application UUID

sectionName · string · required

Section name as returned by the schema (e.g. personal_information)

Response

200

application/json

Section data

data · object

Section field data — structure varies by application template. Retrieve the shape via GET /{applicationId}/schema.

sectionName · string

status · enum<string>

Available options: action_required, complete, incomplete, not_started