---
title: "Create challenge Profile"
method: POST
path: "/pws/pws_apata_create_challenge_profile/"
tags: ["Apata"]
---

# Create challenge Profile

`POST /pws/pws_apata_create_challenge_profile/`

## Request

- Base URL: `https://api.uat.paymentology.com/ppws/api`
- URL: `https://api.uat.paymentology.com/ppws/api/pws/pws_apata_create_challenge_profile/`
- Auth: none declared

This API provides the ability to create challenge profile.Its a Pass through API that internally calls Apata API

## Request body

- ChallengeProfileAPATA
  - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
  - `getproperties` Properties, required
    - `delegateSend` boolean, required: If set to true, Apata will make a webhook call to a configured URL to send the OTP via SMS.
    - `delegateVerify` boolean, required: If set to true, Apata will make a webhook call to a configured URL to verify the OTP.
    - `sendFormat` string: Value: "V1" The format that should be sent via webhook.
    - `sendWebhookId` string: The ID of the webhook call that will be made to send the SMS if "delegateSend" is set to true.
    - `delegateFormat` string: Value: "V1" The format that should be sent via webhook.
    - `verifyWebhookId` string: The ID of the webhook call that will be made to verify the OTP if "delegateVerify" is set to true.
    - `cancelWebhookId` string: The ID of the webhook call that will be made in the event that the cardholder cancels the challenge.
    - `cancelWebhookFormat` string: Value: "V1" The format that should be sent via webhook.
  - `name` string, required: Display name for the Challenge Profile.
  - `type` string, required: challenge profile type
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request
  - `description` string: Description for the Challenge Profile.
  - `alias` string: A unique, human-readable reference for a challenge profile.

## Response `200`

Successful Response

- ChallengeProfileAPATA
  - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
  - `getproperties` Properties, required
    - `delegateSend` boolean, required: If set to true, Apata will make a webhook call to a configured URL to send the OTP via SMS.
    - `delegateVerify` boolean, required: If set to true, Apata will make a webhook call to a configured URL to verify the OTP.
    - `sendFormat` string: Value: "V1" The format that should be sent via webhook.
    - `sendWebhookId` string: The ID of the webhook call that will be made to send the SMS if "delegateSend" is set to true.
    - `delegateFormat` string: Value: "V1" The format that should be sent via webhook.
    - `verifyWebhookId` string: The ID of the webhook call that will be made to verify the OTP if "delegateVerify" is set to true.
    - `cancelWebhookId` string: The ID of the webhook call that will be made in the event that the cardholder cancels the challenge.
    - `cancelWebhookFormat` string: Value: "V1" The format that should be sent via webhook.
  - `name` string, required: Display name for the Challenge Profile.
  - `type` string, required: challenge profile type
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request
  - `description` string: Description for the Challenge Profile.
  - `alias` string: A unique, human-readable reference for a challenge profile.

## Other responses

- `404`: Webservices does not exist
- `500`: Internal Server error

## Changes

- **2026-11-03** `73c2771493b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paymentology/apis/payapi-docs/changes/pws/pws_apata_create_challenge_profile/post.md)

---

[API](https://skmtc.dev/paymentology/apis/payapi-docs.md) - [All operations](https://skmtc.dev/paymentology/apis/payapi-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/payapi-docs/revisions/73c2771493b1?raw)