--- title: "Integrate provisioning via the SOAP API" slug: "oas-fullsdk-pg-integrate-provisioning-via-the-soap-api-3-29" updated: 2026-01-26T07:51:18Z published: 2026-01-26T07:51:18Z canonical: "docs.onespan.com/oas-fullsdk-pg-integrate-provisioning-via-the-soap-api-3-29" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.onespan.com/llms.txt > Use this file to discover all available pages before exploring further. # Integrate provisioning via the SOAP API The SOAP provisioning API provides the `provisioningExecute` SOAP command. This command can be used to execute different provisioning commands. To use the provisioningExecute SOAP operation 1. Create a SOAP request for the `provisioningExecute` command. 2. Specify the correct SOAP provisioning operation (register or activate) to be executed in the SOAP request. 3. Specify one or more provisioning attributes as parameters for the SOAP operation. Attributes are key/value pairs. 4. Import the OneSpan Authentication Server SSL server certificate as trusted root certificate on the machine where your client application is running. This will allow your SOAP client application to connect to OneSpan Authentication Server securely via SSL. 5. Send the SOAP request to OneSpan Authentication Server. By default, the SOAP request should be transmitted over HTTPS with the OneSpan Authentication Server. By default, OneSpan Authentication Server is configured to accept SOAP requests on port 8888. 6. Receive the SOAP response. 7. Process the SOAP response. For more information about the structure of SOAP messages, see [SOAP message structure](/sec/docs/oas-fullsdk-pg-soap-api-client-integration-method-3-29#soap-message-structure). ## provisioningExecute SOAP request structure A `provisioningExecute` SOAP request typically uses the following format: ```xml                        PROVISIONCMD_REGISTER                                                DP4Mobile Provisioning Sample Client                    PROVFLD_COMPONENT_TYPE                                                    testuser                    PROVFLD_USERID                                                    master                    PROVFLD_DOMAIN                                                    1.Password                    PROVFLD_STATIC_PASSWORD                                                    336619                    PROVFLD_CUSTOM_ENCRYPT_PWD                                         ``` The SOAP body element should only contain a `provisioningExecute` element (line 7). This element is defined in the namespace `prov`. Therefore, the `prov` namespace needs to be declared in the `Envelope` element as an attribute. A valid `provisioningExecute` request must follow these additional rules: - The `provisioningExecute` element should contain only one `AttributeSet` element. - The `provisioningExecute` element should contain only one `cmd` element. - The `AttributeSet` element should contain zero or more provisioning attributes elements. Each `attribute` element should contain the following sub-elements: - attributeID (required). The attribute identifier. The supported credential attribute identifiers are listed in [SOAP authentication (Overview)](/sec/docs/oas-fullsdk-soapref-authentication-overview-3-29). - `value` (required). The attribute value. This element also requires the specification of the value type using the following attribute definition `xsi=type="xsd:<type>`. - `attributeOptions` (optional). This element provides directive information about how OneSpan Authentication Server should handle the attribute value during request processing. Following options are supported for this element: - `NULL`. Indicates that the specified attribute should be set to zero. - `NEGATIVE`. Used for search criteria to say NO when searching for a specific attribute. - `MASKED`. Used to indicate OneSpan Authentication Server to mask the attribute value (e.g., when auditing the SOAP request). To set an attribute option, add the option element in the `attributeOptions` element and give the option element the value true. > To set the MASKED option, add the following: > > ```xml > true > ``` ## provisioningExecute SOAP response structure A `provisioningExecute` SOAP response typically uses the following format: ```xml                                                            RET_SUCCESS                    STAT_SUCCESS                    0                    0                                                                            testuser                        PROVFLD_USERID                                                                master                        PROVFLD_DOMAIN                                                                                        PROVFLD_ORGANIZATIONAL_UNIT                                                                VDS1000140                        PROVFLD_SERIAL_NO                                                                                            true                                                3808019401035644530210101...                        PROVFLD_ACTIVATION_CODE                                                                             ``` The SOAP body element should only contain a `provisioningExecuteResponse` element (line 12). The `provisioningExecuteResponse` element always contains a `results` element, which in turn contains the following sub-elements: - `resultCodes` (required). This element contains the following sub-elements: - `returnCode`. The operation return code indicating the overall result of the request processing. - `statusCode`. The operation status code indicating the reason for failure of any `returnCode` different from success (0). - `returnCodeEnum`. The identifier corresponding to the `returnCode`. - `statusCodeEnum`. The identifier corresponding to the `statusCode`. - `resultAttribute` (required). This element contains zero or more `attributes` elements. - `errorStack` (required). Contains zero or more `errors` elements. - `errors`. Each `errors` element contains the following sub-elements: - `errorCode`. The error code integer. - `errorDesc`. A string representation of the error code. For a complete list of possible error codes, see [Error codes and messages](/sec/docs/oas-aref-error-messages-3-29). In this case, the `resultattribute` element is used to refer to provisioning attributes elements.