Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Maws (Beta)

Create Maw3

Create a Maw object.

This endpoint supports different templates depending on region and use case.
Required parameters: consent, templateId, plus additional fields depending on the selected template.

Supported Templates

Template IDRegionRequired Parameters
tpl-maw004001Mexico (MX)mobileNumber, countryCode, fullName, idType=NATIONAL_ID, idNumber
tpl-maw004002Africa countriesgaid
tpl-maw004003Philippines (PH)mobileNumber, countryCode, fullName, idType=NATIONAL_ID, idNumber

Sandbox Test Values

Template IDParametersExpected Response
tpl-maw004001mobileNumber = 529559991234, countryCode = MX, fullName = George, idNumber = ZAZD801124MBSYQN13resultCode = SUCCESS
tpl-maw004002gaid = '00000000-0000-0000-0000-000000000000'resultCode = SUCCESS
tpl-maw004003mobileNumber = 639559991234, countryCode = PH, fullName = George, idNumber = 4561234567resultCode = SUCCESS

For all other valid input combinations, if no mock data match is found, the system will return:
resultCode = NO_DATA, and no items will be included in the response.

post/beta/maws/requestMaw3

Request body

OR
OR

Example request

{
  "mobileNumber": "529559991234",
  "fullName": "George Smith",
  "idNumber": "ZAZD801124MBSYQN13",
  "idType": "NATIONAL_ID",
  "gaid": "00000000-0000-0000-0000-000000000000",
  "countryCode": "PH",
  "templateId": "tpl-maw004001",
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "mobileNumber": "639559991234",
      "countryCode": "PH",
      "templateId": "tpl-maw002001",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    },
    "maw2Items": [
      {
        "date": "2000-01-21"
      }
    ]
  }
}