diff --git a/api-playground/json/data/bav/bundled-bav/CreateBundledBAV.json b/api-playground/json/data/bav/bundled-bav/CreateBundledBAV.json index 76cf4e00..7bf9ccc0 100644 --- a/api-playground/json/data/bav/bundled-bav/CreateBundledBAV.json +++ b/api-playground/json/data/bav/bundled-bav/CreateBundledBAV.json @@ -13,6 +13,7 @@ ] }, "body": { - "mobileNumber": "9876543210" + "mobileNumber": "9876543210", + "consent": "Y" } -} +} \ No newline at end of file diff --git a/api-references/data/bav/bundled-bav.json b/api-references/data/bav/bundled-bav.json index 00ad4229..776470dd 100644 --- a/api-references/data/bav/bundled-bav.json +++ b/api-references/data/bav/bundled-bav.json @@ -19,7 +19,9 @@ "paths": { "/api/bundled-bav": { "post": { - "tags": ["Bundled BAV"], + "tags": [ + "Bundled BAV" + ], "summary": "Create Bundled BAV request", "operationId": "CreateBundledBAV", "parameters": [ @@ -58,14 +60,15 @@ } ], "requestBody": { - "description": "Mobile number to verify", + "description": "Mobile number to verify and customer consent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundledBAVCreateRequestBody" }, "example": { - "mobileNumber": "9876543210" + "mobileNumber": "9876543210", + "consent": "Y" } } }, @@ -129,7 +132,9 @@ }, "/api/bundled-bav/{requestId}": { "get": { - "tags": ["Bundled BAV"], + "tags": [ + "Bundled BAV" + ], "summary": "Get Bundled BAV request status", "operationId": "GetBundledBAVDetails", "parameters": [ @@ -246,12 +251,24 @@ "BundledBAVCreateRequestBody": { "title": "BundledBAVCreateRequestBody", "type": "object", - "required": ["mobileNumber"], + "required": [ + "mobileNumber", + "consent" + ], "properties": { "mobileNumber": { "type": "string", "description": "Mobile number to verify (10 digits)", "example": "9876543210" + }, + "consent": { + "type": "string", + "description": "Must be \"Y\" to enable the Mobile to Bank flow. Other BAV methods do not need explicit consent here since they take user input directly.", + "enum": [ + "Y", + "N" + ], + "example": "Y" } } }, @@ -333,7 +350,11 @@ }, "status": { "type": "string", - "enum": ["BAV_SUCCESSFUL", "BAV_FAILED", "BAV_PENDING"] + "enum": [ + "BAV_SUCCESSFUL", + "BAV_FAILED", + "BAV_PENDING" + ] }, "traceId": { "type": "string", @@ -422,7 +443,11 @@ "BundledBAVErrorResponse": { "title": "BundledBAVErrorResponse", "type": "object", - "required": ["success", "message", "traceId"], + "required": [ + "success", + "message", + "traceId" + ], "properties": { "success": { "type": "boolean", diff --git a/content/data/bav/bundled-bav/api-integration.mdx b/content/data/bav/bundled-bav/api-integration.mdx index d0934f57..a1cb83ee 100644 --- a/content/data/bav/bundled-bav/api-integration.mdx +++ b/content/data/bav/bundled-bav/api-integration.mdx @@ -15,6 +15,13 @@ Integrating Bundled BAV into your application involves creating a verification r Call the API to generate a verification URL for your customer. +**Request body** + +| Field | Type | Required | Description | +| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------- | +| `mobileNumber` | string | Yes | Customer's 10-digit mobile number | +| `consent` | string | Yes | Must be `"Y"` to enable the Mobile to Bank flow. Other BAV methods do not need explicit consent here since they take user input directly. | + {`POST /api/bundled-bav { - "mobileNumber": "9876543210" + "mobileNumber": "9876543210", + "consent": "Y" }`}
@@ -65,15 +73,50 @@ Call the API to generate a verification URL for your customer. <>

BAD REQUEST{" "} - Invalid product configuration or missing - required parameters. + Missing required fields or invalid product + configuration.


-
Request
+
Request — missing consent
{`POST /api/bundled-bav { "mobileNumber": "9876543210" +}`} + +
+
Response
+ + {`{ + "success": false, + "message": "Bad request - consent is required", + "traceId": "1-1234567890" +}`} + +
+
Request — missing mobileNumber
+ + {`POST /api/bundled-bav +{ + "consent": "Y" +}`} + +
+
Response
+ + {`{ + "success": false, + "message": "Bad request - mobileNumber is required", + "traceId": "1-1234567890" +}`} + +
+
Request — invalid product configuration
+ + {`POST /api/bundled-bav +{ + "mobileNumber": "9876543210", + "consent": "Y" }`}
@@ -104,7 +147,8 @@ Call the API to generate a verification URL for your customer. {`POST /api/bundled-bav { - "mobileNumber": "9876543210" + "mobileNumber": "9876543210", + "consent": "Y" }`}
diff --git a/content/data/bav/bundled-bav/quickstart.mdx b/content/data/bav/bundled-bav/quickstart.mdx index 3483c5c6..9374a760 100644 --- a/content/data/bav/bundled-bav/quickstart.mdx +++ b/content/data/bav/bundled-bav/quickstart.mdx @@ -26,7 +26,7 @@ You can simply create a request with the customer's phone number, which generate ### How does it work? -1. **Create a verification request** — Call the API with your customer's phone number to generate a verification URL +1. **Create a verification request** — Call the API with your customer's phone number and their consent (`"Y"`) to generate a verification URL 2. **Open URL in webview** — Display the URL in a webview within your app 3. **Customer completes verification** — The customer verifies their bank account using any of your enabled methods 4. **Receive webhook notification** — Once verification is complete, bank account details are sent to your configured webhook endpoint