POST
/api/conversations/{conversationId}/headless/{next}Send the information obtained from the user during the identity verification process
Takes the information from the user and calculates the next step that should be rendered to the user.
Detailed description of returned attributes:
| Parameter | Example | Description |
|---|---|---|
| component | GLOBAL/ACCEPTED | Name of method related with current step and expected action related to UI in verification process. |
| next | fd78cf43-12a7... | Id of the page to which the user information should be submitted. Information is sent via the method POST /api/conversations/{conversationId}/headless/{next}. |
| args | parameter name list | List of parameters that should be displayed to the user. |
| errors | map with field name and error description | A map specifying incorrectly entered form fields and a description of the associated error. |
| errors.field | parameter name sent in body attribute, validated and marked as incorrect | Value specifying incorrectly entered form field. |
| errors.code | error code related to the field described in errors.field attribute | Value describing the error associated to the form field. |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
conversationId | path | string | Required | Conversation ID |
next | path | string | Required | Next step ID |
X-User-IP | header | string | Required | User IP Address |
Request Body
RequiredContent-Type
application/jsonJSONargsobject[additional properties]stringResponses
Information available
Content-Type
application/vnd.authologic.v1.1+jsonJSONcomponentstringInformation needed to render the page
nextstringId of the page to which the user information should be submitted
argsobjectOption parameters which can be used by the user
[additional properties]anyerrorsarray<HeadlessPageArgError>Information about errors occurred when processing the data from the page
Bad Request
Content-Type
application/vnd.authologic.v1.1+jsonJSONOne of:
Variant 1
BadRequestApiError Variant 2
MethodArgumentNotValidError Variant 3
MethodArgumentTypeMismatchError Variant 4
ConstraintViolationError Variant 5
CustomValidationApiError Variant 6
OperationNotSupportedApiFieldError Variant 7
MissingHeaderApiErrorExhaustion of the plan or limitations related to non-payment
Permission denied
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Conversation not found
Content-Type
application/vnd.authologic.v1.1+jsonJSONstatusstring required Response status
messagestring required Descriptive error message
violationsarray<Violation> required Validation error list
statusDetailstringResponse status detailed information
Server side error