Retrieve section data for an application

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

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

GET

onboarding

partner

applications

{applicationId}

sections

{sectionName}

Retrieve section data for an application

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

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

Authorizations

Authorization

string

header

required

Bearer token obtained via Circle key exchange

Path Parameters

applicationId

string<uuid>

required

Application UUID

sectionName

string

required

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

Response

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

List sections for an application

Save section data for an application

⌘I