PT EN

Adesão

URL base: $CONSUMER_API

O objecto

statusstring · opcional

um de not_started, in_progress, complete

profileobject · opcional
notification_consentboolean · opcional
termsobject · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
current_terms_versionstring · opcional
O objecto
{
  "status": "not_started",
  "profile": {},
  "notification_consent": true,
  "terms": {},
  "requirements": {
    "currently_due": [
      "currently due"
    ],
    "eventually_due": [
      "eventually due"
    ],
    "past_due": [
      "past due"
    ],
    "pending_verification": [
      "pending verification"
    ],
    "errors": [
      {
        "requirement": "requirement",
        "code": "information_requested",
        "reason": "Leitura confirmada no local."
      }
    ]
  },
  "current_terms_version": "current terms version"
}

Obter o estado do registo

Registos

GET /onboarding

Returns the signed-in person's onboarding record: profile, notification consent, accepted terms, the list of requirements still to complete, the computed status and the current terms version. Clients use it to decide which onboarding steps to show.

Devolve

200 Consumer onboarding

Mostrar atributos
statusstring · opcional

um de not_started, in_progress, complete

profileobject · opcional
notification_consentboolean · opcional
termsobject · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
current_terms_versionstring · opcional
curl -X GET "$CONSUMER_API/onboarding" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "status": "not_started",
  "profile": {},
  "notification_consent": true,
  "terms": {},
  "requirements": {
    "currently_due": [
      "currently due"
    ],
    "eventually_due": [
      "eventually due"
    ],
    "past_due": [
      "past due"
    ],
    "pending_verification": [
      "pending verification"
    ],
    "errors": [
      {
        "requirement": "requirement",
        "code": "information_requested",
        "reason": "Leitura confirmada no local."
      }
    ]
  },
  "current_terms_version": "current terms version"
}

Actualizar o registo

Registos

PATCH /onboarding

Updates parts of the caller's onboarding record: profile fields (full_name, email, preferred_language), notification consent, and acceptance of the terms. Accepting terms requires accepted to be true and version to match the current terms version, and records the time and client IP. Invalid fields return a validation error listing each one, and the response is the updated onboarding view with recomputed requirements.

Corpo application/json

profileobject · opcional
Mostrar atributos filhos
full_namestring · opcional
emailstring · opcional
preferred_languagestring · opcional
notification_consentboolean · opcional
termsobject · opcional
Mostrar atributos filhos
acceptedboolean · obrigatório
versionstring · obrigatório

Devolve

200 Updated

Mostrar atributos
statusstring · opcional

um de not_started, in_progress, complete

profileobject · opcional
notification_consentboolean · opcional
termsobject · opcional
requirementsobject · opcional
Mostrar atributos filhos
currently_duearray of string · opcional
eventually_duearray of string · opcional
past_duearray of string · opcional
pending_verificationarray of string · opcional
errorsarray of object · opcional
Mostrar atributos filhos
requirementstring · opcional
codestring · opcional

um de information_requested, document_rejected

reasonstring · opcional
current_terms_versionstring · opcional
curl -X PATCH "$CONSUMER_API/onboarding" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "profile": {
    "full_name": "Ana Matsinhe",
    "email": "ana.matsinhe@example.org",
    "preferred_language": "preferred language"
  },
  "notification_consent": true,
  "terms": {
    "accepted": true,
    "version": "version"
  }
}'
Resposta 200
{
  "status": "not_started",
  "profile": {},
  "notification_consent": true,
  "terms": {},
  "requirements": {
    "currently_due": [
      "currently due"
    ],
    "eventually_due": [
      "eventually due"
    ],
    "past_due": [
      "past due"
    ],
    "pending_verification": [
      "pending verification"
    ],
    "errors": [
      {
        "requirement": "requirement",
        "code": "information_requested",
        "reason": "Leitura confirmada no local."
      }
    ]
  },
  "current_terms_version": "current terms version"
}