# Modify a request in status DRAFT

Endpoint: PUT /request/{id}
Version: 2.0.0
Security: bearerAuth

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `create` (boolean)

## Request fields (application/json):

  - `referenceId` (string)
    Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally.
More requests can have the same value.
    Example: "order-1234-0002"

  - `parameters` (object)

  - `parameters.additionalProp0` (string)

  - `settings` (object)

  - `customerAttributes` (object)

## Response 200 fields (application/json):

  - `id` (string)

  - `organizationId` (string)

  - `status` (string)
    - DRAFT: The request has not been created yet, but it can be modified
- CREATED: The request has been created, but its processing has to start yet.
- RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.
- COMPLETED: Final status for a request completed successfully (according to specific request type 
               it may have warnings or unsuccessful scenarios accepted by operational behavior).
- EXPIRED: Final status for a request that has not been completed before the expiration time.
- FAILED: Final status for a request whose processing has failed.
- CANCELLED: Final status for a request that has been cancelled or completed unsuccessfully.
- USER_CANCELLED: DEPRECATED - Final status for a request that a user has explicitly cancelled (not applicable to all request types).
- OPERATOR_CANCELLED:  DEPRECATED - Final status for a request that an operator has explicitly cancelled (not applicable to all request types).
- DRAFT_EXPIRED:  DEPRECATED - Final status for a request in draft status that has not been published before the expiration time
    Enum: "DRAFT", "CREATED", "RUNNING", "COMPLETED", "EXPIRED", "FAILED", "CANCELLED"

  - `referenceId` (string)
    Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally.
More requests can have the same value.
    Example: "order-1234-0002"

  - `requestTypeId` (string, required)
    Identifier of the type of process associated to the request. This identifier is given to the Integrator
during initial setup of the integration project.

  - `parameters` (object)

  - `parameters.additionalProp0` (string)

  - `settings` (object)

  - `createdAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `createdAt.dummySeeComment` (string)

  - `updatedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `finalizedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `expireAfter` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `anonymizedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `operatorPending` (boolean)

  - `terminationReason` (string)
    - "ERROR_OPERATOR_WRONG_FIRSTNAME"
- "ERROR_OPERATOR_WRONG_SURNAME"
- "ERROR_OPERATOR_INVERSION_FIRSTNAME_SURNAME"
- "ERROR_OPERATOR_WRONG_BIRTH_DATE"
- "ERROR_OPERATOR_WRONG_BIRTH_PLACE"
- "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUED_COUNTRY"
- "ERROR_OPERATOR_WRONG_DOCUMENT_EXPIRE_DATE"
- "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY"
- "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_AUTHORITY_TYPE"
- "ERROR_OPERATOR_WRONG_DOCUMENT_NUMBER"
- "ERROR_OPERATOR_WRONG_DOCUMENT_ISSUING_DATE"
- "ERROR_OPERATOR_WRONG_DOCUMENT_TYPE"
- "ERROR_OPERATOR_WRONG_FISCAL_CODE"
- "ERROR_OPERATOR_OTHER"
- "ERROR_DH_IDENTITY_VERIFICATION_VALIDATION"
- "ERROR_IDENTITY_OPERATOR_CANCELLED"
- "ERROR_IDENTITY_FIELD_REQUEST_NOT_MATCHED"
- "ERROR_IDENTITY_ID_SELF"
- "ERROR_IDENTITY_ID_SELF_NULL_REQUEST_INFO"
- "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CONTROLS_SUMMARY"
- "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE_REQUEST_INFO"
- "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE"
- "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_CONTROLS_SUMMARY"
- "ERROR_IDENTITY_ID_SELF_NULL_BIOMETRY_RESPONSE_REQUEST_INFO"
- "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_TYPE"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_NOT_ALLOWED"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_EXPIRED"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_SPECIMEN"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_BACK_SIDE_FOUND"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_NO_FRONT_SIDE_FOUND"
- "ERROR_IDENTITY_ID_SELF_NULL_DOCUMENT_CHECK_RESPONSE"
- "ERROR_IDENTITY_ID_SELF_IDENTIFICATION_FAILED"
- "ERROR_IDENTITY_ID_SELF_HOLDER_INFO_MISMATCH"
- "ERROR_IDENTITY_ID_SELF_VIDEO_RECORDING_COULD_NOT_BE_ACHIEVED"
- "ERROR_IDENTITY_ID_SELF_MISSING_PARAMETER"
- "ERROR_IDENTITY_ID_SELF_INVALID_PARAMETER"
- "ERROR_IDENTITY_ID_SELF_INVALID_URL"
- "ERROR_IDENTITY_ID_SELF_BAD_QUALITY"
- "ERROR_IDENTITY_ID_SELF_RECORDING_EXPIRED_OR_CANCELLED"
- "ERROR_IDENTITY_ID_SELF_TOO_LARGE_CONTENT"
- "ERROR_IDENTITY_ID_SELF_MRZ_BROKEN_INCOMPLETE_OR_NOT_FOUND"
- "ERROR_IDENTITY_ID_SELF_BIOMETRY_FACE_DETECTION_ISSUES"
- "ERROR_IDENTITY_ID_SELF_DOCUMENT_TYPE_AND_REQUESTED_TYPE_MISMATCH"
- "ERROR_IDENTITY_ID_SELF_UNSUPPORTED_BANK"
- "ERROR_IDENTITY_ID_SELF_LIVE_CHECK_CAN_NOT_BE_PERFORMED"
- "ERROR_SIGN_INVALID_PHONE_NUMBER"
- "ERROR_SIGN_INVALID_HOLDER_INFORMATION"
- "ERROR_SIGN_MISSING_REQUEST_INFORMATION"
- "CANCELLED_BY_USER"
- "ERROR_IDENTITY_ID_SELF_STATUS_NOT_DONE"

  - `customerAttributes` (object)

  - `links` (array)

  - `links.actor` (string)
    Example: "customer"

  - `links.link` (string)
    Example: "https://onboarding.example/res/3949?ts=49943"

  - `links.expiresAfter` (object)
    Example: "2024-10-22T12:19:12.269594Z"

## Response 400 fields (application/problem+json):

  - `errors` (array)
    An array of error details to accompany a problem details response.

  - `errors.detail` (string, required)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties."

  - `errors.pointer` (string)
    A JSON Pointer to a specific request body property that is the source of error.
    Example: "/parameters/dummyField"

  - `errors.field` (string)
    The name of the field that is the source of error.
    Example: "dummyField"

  - `errors.reason` (string)
    A machine oriented error type. Eg. additionalProperties, required
    Example: "additionalProperties"

  - `type` (string)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `status` (integer, required)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 400

  - `title` (string)
    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: "Request validation error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463"

  - `retryable` (boolean)
    If the api call can be retried