{"method":"POST","path":"https://api.revcent.com/v2/secure_forms","summary":"Create A Secure Form","description":"Create a Secure Form. This will generate a secure form ID in the response. The response will also contain a form_url which can be used to direct a user to the secure form URL in order to fill out sensitive fields, then save encrypted data in RevCent internally. After the user indicates that they completed the form, the form ID can be used to reference the form in subsequent operations.<br><br>This is a method to save sensitive data without passing via a request body where logs and AI conversations shouldn't contain sensitive information.<br><br>Important: A secure form is temporary and has a lifespan of 1 hour, which upon expiration will be deleted including any saved data. After creating a secure form, the user should be aware that they have only one hour to complete the form. Attempts to access the form after its expiration will result in an error. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/CreateSecureForm.md for an in-depth overview of this operation.","operationId":"CreateSecureForm","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"form_source":{"type":"string","description":"The form source, indicating the source in which the form fields should be generated.","enum":["third_party_integration","third_party_shop","gateway","fulfillment_center","smtp_profile","paypal_account"]},"form_source_id":{"type":"string","description":"The form source id which indicates the site ID of the form_source, only applicable to a form_source of third_party_integration, third_party_shop, gateway or fulfillment_center. Not applicable to form source of smtp_profile or paypal_account.<br><br>For example, if form_source is third_party_integration, then form_source_id would be the site_third_party_integration ID, indicating the secure form should be generated using the required fields for a specific site third party integration.<br><br> Form Source ID Map:<br><br><em>third_party_integration:</em> the site third party integration ID.<br><br><em>third_party_shop:</em> the site third party shop ID.<br><br><em>gateway:</em> the site gateway ID.<br><br><em>fulfillment_center:</em> the site fulfillment center ID.","minLength":20,"maxLength":20}},"required":["form_source"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"secure_form_id":{"type":"string","description":"A 20 character secure form ID.","minLength":20,"maxLength":20},"completed":{"description":"Whether the secure form has been completed by the user. i.e. the form fields were filled in, form submitted and secure form data is encrypted and saved internally by RevCent. Once a secure form has been completed it cannot be modified.","type":"boolean"},"expiration_date_unix":{"type":"integer","format":"unix-time","description":"The unix timestamp representing the secure form expiration. After this time, the secure form URL will no longer be valid and the user will not be able to fill out the form or access any information related to the secure form."},"form_source":{"type":"string","description":"The form source, indicating the source in which the form fields should be generated.","enum":["third_party_integration","third_party_shop","gateway","fulfillment_center","smtp_profile"]},"form_source_id":{"type":"string","description":"The form source id which indicates the site ID of the form_source, only applicable to a form_source of third_party_integration, third_party_shop, gateway or fulfillment_center. Not applicable to form source of smtp_profile, as smtp credentials are a fixed form and do not require specific fields.<br><br>For example, if form_source is third_party_integration, then form_source_id would be the site_third_party_integration ID, indicating the secure form should be generated using the required fields for a specific site third party integration.<br><br> Form Source ID Map:<br><br><em>third_party_integration:</em> the site third party integration ID.<br><br><em>third_party_shop:</em> the site third party shop ID.<br><br><em>gateway:</em> the site gateway ID.<br><br><em>fulfillment_center:</em> the site fulfillment center ID.","minLength":20,"maxLength":20},"form_url":{"type":"string","description":"The secure form URL. This is the URL that the user should be directed to in order to fill out and complete the secure form, if not completed already. The user must be logged into RevCent in order to access the secure form.","format":"uri"},"result":{"type":"string"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}