Set business merchant compliance

PUT

messaging

{session}

business

compliance

Set business merchant compliance

curl --request PUT \
  --url https://api.polymorfa.com/messaging/{session}/business/compliance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityName": "<string>",
  "isRegistered": true,
  "entityTypeCustom": "<string>",
  "customerCare": {
    "email": "<string>",
    "landlineNumber": "<string>",
    "mobileNumber": "<string>"
  },
  "grievanceOfficer": {
    "email": "<string>",
    "landlineNumber": "<string>",
    "mobileNumber": "<string>",
    "name": "<string>"
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityName: '<string>',
    isRegistered: true,
    entityTypeCustom: '<string>',
    customerCare: {email: '<string>', landlineNumber: '<string>', mobileNumber: '<string>'},
    grievanceOfficer: {
      email: '<string>',
      landlineNumber: '<string>',
      mobileNumber: '<string>',
      name: '<string>'
    }
  })
};

fetch('https://api.polymorfa.com/messaging/{session}/business/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/{session}/business/compliance"

payload = {
    "entityName": "<string>",
    "isRegistered": True,
    "entityTypeCustom": "<string>",
    "customerCare": {
        "email": "<string>",
        "landlineNumber": "<string>",
        "mobileNumber": "<string>"
    },
    "grievanceOfficer": {
        "email": "<string>",
        "landlineNumber": "<string>",
        "mobileNumber": "<string>",
        "name": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/{session}/business/compliance"

	payload := strings.NewReader("{\n  \"entityName\": \"<string>\",\n  \"isRegistered\": true,\n  \"entityTypeCustom\": \"<string>\",\n  \"customerCare\": {\n    \"email\": \"<string>\",\n    \"landlineNumber\": \"<string>\",\n    \"mobileNumber\": \"<string>\"\n  },\n  \"grievanceOfficer\": {\n    \"email\": \"<string>\",\n    \"landlineNumber\": \"<string>\",\n    \"mobileNumber\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "entityName": "<string>",
    "entityType": "SOLE_PROPRIETORSHIP",
    "isRegistered": true,
    "entityTypeCustom": "<string>",
    "customerCare": {
      "email": "<string>",
      "landlineNumber": "<string>",
      "mobileNumber": "<string>"
    },
    "grievanceOfficer": {
      "email": "<string>",
      "landlineNumber": "<string>",
      "mobileNumber": "<string>",
      "name": "<string>"
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

session

string

required

Identifier of the connected Polymorfa session.

Body

application/json

entityName

string

required

Human-readable entity name for this native business merchant compliance.

Value constraints

Constraint	Accepted input
String length	At most `256` characters

Maximum string length: 256

entityType

enum<string>

required

Category assigned to entity.

Allowed values

Value	Meaning
`SOLE_PROPRIETORSHIP`	Sole proprietorship.
`PARTNERSHIP`	Partnership.
`PRIVATE_COMPANY`	Private company.
`PUBLIC_COMPANY`	Public company.
`LIMITED_LIABILITY_PARTNERSHIP`	Limited liability partnership.
`OTHER`	Other.

Available options:

SOLE_PROPRIETORSHIP,

PARTNERSHIP,

PRIVATE_COMPANY,

PUBLIC_COMPANY,

LIMITED_LIABILITY_PARTNERSHIP,

OTHER

isRegistered

boolean

required

Whether registered.

entityTypeCustom

string

required

Specifies entity type custom for this native business merchant compliance.

Value constraints

Constraint	Accepted input
String length	At most `256` characters

Maximum string length: 256

customerCare

object

required

Structured customer care values for this native business merchant compliance.

Show child attributes

grievanceOfficer

object

required

Structured grievance officer values for this native business merchant compliance.

Show child attributes

Response

Merchant compliance details updated

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Set business merchant compliance

curl --request PUT \
  --url https://api.polymorfa.com/messaging/{session}/business/compliance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityName": "<string>",
  "isRegistered": true,
  "entityTypeCustom": "<string>",
  "customerCare": {
    "email": "<string>",
    "landlineNumber": "<string>",
    "mobileNumber": "<string>"
  },
  "grievanceOfficer": {
    "email": "<string>",
    "landlineNumber": "<string>",
    "mobileNumber": "<string>",
    "name": "<string>"
  }
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityName: '<string>',
    isRegistered: true,
    entityTypeCustom: '<string>',
    customerCare: {email: '<string>', landlineNumber: '<string>', mobileNumber: '<string>'},
    grievanceOfficer: {
      email: '<string>',
      landlineNumber: '<string>',
      mobileNumber: '<string>',
      name: '<string>'
    }
  })
};

fetch('https://api.polymorfa.com/messaging/{session}/business/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/{session}/business/compliance"

payload = {
    "entityName": "<string>",
    "isRegistered": True,
    "entityTypeCustom": "<string>",
    "customerCare": {
        "email": "<string>",
        "landlineNumber": "<string>",
        "mobileNumber": "<string>"
    },
    "grievanceOfficer": {
        "email": "<string>",
        "landlineNumber": "<string>",
        "mobileNumber": "<string>",
        "name": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/{session}/business/compliance"

	payload := strings.NewReader("{\n  \"entityName\": \"<string>\",\n  \"isRegistered\": true,\n  \"entityTypeCustom\": \"<string>\",\n  \"customerCare\": {\n    \"email\": \"<string>\",\n    \"landlineNumber\": \"<string>\",\n    \"mobileNumber\": \"<string>\"\n  },\n  \"grievanceOfficer\": {\n    \"email\": \"<string>\",\n    \"landlineNumber\": \"<string>\",\n    \"mobileNumber\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "entityName": "<string>",
    "entityType": "SOLE_PROPRIETORSHIP",
    "isRegistered": true,
    "entityTypeCustom": "<string>",
    "customerCare": {
      "email": "<string>",
      "landlineNumber": "<string>",
      "mobileNumber": "<string>"
    },
    "grievanceOfficer": {
      "email": "<string>",
      "landlineNumber": "<string>",
      "mobileNumber": "<string>",
      "name": "<string>"
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Set business merchant compliance

Authorizations

Path Parameters

Body

Response