{"info":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","description":"

Why Choose Numeracle API's:

Numeracle API’s is a reliable and efficient solution for organizations seeking to harness the power of phone number related information.

Numeracle Authentication:

Numeracle employs OAuth 2.0 for authentication. To execute the API, you’ll require a bearer
token. Generate this token using the provided Client ID and secret. Below is an
example of how to create the bearer token.

curl -X POST https://www.sandbox.numeracle.com/oauth/token \\

-H \"Content-Type: application/x-www-form-urlencoded\" \\

-u : \\<**YOUR_CLIENT_ID**>:<**YOUR_CLIENT_SECRET**>\\

-d \"grant_type=client_credentials”

Remember to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your actual credentials.

Note: The validity of bearer token is around 9 hrs approx. , If you encounter an unauthorized error,please generate a new token with client ID and client secret.

Sandbox Environment

https://www.sandbox.numeracle.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Why Choose Numeracle API's:","slug":"why-choose-numeracle-apis"}],"owner":"39598180","collectionId":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","publishedId":"2sBYHRTgG4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-12T04:02:03.000Z"},"item":[{"name":"oauth","item":[{"name":"token","item":[{"name":"Sandbox Token","id":"d8d1f3f9-64d4-4e17-9f70-a4cdbeda2628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials"}]},"url":"https://www.sandbox.numeracle.com/oauth/token","description":"

Note: The validity of the bearer token is around 9 hours.
If you encounter an unauthorized error, please generate a new token with the client ID and client secret.

\n","urlObject":{"protocol":"https","path":["oauth","token"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"d2e26669-fa59-495e-9cbe-5134b4922076","name":"Sandbox Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials"}]},"url":"https://www.sandbox.numeracle.com/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 01 Oct 2025 10:37:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"8d94f81f-6cad-4872-9a2e-161321ca9314\",\n \"token_type\": \"bearer\",\n \"expires_in\": 36055,\n \"scope\": \"read trust write\"\n}"}],"_postman_id":"d8d1f3f9-64d4-4e17-9f70-a4cdbeda2628"}],"id":"7b6b302e-1721-4db2-83a1-8bfce6cb6137","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"00014c4d-b4d4-4ba2-a807-5c8d00deb668"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"fd90e11a-3fa3-49ac-aaba-10a22ccda95d"}}],"_postman_id":"7b6b302e-1721-4db2-83a1-8bfce6cb6137","description":""}],"id":"1f8d7b55-4129-4199-9752-50193bd3a383","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c43b3c15-3c2a-48d6-be17-2d06a6b0c256"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"82313896-4541-455c-b5c6-73b80e02c0bc"}}],"_postman_id":"1f8d7b55-4129-4199-9752-50193bd3a383","description":""},{"name":"Entity","item":[{"name":"v1","item":[{"name":"Post","item":[{"name":"Basic Info","id":"8981af23-182e-4e03-bb23-f1fe7919549d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"Demo Root Entity\",\r\n \"entityType\": \"Root\",\r\n \"clientLegalName\": \"Demo Rest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/basic-info","description":"

Description

This API is used to create a new business entity in the system. The entity can be either a Root entity (independent) or an Assigned entity (linked to an existing Root entity). The request must include the entityType, entityName, clientLegalName. • If the entityType is \"Root\", the rootEntityCode need not be provided (or must be null). • If the entityType is \"Assigned\", the rootEntityCode is required and must refer to a valid Root entity in the system.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`entityName`	String	Yes	Name of the entity. Must be between 4–200 characters and not null.	Demo Entity
`entityType`	String (Enum)	Yes	Type of the entity. Allowed values: `Root`, `Assigned`.	Root
`clientLegalName`	String	Yes	Full legal name of the client. Maximum length 75 characters; must not be blank.	Demo Legal Entity LLC
`rootEntityCode`	String	Conditional	Code of the root entity. Required if `entityType = Assigned`; must be blank/null if `Root`.	NUMXXXXX7676

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Entity basic info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/basic-info
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains hyperlinks for next actions or related endpoints	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/general-info\"}
`links.nextAction`	String	URL path for the next API step	/api/v1/entity/NUMXXXXXX105/general-info

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityName`	String	Yes	INVALID_ENTITY_NAME	entityName cannot be null or blank.	400	Bad Request
`entityName`	String	Yes	INVALID_ENTITY_NAME_LENGTH	entityName minimum length is 4 characters and maximum length is 200 characters.	400	Bad Request
`entityType`	String (Enum)	Yes	INVALID_ENTITY_TYPE	entityType cannot be null, blank, or invalid. Accepted values: ‘Root’ or ‘Assigned’.	400	Bad Request
`clientLegalName`	String	Yes	INVALID_CLIENT_LEGAL_NAME	clientLegalName cannot be null or blank.	400	Bad Request
`clientLegalName`	String	Yes	INVALID_CLIENT_LEGAL_NAME_LENGTH	clientLegalName maximum length is 75 characters.	400	Bad Request
`rootEntityCode`	String	Yes (required when entityType is Assigned)	INVALID_ROOT_ENTITY_CODE	rootEntityCode cannot be null or blank.	400

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
INVALID_ROOT_ENTITY_CODE	rootEntityCode should be blank or null while creating Entity when entityType is Root	422	Unprocessable Content
NULL_CHECK_FOR_ROOT_ENTITY_CODE	rootEntityCode cannot null and blank when entityType is Assigned	422	Unprocessable Content
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Content
INVALID_ROOT_ENTITY	Root entity already exists for the account.	422	Unprocessable Content
INVALID_ROOT_ENTITY_CODE	rootEntityCode should be blank or null while creating Entity when entityType is Root	422	Unprocessable Content
NULL_CHECK_FOR_ROOT_ENTITY_CODE	rootEntityCode cannot null and blank when entityType is Assigned	422	Unprocessable Content
ACOUNT_TYPE_IS_SINGLE_ENTITY	Cannot create child entity or sub entity when account type is Single Entity.	422	Unprocessable Content
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Content

","urlObject":{"protocol":"https","path":["api","v1","entity","basic-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"88952bdf-74a0-48e5-b4b9-eb4bf58962a6","name":"201-Created-Basic-Root","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"Demo Root Entity\",\r\n \"entityType\": \"Root\",\r\n \"clientLegalName\": \"Demo Rest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/basic-info"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T10:49:02Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity basic info saved successfully. Proceed to the next step.\",\n \"path\": \"/api/v1/entity/basic-info\",\n \"data\": {\n \"entityCode\": \"NUMXXXXXX105\",\n \"entityStatus\": \"New\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/general-info\"\n }\n}"},{"id":"915f6501-8483-471a-9fef-14fcbf4188b5","name":"400-Bad-Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"Demo Entity\",\r\n \"entityType\": \"Assigned\",\r\n \"clientLegalName\": \"Demo Rest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/basic-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T01:51:58:58Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/basic-info\",\n \"details\": [\n {\n \"field\": \"entityName\",\n \"issue\": \"entityName minimum length is 4 characters and maximum length is 200 characters.\",\n \"customCode\": \"INVALID_ENTITY_NAME_LENGTH\"\n }\n ]\n}"},{"id":"ace479f0-8370-4ca9-b3d7-dee7c08f820c","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"Demo Root Entity\",\r\n \"entityType\": \"Root\",\r\n \"clientLegalName\": \"Demo Rest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/basic-info"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-09T11:35:07:07Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/basic-info\",\n \"details\": [\n {\n \"issue\": \"Please Check Entity Already Exists With This Name !!!\",\n \"customCode\": \"CHECK_DUPLICATE_ENTITY\"\n }\n ]\n}"}],"_postman_id":"8981af23-182e-4e03-bb23-f1fe7919549d"},{"name":"General Info","id":"270f8a1c-089d-4adf-9e2d-5dcff899be9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Demo Entity\",\r\n \"parentCompany\": \"Demo Entity Inc\",\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"zipCode\": \"22XX2\",\r\n \"addressType\": \"OTHER\",\r\n \"addressTypeOther\": \"WAREHOUSE\",\r\n \"country\": \"US\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"fax\": \"2079460XXX\",\r\n \"website\": \"https://www.demoentity.com\",\r\n \"pointOfContact\": {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"designation\": \"CEO\",\r\n \"otherDesignation\": null,\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"email\": \"john.anderson@demoentity.com\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info","description":"

Description

This API captures the general business information for an existing entity, identified by its unique entityCode. It includes address details, contact numbers, website, and point of contact (POC) information.

This step is usually done after the entity’s basic information has been registered. The API enforces strict validations to ensure the accuracy and completeness of the entity's general info.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Request Parameters:

Name	Type	Required	Description	Example
`description`	String	No	Description or display name of the entity	NUME Demo
`parentCompany`	String	No	Name of the parent company (if applicable)	ABC Inc
`addressLine1`	String	Yes	Primary street address	123 Main Street
`addressLine2`	String	No	Secondary address line (suite, apartment, etc.)	Suite 201
`city`	String	Yes	City name	McLean
`stateCode`	String	Conditional	US only. Legacy region code — accepted during transition instead of subdivisionCode. Do not send with subdivisionType/subdivisionCode.	VA
`zipCode`	String	Yes	Postal / ZIP code	22XX2
`addressType`	String	Yes	Primary address type. Allowed: STATE_REGISTRATION_ADDRESS, PRINCIPAL_BUSINESS_ADDRESS, MAILING_ADDRESS, HEAD_OFFICE, OTHER	OTHER
`addressTypeOther`	String	Conditional	Required when addressType is OTHER (max 100). Free-text description.	WAREHOUSE
`country`	String	Yes	Country code (ISO 3166-1 alpha-2)	US
`subdivisionType`	String	Conditional	Preferred region type (e.g. STATE for US). Required with subdivisionCode unless US sends stateCode only.	STATE
`subdivisionCode`	String	Conditional	Preferred region code. Required for non-US; for US, required unless stateCode is sent.	VA
`phoneNumber`	String	Yes	Main contact phone number	2079460XXX
`fax`	String	No	Optional fax number	2079460XXX
`website`	String	Yes	Website URL	[https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com](https://www.demo.com/))))))))
`pointOfContactFirstName`	String	Yes	First name of the point of contact	John
`pointOfContactLastName`	String	Yes	Last name of the point of conta	anderson
`pointOfContactDesignation`	String	Yes	Designation of the point of contact (e.g., CEO, CTO, OTH for Other)	OTH
`pointOfContactOtherDesignation`	String	Conditional	Required if `pointOfContactDesignation` is `OTH	Supervisor
`pointOfContactPhoneNumber`	String	Yes	Phone number of the point of contact	2079460XXX
`pointOfContactEmail`	String	Yes	Email address of the point of contact	john.anderson[@demo.comm](https://mailto:demo.restapi@abctesting.com)

Region fields (i18n)

US backward compatible

Prefer subdivisionType + subdivisionCode for the primary address region. stateCode is still accepted for US entities during transition — do not send both patterns.

countryUS ISO 3166-1 alpha-2 country on the primary addresssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"country\": \"US\",\n  \"stateCode\": \"TX\"\n}\n\n

Preferred

{\n  \"country\": \"US\",\n  \"subdivisionType\": \"STATE\",\n  \"subdivisionCode\": \"TX\"\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-07-08T13:00:00Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Entity general info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/NUMXXXXXX105/general-info
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains links for related endpoints or next actions	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\"}
`links.nextAction`	String	URL path for the next step in the API flow	/api/v1/entity/NUMXXXXXX105/entity-officers

Input Validation

Name	Type	Required	Custom Error Code	Error Message	HTTP Status Code	Http Status Text
`description`	String	No	INVALID_DESCRIPTION_LENGTH	description maximum length is 100 characters.	400	Bad Request
`parentCompany`	String	No	INVALID_PARENT_COMPANY_LENGTH	parentCompany maximum length is 75 characters.	400	Bad Request
`addressLine1`	String	Yes	INVALID_ADDRESS_LINE1_NULL	addressLine1 cannot be null or blank.	400	Bad Request
`addressLine1`	String	Yes	INVALID_ADDRESS_LINE1_LENGTH	addressLine1 maximum length is 100 characters.	400	Bad Request
`addressLine2`	String	No	INVALID_ADDRESS_LINE2_LENGTH	addressLine2 maximum length is 100 characters.	400	Bad Request
`city`	String	Yes	INVALID_CITY_NULL	city cannot be null or blank.	400	Bad Request
`city`	String	Yes	INVALID_CITY_LENGTH	city maximum length is 20 Characters.	400	Bad Request
`city`	String	Yes	INVALID_CITY_FORMAT	city must contain only alphabetic characters.	400	Bad Request
`zipCode`	String	Yes	INVALID_ZIPCODE_NULL	zipCode cannot be null or blank.	400	Bad Request
`zipCode`	String	Yes	INVALID_ZIPCODE_LENGTH	zipCode minimum length is 1 digit and maximum length is 10 digit.	400	Bad Request
`zipCode`	String	Yes	INVALID_ZIPCODE	zipCode format is invalid for the selected country.	400	Bad Request
`addressType`	String	Yes	INVALID_ADDRESS_TYPE	addressType cannot be null or blank.	400	Bad Request
`addressType`	String	Yes	INVALID_ADDRESS_TYPE	addressType is invalid. Allowed values are: STATE_REGISTRATION_ADDRESS, PRINCIPAL_BUSINESS_ADDRESS, MAILING_ADDRESS, HEAD_OFFICE, OTHER.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther is required when addressType is OTHER.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther maximum length is 100 characters.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther is only allowed when addressType is OTHER.	400	Bad Request
`country`	String	Yes	INVALID_COUNTRY_NULL	country cannot be null or blank.	400	Bad Request
`country`	String	Yes	INVALID_COUNTRY_LENGTH	country maximum length is 20 Characters.	400	Bad Request
`country`	String	Yes	UNSUPPORTED_COUNTRY_CODE	Country Code not supported. Refer /v1/country-codes	400	Bad Request
`country`	String	Yes	INVALID_COUNTRY_CODE	Invalid country code {code}.	400	Bad Request
`subdivisionType`	String	Conditional	INVALID_SUBDIVISION_TYPE	subdivisionType is invalid for the selected country.	400	Bad Request
`subdivisionType`	String	Conditional	INVALID_SUBDIVISION_TYPE_LENGTH	subdivisionType maximum length is 20 characters.	400	Bad Request
`subdivisionCode`	String	Conditional	INVALID_SUBDIVISION_CODE	Invalid subdivision code {code} for country {country}.	400	Bad Request
`subdivisionCode`	String	Conditional	INVALID_SUBDIVISION_CODE_LENGTH	subdivisionCode maximum length is 50 characters.	400	Bad Request
`stateCode`	String	Conditional	INVALID_STATE_CODE	Invalid state code {code} for country {country}.	400	Bad Request
`stateCode`	String	Conditional	INVALID_STATE_CODE_LENGTH	stateCode maximum length is 20 Characters.	400	Bad Request
`county`	String	No	INVALID_COUNTY_LENGTH	county maximum length is 100 characters.	400	Bad Request
`phoneNumber`	String	Yes	INVALID_PHONE_NUMBER_NULL	phoneNumber cannot be null or blank.	400	Bad Request
`phoneNumber`	String	Yes	INVALID_PHONE_NUMBER	phoneNumber must contain digits only (optional leading '+').	400	Bad Request
`phoneNumber`	String	Yes	INVALID_PHONE_NUMBER_LENGTH	phoneNumber must contain exactly 10 digits for country US.	400	Bad Request
`fax`	String	No	INVALID_FAX	fax must contain digits only (optional leading '+').	400	Bad Request
`fax`	String	No	INVALID_FAX_LENGTH	fax must contain exactly 10 digits for country US.	400	Bad Request
`website`	String	Yes	INVALID_WEBSITE_NULL	website cannot be null or blank.	400	Bad Request
`website`	String	Yes	INVALID_WEBSITE_FORMAT	Invalid website URL. Please enter a valid URL.	400	Bad Request
`website`	String	Yes	INVALID_WEBSITE_LENGTH	website maximum length is 75 characters.	400	Bad Request
`pointOfContact`	Object	Yes	INVALID_POC_NULL	PointOfContact object is required.	400	Bad Request
`pointOfContact.firstName`	String	Yes	INVALID_POC_FIRST_NAME_NULL	PointOfContact:FirstName cannot be null or blank.	400	Bad Request
`pointOfContact.firstName`	String	Yes	INVALID_POC_FIRST_NAME_LENGTH	PointOfContact:FirstName maximum length is 50 Characters.	400	Bad Request
`pointOfContact.firstName`	String	Yes	INVALID_POC_FIRST_NAME_FORMAT	PointOfContact:FirstName name must contain only alphabetic characters and spaces.	400	Bad Request
`pointOfContact.lastName`	String	Yes	INVALID_POC_LAST_NAME_NULL	PointOfContact:LastName cannot be null or blank.	400	Bad Request
`pointOfContact.lastName`	String	Yes	INVALID_POC_LAST_NAME_LENGTH	PointOfContact:LastName maximum length is 50 Characters.	400	Bad Request
`pointOfContact.lastName`	String	Yes	INVALID_POC_LAST_NAME_FORMAT	PointOfContact:LastName name must contain only alphabetic characters and spaces.	400	Bad Request
`pointOfContact.designation`	String	Yes	INVALID_POC_DESIGNATION_NULL	PointOfContact:Designation cannot be null or blank.	400	Bad Request
`pointOfContact.designation`	String	Yes	INVALID_POC_DESIGNATION_LENGTH	PointOfContact:Designation maximum length is 100 characters.	400	Bad Request
`pointOfContact.otherDesignation`	String	Conditional	INVALID_POC_OTHER_DESIGNATION_LENGTH	PointOfContact:OtherDesignation minimum length 1 characters and maximum length is 100 characters.	400	Bad Request
`pointOfContact.phoneNumber`	String	Yes	INVALID_POC_PHONE_NULL	PointOfContact:PhoneNumber cannot be null or blank.	400	Bad Request
`pointOfContact.phoneNumber`	String	Yes	INVALID_POC_PHONE_FORMAT	PointOfContact:PhoneNumber must contain digits only (optional leading '+').	400	Bad Request
`pointOfContact.phoneNumber`	String	Yes	INVALID_POC_PHONE_LENGTH	PointOfContact:PhoneNumber must contain exactly 10 digits for country US.	400	Bad Request
`pointOfContact.email`	String	Yes	INVALID_POC_EMAIL_NULL	PointOfContact:Email cannot be null or blank.	400	Bad Request
`pointOfContact.email`	String	Yes	INVALID_POC_EMAIL_FORMAT	PointOfContact:Please enter valid email.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
MISSING_REQUIRED_FIELD	Required fields are missing: subdivisionCode	422	Unprocessable Content
PLEASE_ENTER_POINT_OF_CONTACT_DESIGNATION	Invalid \"Contact Designation\"	422	Unprocessable Content
PLEASE_ENTER_POINT_OF_CONTACT_OTHER_DESIGNATION	Invalid \"Contact Designation\"	422	Unprocessable Content
INVALID_POINT_OF_CONTACT_OTHER_DESIGNATION	Invalid PointOfContactOtherDesignation. Ensure that the designation value is set to Other(OTH).	422	Unprocessable Content
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","general-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"23a8f6ac-d6af-41ab-a0f3-d263a2026887","name":"201-Created-General Info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Demo Entity\",\r\n \"parentCompany\": \"Demo Entity Inc\",\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"22XX2\",\r\n \"addressType\": \"OTHER\",\r\n \"addressTypeOther\": \"WAREHOUSE\",\r\n \"country\": \"US\",\r\n \"phoneNumber\": \"85XXXXX1488\",\r\n \"fax\": \"703XXXX8923\",\r\n \"website\": \"https://www.demoentity.com\",\r\n \"pointOfContact\": {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"designation\": \"CEO\",\r\n \"otherDesignation\": null,\r\n \"phoneNumber\": \"9912XXX999\",\r\n \"email\": \"john.anderson@demoentity.com\"\r\n },\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T11:18:24Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity general info saved successfully. Proceed to the next step.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/general-info\",\n \"data\": {\n \"entityCode\": \"NUMXXXXXX105\",\n \"entityStatus\": \"New\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\"\n }\n}"},{"id":"25f9a18f-e342-4c3e-8b01-4a75aa3278e0","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"description\": \"Demo\",\r\n \"parentCompany\": \"Demo Inc\",\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"stateCode\": \"VA\",\r\n \"zipCode\": \"22AAX2\",\r\n \"country\": \"US\",\r\n \"phoneNumber\": \"85X1488\",\r\n \"fax\": \"703XXXX8923\",\r\n \"website\": \"https://www.demo.com\",\r\n \"pointOfContactFirstName\": \"john\",\r\n \"pointOfContactLastName\": \"anderson\",\r\n \"pointOfContactDesignation\": \"OTH\",\r\n \"pointOfContactOtherDesignation\": \"Supervisor\",\r\n \"pointOfContactPhoneNumber\": \"7035558923\",\r\n \"pointOfContactEmail\": \"john.anderson@demo.com\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/general-info\",\n \"details\": [\n {\n \"field\": \"zipCode\",\n \"issue\": \"zipCode must contain digits only.\",\n \"customCode\": \"INVALID_ZIPCODE_FORMAT\"\n },\n {\n \"field\": \"phoneNumber\",\n \"issue\": \"phoneNumber maximum length is 10 digits.\",\n \"customCode\": \"INVALID_PHONE_LENGTH\"\n }\n ]\n}"},{"id":"41d9f671-91e2-43a0-9ab7-38375a76cbbe","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"description\": \"Demo\",\r\n \"parentCompany\": \"Demo Inc\",\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"stateCode\": \"VA\",\r\n \"zipCode\": \"22AAX2\",\r\n \"country\": \"US\",\r\n \"phoneNumber\": \"85X1488\",\r\n \"fax\": \"703XXXX8923\",\r\n \"website\": \"https://www.demo.com\",\r\n \"pointOfContactFirstName\": \"john\",\r\n \"pointOfContactLastName\": \"anderson\",\r\n \"pointOfContactDesignation\": \"OTH\",\r\n \"pointOfContactOtherDesignation\": \"Supervisor\",\r\n \"pointOfContactPhoneNumber\": \"7035558923\",\r\n \"pointOfContactEmail\": \"john.anderson@demo.com\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/general-info\",\n \"details\": [\n {\n \"issue\": \"Invalid Entity Code NUMXXXXXX105.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n }\n ]\n}"}],"_postman_id":"270f8a1c-089d-4adf-9e2d-5dcff899be9f"},{"name":"Additional Address","id":"4ff4f32e-c0f5-4d39-b8cd-ffecea54dc6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"addressLine1\": \"1600 Pennsylvania Ave NW\",\r\n \"addressLine2\": null,\r\n \"city\": \"Washington\",\r\n \"zipCode\": \"20500\",\r\n \"addressType\": \"MAILING_ADDRESS\",\r\n \"addressTypeOther\": null,\r\n \"country\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"DC\",\r\n \"county\": null\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/additional-addresses","description":"

Description

Creates one or more additional addresses for an entity. Does not modify existing rows. Request body must be a non-empty JSON array of address objects (without addressId).

Maximum additional addresses per entity: 2.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`addressLine1`	String	Yes	Street address line 1	1600 Pennsylvania Ave NW
`addressLine2`	String	No	Street address line 2	Suite 200
`city`	String	Yes	City	Washington
`zipCode`	String	Yes	Postal / ZIP code	20500
`addressType`	String	Yes	Address type (e.g. MAILING_ADDRESS, HEAD_OFFICE, OTHER)	MAILING_ADDRESS
`addressTypeOther`	String	Conditional	Required when addressType is OTHER	Warehouse
`country`	String	Yes	ISO 3166-1 alpha-2 country code	US
`subdivisionType`	String	Yes	Region type	STATE
`subdivisionCode`	String	Yes	Region code	VA
`county`	String	No	Optional county

i18n

Supported countries and region fields

Each address requires country, subdivisionType, and subdivisionCode (optional county). Supported countries: US. POST accepts a non-empty array; PATCH updates one address by path addressId.

countryUS ISO 3166-1 alpha-2 country on each addresssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response time (UTC).	2025-07-08T13:00:00Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Additional addresses created successfully.
`path`	String	API endpoint called.	/api/v1/entity/NUMEXXXXXXXX/additional-addresses
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.additionalAddresses[]`	Array	Created addresses with server-assigned addressId values.

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Error Message	HTTP Status Code	Http Status Text
`requestBody`	Array	Yes	INVALID_REQUEST_BODY	Request body must be a non-empty array.	400	Bad Request
`country`	String	Yes	INVALID_COUNTRY_CODE	Country must be a supported country code.	400	Bad Request
`subdivisionType`	String	Conditional	INVALID_SUBDIVISION_TYPE	subdivisionType is invalid for the selected country.	400	Bad Request
`subdivisionCode`	String	Conditional	INVALID_SUBDIVISION_CODE	subdivisionCode is invalid for the selected country and subdivisionType.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
MAX_ADDITIONAL_ADDRESSES_EXCEEDED	Max of 2 additional addresses are allowed.	422	Unprocessable Entity
DUPLICATE_PRIMARY_ADDRESS_COUNTRY	Additional address country cannot match primary address country.	400	Bad Request

Description

EntityOfficers is usually a field representing a list of key individuals (e.g., CEO, CFO) responsible for an entity (business, organization, etc.)

Allowed Entity Officers Designations:
\n
CEO
\n
CFO
\n
CIO
\n
CTO
\n
President
\n
Other (requires otherDesignation)
\n

Note : Maximum of 5 entityOfficers details can be added.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`firstName`	String	Yes	First name of the entity officer	John
`lastName`	String	Yes	Last name of the entity officer	anderson
`designation`	String	Yes	Designation of the officer	CEO
`otherDesignation`	String	No	Other designation (if designation is other)	Vice President
`phone`	String	No	Phone number of the officer	2079460XXX
`email`	String	Yes	Email address of the officer	[john.anderson@demo.com](https://mailto:john.anderson@abccompany.com)

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Entity officers' info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/NUMXXXXXX105/entity-officers
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains hyperlinks for next actions or related endpoints	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\"}
`links.nextAction`	String	URL path for the next API step	/api/v1/entity/NUMXXXXXX105/billing-rcd-info

Input Validation

Name	Required	Message	Custom Error Code	HTTP Status Code	Http Status Text
`Input array size`	Yes	\"entityOfficers cannot be empty.\"	INVALID_ENTITY_OFFICERS	400	Bad Request
`firstName`	Yes	EntityOfficer:firstName cannot be null or blank.	INVALID_ENTITY_OFFICER_FIRSTNAME	400	Bad Request
`firstName`	Yes	EntityOfficer:firstName maximum length is 100 characters.	INVALID_FIRSTNAME_SIZE	400	Bad Request
`firstName`	Yes	EntityOfficer:firstName must contain only alphabetic characters and spaces.	INVALID_FIRSTNAME_PATTERN	400	Bad Request
`lastName`	Yes	EntityOfficer:lastName cannot be null or blank.	INVALID_LASTNAME_NULL	400	Bad Request
`lastName`	Yes	EntityOfficer:lastName maximum length is 100 characters.	INVALID_LASTNAME_SIZE	400	Bad Request
`lastName`	Yes	EntityOfficer:lastName must contain only alphabetic characters and spaces.	INVALID_LASTNAME_PATTERN	400	Bad Request
`designation`	yes	EntityOfficer:designation cannot be null or blank.	INVALID_DESIGNATION_NULL	400	Bad Request
`designation`	Yes	EntityOfficer:designation maximum length is 100 characters.	INVALID_DESIGNATION_SIZE	400	Bad Request
`otherDesignation`	No	EntityOfficer:otherDesignation maximum length is 100 characters.	INVALID_OTHER_DESIGNATION_SIZE	400	Bad Request
`phoneNumber`	Yes	EntityOfficer:phonenumber must contain 10 digits.	INVALID_PHONE_PATTERN	400	Bad Request
`email`	Yes	EntityOfficer:Please enter valid email.	INVALID_EMAIL_PATTERN	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_OFFICER_DESIGNATION	Invalid entity officer designation {0}.	422	Unprocessable Content
INVALID_OFFICER_OTHER_DESIGNATION	Invalid OfficerOtherDesignation {0}. Ensure that the designation value is set to Other(OTH).Invalid \"State\"	422	Unprocessable Content
PLEASE_ENTER_OFFICER_OTHER_DESIGNATION	Please enter officer otherDesignation.	422	Unprocessable Content

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","entity-officers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"feb4f17f-fdc3-4f14-9965-7274bd8e5483","name":"201-Created-EntityOfficers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \r\n \"entityOfficers\": [\r\n {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"designation\": \"CEO\",\r\n \"phone\": \"85XXXX1488\",\r\n \"email\": \"john.anderson@abctesting.com\"\r\n \r\n },\r\n {\r\n \"firstName\": \"sarah\",\r\n \"lastName\": \"parker\",\r\n \"designation\": \"Other\",\r\n \"phone\": \"85XXXX1499\",\r\n \"email\": \"sarah.parker@abctesting.com\",\r\n \"otherDesignation\": \"Vice President\"\r\n },\r\n {\r\n \"firstName\": \"david\",\r\n \"lastName\": \"wilson\",\r\n \"designation\": \"CTO\",\r\n \"phone\": \"85XXXX1499\",\r\n \"email\": \"david.wilson@abctesting.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T11:27:15Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity officers info saved successfully. Proceed to the next step.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\",\n \"data\": {\n \"entityCode\": \"NUMXXXXXX105\",\n \"entityStatus\": \"New\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\"\n }\n}"},{"id":"2066ef30-136d-490c-ace6-0383df5fe9ce","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \r\n \"entityOfficers\": [\r\n {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"designation\": \"CEO\",\r\n \"phone\": \"85XXXX1488\",\r\n \"email\": \"john.anderson@demo.com\"\r\n \r\n },\r\n {\r\n \"firstName\": \"sarah\",\r\n \"lastName\": \"parker\",\r\n \"designation\": \"Other\",\r\n \"phone\": \"85XXXX14\",\r\n \"email\": \"sarah.parker@demo\",\r\n \"otherDesignation\": \"Vice President\"\r\n },\r\n {\r\n \"firstName\": \"david\",\r\n \"lastName\": \"wilson\",\r\n \"designation\": \"CTO\",\r\n \"phone\": \"85XXXX1499\",\r\n \"email\": \"david.wilson@demo.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:56:32:32Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\",\n \"details\": [\n {\n \"field\": \"entityOfficers[1].phone\",\n \"issue\": \"EntityOfficer:phoneNumber must contain 10 digits.\",\n \"customCode\": \"INVALID_ENTITY_OFFICER_PHONE_NUMBER_LENGTH\"\n },\n {\n \"field\": \"entityOfficers[1].email\",\n \"issue\": \"EntityOfficer:Please enter valid email.\",\n \"customCode\": \"INVALID_ENTITY_OFFICER_EMAIL\"\n }\n ]"},{"id":"57e22c83-9d62-40b3-89fd-de9b4a3eaa16","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \r\n \"entityOfficers\": [\r\n {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"designation\": \"CEO\",\r\n \"phone\": \"85XXXX1488\",\r\n \"email\": \"john.anderson@demo.com\"\r\n \r\n },\r\n {\r\n \"firstName\": \"sarah\",\r\n \"lastName\": \"parker\",\r\n \"designation\": \"Other\",\r\n \"phone\": \"85XXXX14\",\r\n \"email\": \"sarah.parker@demo\",\r\n \"otherDesignation\": \"Vice President\"\r\n },\r\n {\r\n \"firstName\": \"david\",\r\n \"lastName\": \"wilson\",\r\n \"designation\": \"ABC\",\r\n \"phone\": \"85XXXX1499\",\r\n \"email\": \"david.wilson@demo.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:18:09:09Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\",\n \"details\": [\n {\n \"issue\": \"Invalid entity officer designation ABC.\",\n \"customCode\": \"ENTITY_OFFICER_DESIGNATION\"\n }\n ]\n}"}],"_postman_id":"14c93a61-9f93-4e7a-86a1-630d172ebf04"},{"name":"Billing-RCD-INFO","id":"b71be01a-7775-4ef2-9dde-4745efad1ed1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"countryAbbr\": \"US\",\r\n \"designation\": \"CEO\",\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"Michael\",\r\n \"lastName\": \"roberts\",\r\n \"phone\": \"2079460XXX\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"AK\",\r\n \"zipCode\": \"839389\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"michael\",\r\n \"lastName\": \"roberts\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info","description":"

Description

This endpoint is used to submit billing details and Rich Call Data (RCD) authorizer information for a specified business entity.

The billing section captures full contact and address information required for invoicing and official communication.

The RCD authorizer section identifies the individual responsible for authorizing the use of RCD features (e.g., logos, call reasons, branding metadata) associated with the entity’s phone numbers.

Note: Only the root entity will have businessEntityBillingDetails. For assigned entities, exclude this object from the request payload.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Request Parameters:

Name	Type	Required	Description	Example
`businessEntityBillingDetails.addressLine1`	string	Yes	First line of the billing address for the business entity.	\"123 Main Street\"
`businessEntityBillingDetails.addressLine2`	string	No	Second line of the billing address (e.g., suite, apartment).	\"Suite 201\"
`businessEntityBillingDetails.city`	string	Yes	City of the billing address.	\"McLean\"
`businessEntityBillingDetails.countryAbbr`	string	Yes	Two-letter country abbreviation (ISO 3166-1 alpha-2).	US
`businessEntityBillingDetails.designation`	string	Yes	Job title or designation of the contact person.	\"CEO\"
`businessEntityBillingDetails.email`	string	Yes	Email address of the billing contact.	\"michael.roberts@demo.com\"
`businessEntityBillingDetails.firstName`	string	Yes	First name of the billing contact person.	\"Michael\"
`businessEntityBillingDetails.lastName`	string	Yes	Last name of the billing contact person.	\"Roberts\"
`businessEntityBillingDetails.phone`	string	Yes	Phone number of the billing contact.	2079460XXX
`businessEntityBillingDetails.stateCode`	string	Yes	Two-letter state code.	\"AK\"
`businessEntityBillingDetails.zipCode`	string	Yes	ZIP or postal code of the billing address.	\"839389\"
`rcdAuthorizer.email`	string	Yes	Email address of the RCD authorizer.	\"michael.roberts@demo.com\"
`rcdAuthorizer.firstName`	string	Yes	First name of the RCD authorizer.	\"Michael\"
`rcdAuthorizer.lastName`	string	Yes	Last name of the RCD authorizer.	\"Roberts\"
`businessEntityBillingDetails.country`	String	Yes	Billing country (ISO 3166-1 alpha-2). Preferred over countryAbbr.	US
`businessEntityBillingDetails.subdivisionType`	String (Enum)	Yes	Billing region type. US: `STATE`.	STATE
`businessEntityBillingDetails.subdivisionCode`	String	Yes	Billing region code (e.g. TX).	TX

i18n

Region fields (i18n)

US backward compatible

On businessEntityBillingDetails, prefer country + subdivisionType + subdivisionCode instead of countryAbbr + stateCode. Send one pattern only. rcdAuthorizer is unchanged.

countryUS ISO 3166-1 alpha-2 country on businessEntityBillingDetailssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"businessEntityBillingDetails\": {\n    \"countryAbbr\": \"US\",\n    \"stateCode\": \"TX\"\n  }\n}\n\n

Preferred

{\n  \"businessEntityBillingDetails\": {\n    \"country\": \"US\",\n    \"subdivisionType\": \"STATE\",\n    \"subdivisionCode\": \"TX\"\n  }\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-07-08T13:00:00Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Billing-rcd info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/NUMXXXXXX105/billing-rcd-info
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains links for related endpoints or next actions	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/business-info\"}
`links.nextAction`	String	URL path for the next step in the API flow	/api/v1/entity/NUMXXXXXX105/business-info

Input Validation

Billing details

Name	Message	Custom Error Code	HTTP Status Code	Http Status Text
`addressLine1`	BillingDetails:AddressLine1 must be a maximum of 100 characters.	INVALID_BILLING_DETAILS_ADDRESS_LINE1	400	Bad Request
`addressLine1`	BillingDetails:AddressLine1 must be a maximum of 100 characters.	INVALID_BILLING_DETAILS_ADDRESS_LINE1_LENGTH	400	Bad Request
`addressLine2`	BillingDetails:AddressLine2 must be a maximum of 100 characters.	INVALID_BILLING_DETAILS_ADDRESS_LINE2_LENGTH	400	Bad Request
`zipCode`	BillingDetails: ZipCode cannot be null or blank.	INVALID_BILLING_DETAILS_ZIPCODE	400	Bad Request
`zipCode`	BillingDetails:ZipCode must be between 1 and 10 digits long.	INVALID_BILLING_DETAILS_ZIPCODE_LENGTH	400	Bad Request
`zipCode`	BillingDetails:ZipCode must contain only digits.	INVALID_BILLING_DETAILS_ZIPCODE	400	Bad Request
`stateCode`	INVALID_BILLING_DETAILS_STATE_CODE	BillingDetails: StateCode cannot be null or blank.	400	Bad Request
`stateCode`	INVALID_BILLING_DETAILS_STATE	BillingDetails:StateCode must contain only alphabetic characters.	400	Bad Request
`city`	INVALID_BILLING_DETAILS_CITY	BillingDetails: City cannot be null or blank.	400	Bad Request
`city`	INVALID_BILLING_DETAILS_CITY_LENGTH	BillingDetails:City must be between 3 and 20 characters.	400	Bad Request
`country`	INVALID_BILLING_DETAILS_COUNTRY	BillingDetails: City cannot be null or blank.	400	Bad Request
`country`	INVALID_BILLING_DETAILS_COUNTRY_LENGTH	BillingDetails:CountryAbbr must be between 1 and 20 characters.	400	Bad Request
`country`	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	UNSUPPORTED_COUNTRY_CODE	400	Bad Request
`firstName`	INVALID_BILLING_DETAILS_FIRST_NAME	BillingDetails:FirstName cannot be null or blank.	400	Bad Request
`firstName`	INVALID_BILLING_DETAILS_FIRST_NAME_LENGTH	BillingDetails:FirstName must be between 3 and 100 characters.	400	Bad Request
`lastName`	INVALID_BILLING_DETAILS_LAST_NAME	BillingDetails:LastName cannot be null or blank.	400	Bad Request
`lastName`	INVALID_BILLING_DETAILS_LAST_NAME_LENGTH	BillingDetails:LastName must be between 3 and 100 characters.	400	Bad Request
`email`	INVALID_BILLING_DETAILS_EMAIL	BillingDetails:Email cannot be null or blank.	400	Bad Request
`designation`	INVALID_BILLING_DETAILS_DESIGNATION	BillingDetails: Designation cannot be null or blank.	400	Bad Request
`designation`	INVALID_BILLING_DETAILS_DESIGNATION_LENGTH	BillingDetails:Designation must be a maximum of 100 characters.	400	Bad Request
`otherDesignation`	INVALID_BILLING_DETAILS_OTHER_DESIGNATION_LENGTH	BillingDetails:OtherDesignation must be a maximum of 100 characters.	400	Bad Request
`phone`	INVALID_BILLING_DETAILS_PHONE	BillingDetails:Phone cannot be null or blank.	400	Bad Request
`phone`	INVALID_BILLING_DETAILS_PHONE_LENGTH	BillingDetails:Phone must be 10 digits and only contain digits.	400	Bad Request

RCD authorizer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Message	Custom Error Code	HTTP Status Code	Http Status Text
`firstName`	RCDAuthorizer:FirstName cannot be null or blank	INVALID_FIRSTNAME	400	Bad Request
`firstName`	RCDAuthorizer:FirstName maximum length is 100 characters	INVALID_FIRSTNAME_SIZE	400	Bad Request
`firstName`	RCDAuthorizer:FirstName must contain only alphabetic characters and spaces	INVALID_FIRSTNAME_PATTERN	400	Bad Request
`lastName`	RCDAuthorizer:LastName cannot be null or blank	INVALID_LASTNAME	400	Bad Request
`lastName`	RCDAuthorizer:LastName maximum length is 100 characters	INVALID_LASTNAME_SIZE	400	Bad Request
`lastName`	RCDAuthorizer:LastName must contain only alphabetic characters and spaces	INVALID_LASTNAME_PATTERN	400	Bad Request
`email`	RCDAuthorizer:Email cannot be null or blank	INVALID_EMAIL_NULL	400	Bad Request
`email`	RCDAuthorizer:Please enter valid email.	INVALID_EMAIL_PATTERN	400	Bad Request

Business Validations

Business Validations◀▶

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
MISSING_BILLING_DETAILS_FOR_ROOT	EntityBusinessDetails cannot be null and blank.	422	Unprocessable Content
BILLING_DETAILS_NOT_ALLOWED_FOR_ASSIGNED	EntityBillingDetails should be blank or null while creating Entity when entityType is Assigned.	422	Unprocessable Content

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","billing-rcd-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"a61d242d-06eb-419b-9bf1-9a1c0c764bac","name":"201-Created-Billing-RCD-INFO_Root","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"designation\": \"CEO\",\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"Michael\",\r\n \"lastName\": \"roberts\",\r\n \"phone\": \"85XXXX1488\",\r\n \"zipCode\": \"839389\",\r\n \"country\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"AK\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"michael\",\r\n \"lastName\": \"roberts\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2026-09-01T11:38:22Z\",\r\n \"status\": \"SUCCESS\",\r\n \"message\": \"Entity Additional Contacts saved successfully. Proceed to the next step.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\",\r\n \"data\": {\r\n \"entityCode\": \"NUMXXXXXX105\",\r\n \"entityStatus\": \"New\"\r\n },\r\n \"links\": {\r\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/business-info\"\r\n }\r\n}"},{"id":"c070f232-f0b2-490b-99ac-293eaef45fec","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"countryAbbr\": \"US\",\r\n \"designation\": \"CEO\",\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"Michael\",\r\n \"lastName\": \"roberts\",\r\n \"phone\": \"85XXXX1488\",\r\n \"stateCode\": \"AK\",\r\n \"zipCode\": \"839389\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"email\": \"michael.roberts@com\",\r\n \"firstName\": \"michael\",\r\n \"lastName\": \"roberts\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T01:16:16:16Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\",\n \"details\": [\n {\n \"field\": \"rcdAuthorizer.email\",\n \"issue\": \"RCDAuthorizer:Please enter valid email.\",\n \"customCode\": \"INVALID_RCD_AUTHORIZER_EMAIL\"\n }\n ]\n}"},{"id":"165e3835-3882-48dc-886a-0015e22beca0","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main Street\",\r\n \"addressLine2\": \"Suite 201\",\r\n \"city\": \"McLean\",\r\n \"countryAbbr\": \"US\",\r\n \"designation\": \"CEO\",\r\n \"email\": \"michael.roberts@demo.com\",\r\n \"firstName\": \"Michael\",\r\n \"lastName\": \"roberts\",\r\n \"phone\": \"85XXXX1488\",\r\n \"stateCode\": \"XZ\",\r\n \"zipCode\": \"839389\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"email\": \"michael.roberts@com\",\r\n \"firstName\": \"michael\",\r\n \"lastName\": \"roberts\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:22:34:34Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\",\n \"details\": [\n {\n \"issue\": \"Invalid State\",\n \"customCode\": \"INVALID_STATE_CODE\"\n }\n ]\n}\n"}],"_postman_id":"b71be01a-7775-4ef2-9dde-4745efad1ed1"},{"name":"Business-info","id":"c578651a-5752-4001-966e-21083f6733e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543436\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": \"associations\",\r\n \"licenseType\": \"ABC Testing\",\r\n \"professionalLicense\": \"Testing 12343\",\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AK\",\r\n \"fileNumber\": \"Y13me3255\"\r\n },\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AR\",\r\n \"fileNumber\": \"Y13me1000\"\r\n }\r\n ]\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Registered Office Services Ltd\",\r\n \"address\": \"1 Example Street\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"22XX2\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info","description":"

Description

This endpoint allows submission of detailed business information for a given entity.

It includes the business's legal structure, incorporation details, industry classification, and regulatory identifiers (e.g., EIN, DUNS, LEI).

Registry profile by principal address

The below fields are applicable as per the Entity principal address country:

eins, duns, stateOfIncorporation[]

Allowed industry associations

ICL
\n
ACA
\n
Other — requires otherIndustryAssociation
\n

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Request Parameters:

Name	Type	Required	Description	Example
`entityBusinessDetails.year`	integer	Yes	Year the business was established.	2020
`entityBusinessDetails.legalStructure`	string	Yes	Legal structure of the business.	\"Corporation\"
`entityBusinessDetails.type`	string	Yes	Business type.	\"PRI\"
`entityBusinessDetails.businessIndustry`	string	Yes	Industry code or abbreviation of the business.	\"MD\"
`entityBusinessDetails.otherBusinessIndustry`	string	No	Specify other industry if not listed.	null
`entityBusinessDetails.naicsCode`	string	No	North American Industry Classification System (NAICS) code.	\"888543436\"
`entityBusinessDetails.noOfEmployees`	string	Yes	Number of employees in the organization.	\"222\"
`entityBusinessDetails.ticker`	string	No	Stock ticker symbol.	\"888543436\"
`entityBusinessDetails.eins`	string	Conditional	US principal only.** Employer Identification Number (EIN).	\"888543436\"
`entityBusinessDetails.duns`	string	No	Data Universal Numbering System (DUNS) number.	\"888543436\"
`entityBusinessDetails.lei`	string	No	Legal Entity Identifier (LEI).	\"Demos\"
`entityBusinessDetails.industryAssociations[]`	array of strings	No	List of industry associations the business is a member of.	[\"ICL\"]
`entityBusinessDetails.otherIndustryAssociation`	string	No	Specify other industry association if not listed.	\"associations\"
`entityBusinessDetails.stateOfIncorporation[]`	array	Conditional	US principal only.
`entityBusinessDetails.stateOfIncorporation[].countryAbbr`	string	Conditional	Incorporation country (US).	US
`entityBusinessDetails.stateOfIncorporation[].stateCode`	string	Conditional	US state code.	\"AK\"
`entityBusinessDetails.stateOfIncorporation[].fileNumber`	string	Conditional	Incorporation file number.	\"Y13me3255\"
`stateOfIncorporation[].country`	String	Conditional	US principal only. Incorporation jurisdiction country (preferred over countryAbbr).	US
`stateOfIncorporation[].subdivisionType`	String	Conditional	US principal only. Incorporation region type. US: `STATE`.	STATE
`stateOfIncorporation[].subdivisionCode`	String	Conditional	US principal only. Incorporation region code.	DE
`registeredAgent.country`	String	Yes	Registered agent country (preferred over countryAbbr).	US
`registeredAgent.subdivisionType`	String	Yes	Registered agent region type.	STATE
`registeredAgent.subdivisionCode`	String	Yes	Registered agent region code.	DE

i18n

Region fields (i18n)

US backward compatible

stateOfIncorporation[] and eins are US principal only. On US stateOfIncorporation[] rows and registeredAgent, prefer country + subdivisionType + subdivisionCode (countryAbbr/stateCode still accepted).

countryUS ISO 3166-1 alpha-2 country on incorporation / registered agentsubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"countryAbbr\": \"US\",\n  \"stateCode\": \"DE\",\n  \"fileNumber\": \"1234567\"\n}\n\n

Preferred

{\n  \"country\": \"US\",\n  \"subdivisionType\": \"STATE\",\n  \"subdivisionCode\": \"DE\",\n  \"fileNumber\": \"1234567\"\n}\n\n

Response Parameters:

Response Parameters◀▶

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Business info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/NUMXXXXXX105/business-info
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains hyperlinks for next actions or related endpoints	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/communication-info\"}
`links.nextAction`	String	URL path for the next API step	/api/v1/entity/NUMXXXXXX105/communication-info

Input Validation

Business details

Name	Message	Custom Error Code	HTTP Status Code	Http Status Text
`year`	BusinessDetails:year cannot be blank or null.	INVALID_YEAR	400	Bad Request
`legalStructure`	BusinessDetails:legalStructure cannot be blank or null.	INVALID_LEGALSTRUCTURE	400	Bad Request
`legalStructure`	BusinessDetails:legalStructure maximum length is 100 characters	INVALID_LEGALSTRUCTURE_SIZE	400	Bad Request
`type`	BusinessDetails:type cannot be blank or null.	INVALID_TYPE	400	Bad Request
`type`	BusinessDetails:type cannot be empty, at least one must be selected.	INVALID_TYPE_SIZE	400	Bad Request
`businessIndustry`	BusinessDetails:businessIndustry cannot be blank or null.	INVALID_BUSINESSINDUSTRY	400	Bad Request
`businessIndustry`	BusinessDetails:businessIndustry maximum length is 100 characters.	INVALID_BUSINESSINDUSTRY_SIZE	400	Bad Request
`otherBusinessIndustry`	BusinessDetails:otherBusinessIndustry maximum length is 100 characters.	INVALID_OTHERBUSINESSINDUSTRY_SIZE	400	Bad Request
`naicsCode`	BusinessDetails:naicsCode maximum length is 100 characters.	INVALID_NAICSCODE_SIZE	400	Bad Request
`noOfEmployees`	BusinessDetails:noOfEmployees cannot be blank or null.	INVALID_NOOFEMPLOYEES	400	Bad Request
`noOfEmployees`	BusinessDetails:noOfEmployees must be a positive number.	INVALID_NOOFEMPLOYEES_PATTERN	400	Bad Request
`ticker`	BusinessDetails:ticker maximum length is 100 characters	INVALID_TICKER_SIZE	400	Bad Request
`eins`	BusinessDetails:eins maximum length is 100 characters	INVALID_EINS_SIZE	400	Bad Request
`eins`	BusinessDetails:Invalid eins format. Allowed: 'XX-XXXXXXX' or 'XXXXXXXXX'.	INVALID_EINS_PATTERN	400	Bad Request
`duns`	BusinessDetails:duns maximum length is 100 characters	INVALID_DUNS_SIZE	400	Bad Request
`lei`	BusinessDetails:lei maximum length is 100 characters.	INVALID_LEI_SIZE	400	Bad Request
`lei`	BusinessDetails:lei must contain only alphabetic characters	INVALID_LEI_PATTERN	400	Bad Request
`otherIndustryAssociation`	BusinessDetails:otherIndustryAssociation maximum length is 100 characters.	INVALID_OTHERINDUSTRYASSOCIATION_SIZE	400	Bad Request
`stateOfIncorporation`	BusinessDetails:stateOfIncorporation:stateCode cannot be null or blank.	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_STATE_INVALID	400	Bad Request
`validateFileNumber`	BusinessDetails:stateOfIncorporation:fileNumber cannot be null or blank.	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_FILE_NUM_INVALID	400	Bad Request

Registered agent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Error Code	Error Message	HTTP Status Code	Http Status Text
`name`	INVALID_Registered_AGENT_NAME_LENGTH	Registered:Name must be a maximum of 20 characters.	400	Bad Request
`address`	INVALID_Registered_AGENT_ADDRESS_LENGTH	RegisteredAgent:Address must be a maximum of 100 characters.	400	Bad Request
`zipCode`	INVALID_Registered_AGENT_ZIPCODE_LENGTH	RegisteredAgent:ZipCode must be between 1 and 10 digits long.	400	Bad Request
`zipCode`	INVALID_Registered_AGENT_ZIPCODE	RegisteredAgent:ZipCode must contain only digits.	400	Bad Request
`stateCode`	INVALID_Registered_AGENT_STATE_LENGTH	RegisteredAgent:StateCode must be between 2 and 10 characters.	400	Bad Request
`stateCode`	INVALID_Registered_AGENT_STATE_FORMAT	RegisteredAgent:StateCode must contain only alphabetic characters.	400	Bad Request
`city`	INVALID_Registered_AGENT_CITY_LENGTH	RegisteredAgent:City must be between 2 and 10 characters.	400	Bad Request
`city`	INVALID_Registered_AGENT_CITY_FORMAT	RegisteredAgent:City must contain only alphabetic characters.	400	Bad Request
`countryAbbr`	INVALID_Registered_AGENT_COUNTRY_LENGTH	RegisteredAgent:CountryAbbr must be between 2 and 20 characters.	400	Bad Request
`licenseType`	INVALID_Registered_AGENT_LICENSE_LENGTH	RegisteredAgent:License Type must be a maximum of 100 characters.	400	Bad Request
`professionalLicense`	INVALID_Registered_AGENT_PROFESSIONAL_LENGTH	RegisteredAgent:Professional License must be a maximum of 100 characters.	400	Bad Request

Business Validations

Principal country is resolved from the entity primary address, not from this payload. Lookup APIs: GET /api/v1/business-types (type), GET /api/v1/industry-types (businessIndustry)

Profile	Custom Error Code	Message	HTTP Status	HTTP Status Text
All	INVALID_YEAR	Invalid year {0}. The year must be within the range of 1600 to the current year.	422	Unprocessable Entity
All	INVALID_BUSINESS_TYPE	Invalid \"Business Type\"	422	Unprocessable Entity
All	INVALID_INDUSTRY_TYPE	Invalid Industry {0}.	422	Unprocessable Entity
All	PLEASE_ENTER_OTHER_BUSINESS_INDUSTRY	Please enter other business industry.	422	Unprocessable Entity
All	INVALID_OTHER_BUSINESS_INDUSTRY	Invalid other business industry {0}.	422	Unprocessable Entity
All	INVALID_LEI	BusinessDetails:lei must be exactly 20 alphanumeric characters.	422	Unprocessable Entity
All	INVALID_REGISTERED_AGENT_COUNTRY	Registered Agent Country is invalid.	422	Unprocessable Entity
All	INVALID_SUBDIVISION_TYPE	subdivisionType is invalid for the selected country.	400	Bad Request
All	INVALID_SUBDIVISION_CODE	Invalid subdivision code for country.	400	Bad Request
All	INVALID_COUNTY	county maximum length is 100 characters.	422	Unprocessable Entity
All	INVALID_REGISTERED_AGENT_ZIP	RegisteredAgent:zipCode format is invalid for the selected country.	422	Unprocessable Entity
US	EINS_OR_DUNS	Either EIN or DUNS values is mandatory.	422	Unprocessable Entity
US	INVALID_ENTITY_INDUSTRY_ASSOCIATIONS	Invalid industry associations {0}.	422	Unprocessable Entity
US	INVALID_ENTITY_OTHER_INDUSTRY_ASSOCIATIONS	Invalid OtherIndustryAssociations {0}. Ensure that the Industry Associations list include Other(OTH).	422	Unprocessable Entity
US	INVALID_OTHER_INDUSTRY_ASSOCIATION	Invalid OtherIndustryAssociation {0}.	422	Unprocessable Entity
US	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_COUNTRY_INVALID	country cannot be null or blank. / Invalid country code.	400	Bad Request
US	INVALID_SUBDIVISION_CODE	Invalid subdivision for incorporation jurisdiction.	422	Unprocessable Entity
US	MISSING_REQUIRED_FIELD	missing required field: subdivisionCode	422	Unprocessable Entity
US	INVALID_FILENUMBER	Invalid FileNumber, maximum length is 30 characters.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","business-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"e0e7f14d-494d-4c2d-a00d-955e2c1ba719","name":"201-Created-Business-info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543436\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": \"associations\",\r\n \"licenseType\": \"ABC Testing\",\r\n \"professionalLicense\": \"Testing 12343\",\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AK\",\r\n \"fileNumber\": \"Y13me3255\"\r\n },\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AR\",\r\n \"fileNumber\": \"Y13me1000\"\r\n }\r\n ]\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Registered Office Services Ltd\",\r\n \"address\": \"1 Example Street\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"22XX2\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2026-09-01T11:48:03Z\",\r\n \"status\": \"SUCCESS\",\r\n \"message\": \"Entity business info saved successfully. Proceed to the next step.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX105/business-info\",\r\n \"data\": {\r\n \"entityCode\": \"NUMXXXXXX105\",\r\n \"entityStatus\": \"New\"\r\n },\r\n \"links\": {\r\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/communication-info\"\r\n }\r\n}"},{"id":"1c6b74af-2894-4faa-9efa-4d2811cf2941","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543436\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": \"associations\",\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"A\",\r\n \"fileNumber\": \"Y13me3255\"\r\n }\r\n ]\r\n },\r\n \"registeredAgent\":{\r\n \"name\":\"sasi\",\r\n \"address\":\"Ongole\",\r\n \"zipCode\":\"545434\",\r\n \"city\":\"ongole\",\r\n \"stateCode\":\"AK\",\r\n \"countryAbbr\":\"US\",\r\n \"licenseType\":\"ABC Testing\",\r\n \"professionalLicense\":\"Testing 12343\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-10-10T13:24:27:27Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX105/business-info\",\r\n \"details\": [\r\n {\r\n \"field\": \"entityBusinessDetails.legalStructure\",\r\n \"issue\": \"BusinessDetails:legalStructure maximum length is 100 characters.\",\r\n \"customCode\": \"INVALID_BUSINESS_DETAILS_LEGAL_STRUCTURE_LENGTH\"\r\n },\r\n {\r\n \"field\": \"entityBusinessDetails.legalStructure\",\r\n \"issue\": \"BusinessDetails:legalStructure cannot be blank or null.\",\r\n \"customCode\": \"INVALID_BUSINESS_DETAILS_LEGAL_STRUCTURE\"\r\n }\r\n ]\r\n}"},{"id":"fb87405c-6beb-4b4b-97b0-ff1f3d216056","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543436\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": \"associations\",\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"A\",\r\n \"fileNumber\": \"Y13me3255\"\r\n }\r\n ]\r\n },\r\n \"registeredAgent\":{\r\n \"name\":\"sasi\",\r\n \"address\":\"Ongole\",\r\n \"zipCode\":\"545434\",\r\n \"city\":\"ongole\",\r\n \"stateCode\":\"AK\",\r\n \"countryAbbr\":\"US\",\r\n \"licenseType\":\"ABC Testing\",\r\n \"professionalLicense\":\"Testing 12343\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-08-11T01:10:47:47Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Business Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX105/business-info\",\r\n \"details\": [\r\n {\r\n \"issue\": \"Invalid State\",\r\n \"customCode\": \"INVALID_STATE_CODE\"\r\n }\r\n ]\r\n}"}],"_postman_id":"c578651a-5752-4001-966e-21083f6733e8"},{"name":"Communication-info","id":"3e3d093c-0de1-44f5-93f4-accbaf47b6df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \"type\": [\r\n \"B2C\"\r\n ],\r\n \"customerRelationship\": [\r\n \"ECL\"\r\n ],\r\n \"existingPeriod\": [\r\n \"06M\"\r\n ],\r\n \"descriptionOfCalls\": \"ABC Inc\",\r\n \"consentManagement\": \"Calls to existing and prospective customers to generate the sale of goods or services.\",\r\n \"consumerComplaintEmail\": \"numeservices@demo.com\",\r\n \"consumerComplaintPhone\": \"2079460XXX\",\r\n \"linkToDataPrivacy\": \"https://www.demo.com\",\r\n \"autoDialer\": false,\r\n \"autoDialerToCell\": true,\r\n \"numberOfMonths\": 9,\r\n \"communicationsSubdivisions\": [\r\n {\r\n \"countryCode\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionSelectionMode\": \"SPECIFIC\",\r\n \"subdivisionCodes\": [\r\n \"VA\"\r\n ]\r\n }\r\n ],\r\n \"communicationPrograms\": [\r\n \"MKAD\",\r\n \"RETP\"\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info","description":"

Description

Adds the communication details for the specified entity, including the business communication type, customer relationship, email addresses, and other contact information used for official correspondence. Calling area is configured per country in communicationsSubdivisions[]. Each row requires subdivisionSelectionMode: ALL (all subdivisions; omit subdivisionCodes), SPECIFIC (inclusive list in subdivisionCodes), or ALL_EXCEPT (exclusion list in subdivisionCodes).

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Request Parameters:

Name	Type	Required	Description	Example
`type`	Array of String	Yes	Type of communication	[\"B2C\"]
`customerRelationship`	Array of String	Yes	Relationship with customers	[\"ECL\"]
`existingPeriod`	Array of String	Conditional	Duration of existing relationship	[\"06M\"]. Required when customerRelationship includes \"ECL\"; omit otherwise
`descriptionOfCalls`	String	Yes	Brief description of call content	\"ABC Inc\"
`consentManagement`	String	Yes	Explanation of how consent for calls is managed	\"Calls to existing and prospective customers to generate the sale of goods or services.d\"
`consumerComplaintEmail`	String	Yes	Email for handling consumer complaints	\"numeservices@gmail.com\"
`consumerComplaintPhone`	String	Yes	Phone number for consumer complaints	2079460XXX
`linkToDataPrivacy`	String (URL)	Yes	Link to entity’s data privacy policy	\"https://www.ABC.com\"
`autoDialer`	Boolean	Yes	Whether autodialer is used for calls	false
`autoDialerToCell`	Boolean	Yes	Whether autodialer is used for cell calls	true
`programDescription`	String	Yes	Description of communication program	\"Service\"
`numberOfMonths`	Integer	Conditional	Number of months since the advertisement inquiry. Required when communicationPrograms includes \"MKAD\"; omit otherwise	9
`communicationsSubdivisions[]`	Array	Yes	Per-country calling-area rows (one per country).
`communicationsSubdivisions[].countryCode`	String	Yes	ISO 3166-1 alpha-2 country code.	US
`communicationsSubdivisions[].subdivisionType`	String	Yes	Region type (US: `STATE`).	\"STATE\"
`communicationsSubdivisions[].subdivisionSelectionMode`	String (enum)	Yes	ALL, SPECIFIC, or ALL_EXCEPT.	\"SPECIFIC\"
`communicationsSubdivisions[].subdivisionCodes`	Array of String	Conditional	Required when mode is `SPECIFIC` (include list) or `ALL_EXCEPT` (exclude list). Omit or `[]` when `ALL`.	[\"AK\"]
`communicationPrograms`	Array of String	No	Optional programs under which communication is conducted	[\"MKAP\", \"RETP\"]

Region fields (i18n)

US backward compatible

Prefer communicationsSubdivisions[] under entityCommunicationDetails instead of communicationsStates (US only). Each row requires subdivisionSelectionMode (ALL, SPECIFIC, or ALL_EXCEPT) per country.

countryCodeUS Country on each communicationsSubdivisions[] rowsubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"communicationsStates\": {\n    \"countryCode\": \"US\",\n    \"stateCodes\": [\"TX\", \"CA\"]\n  }\n}\n\n

Preferred

{\n  \"communicationsSubdivisions\": [{\n    \"countryCode\": \"US\",\n    \"subdivisionType\": \"STATE\",\n    \"subdivisionSelectionMode\": \"SPECIFIC\",\n    \"subdivisionCodes\": [\"TX\", \"CA\"]\n  }]\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Communication info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/communication-info
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"INTXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	INTXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains hyperlinks for next actions or related endpoints	{\"nextAction\": \"/api/v1/entity/INTXXXXXX105/email-notification\"}
`links.nextAction`	String	URL path for the next API step	/api/v1/entity/INTXXXXXX105/email-notification

Input Validation

Name	Message	Custom Error Code	HTTP Status Code	Http Status Text
`type`	CommunicationDetails:type cannot be null or blank.	INVALID_TYPE_NULL	400	Bad Request
`type`	CommunicationDetails:type cannot be empty, at least one must be selected.	INVALID_TYPE_SIZE	400	Bad Request
`customerRelationship`	CommunicationDetails:customerRelationship cannot be null or blank.	INVALID_CUSTOMERRELATIONSHIP	400	Bad Request
`customerRelationship`	CommunicationDetails:customerRelationship cannot be empty, at least one must be selected.	INVALID_CUSTOMERRELATIONSHIP_SIZE	400	Bad Request
`descriptionOfCalls`	CommunicationDetails:descriptionOfCalls cannot be null or blank.	INVALID_DESCRIPTIONOFCALLS_NULL	400	Bad Request
`descriptionOfCalls`	CommunicationDetails:descriptionOfCalls maximum length is 5000.	INVALID_DESCRIPTIONOFCALLS_SIZE	400	Bad Request
`consentManagement`	CommunicationDetails:consentManagement cannot be null or blank.	INVALID_CONSENTMANAGEMENT_NULL	400	Bad Request
`consentManagement`	CommunicationDetails:consentManagement maximum length is 5000.	INVALID_CONSENTMANAGEMENT_SIZE	400	Bad Request
`consumerComplaintEmail`	CommunicationDetails:consumerComplaintEmail cannot be null or blank.	INVALID_CONSUMERCOMPLAINTEMAIL	400	Bad Request
`consumerComplaintEmail`	CommunicationDetails:Please enter valid email.	INVALID_CONSUMERCOMPLAINTEMAIL_PATTERN	400	Bad Request
`consumerComplaintPhone`	CommunicationDetails:consumerComplaintPhone cannot be null or blank.	INVALID_CONSUMERCOMPLAINTPHONE	400	Bad Request
`consumerComplaintPhone`	CommunicationDetails:consumerComplaintPhone must contain 10 digits.	INVALID_CONSUMERCOMPLAINTPHONE_PATTERN	400	Bad Request
`consumerComplaintPhone`	CommunicationDetails:consumerComplaintPhone length is 10 digit.	INVALID_CONSUMERCOMPLAINTPHONE_SIZE	400	Bad Request
`linkToDataPrivacy`	CommunicationDetails:linkToDataPrivacy cannot be null or blank.	INVALID_LINKTODATAPRIVACY	400	Bad Request
`linkToDataPrivacy`	CommunicationDetails:linkToDataPrivacy maximum length is 200	INVALID_LINKTODATAPRIVACY_SIZE	400	Bad Request
`autoDialer`	CommunicationDetails:autoDialer cannot be null or blank.	INVALID_AUTODIALER	400	Bad Request
`autoDialerToCell`	CommunicationDetails:autoDialerToCell cannot be null or blank.	INVALID_AUTODIALERTOCELL	400	Bad Request
`programDescription`	CommunicationDetails:programDescription cannot be blank	INVALID_PROGRAMDESCRIPTION_SIZE	400	Bad Request
`numberOfMonths`	CommunicationDetails:numberOfMonths cannot be blank	INVALID_NUMBEROFMONTHS	400	Bad Request
`numberOfMonths`	CommunicationDetails:numberOfMonths must be positive digits only	INVALID_NUMBEROFMONTHS_PATTERN	400	Bad Request
`communicationPrograms`	CommunicationDetails:programDescription cannot be null or blank.	INVALID_COMMUNICATION_DETAILS_PROGRAM_DESCRIPTION	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status	HTTP Status Text
INVALID_CUSTOMER_TYPE	Invalid \"Customer Type\"	422	Unprocessable Content
INVALID_CUSTOMER_RELATION	Invalid \"Customer Relation\"	422	Unprocessable Content
INVALID_EXISTING_PERIOD	Invalid \"Existing Period.\"	422	Unprocessable Content
INVALID_EXISTING_CLIENT	{0}` is not the correct client. `ExistingPeriod` is applicable only for existing clients (ECL).	422	Unprocessable Content
INVALID_STATE_COMMUNICATION	Invalid state code `{0}` in `entityCommunicationDetails`.	422	Unprocessable Content
INVALID_COMMUNICATION_PROGRAM	Invalid \"Communication Program\"	422	Unprocessable Content
INVALID_PROGRAM_DESCRIPTOR	Invalid ProgramDescriptor `{0}`. Ensure that `communicationPrograms` include \"WIEF\" as a program.	422	Unprocessable Content
INVALID_NUMBER_OF_MONTH	numberOfMonths` `{0}` value is considered only when `communicationPrograms` list includes \"MKAD\" as a program.	422	Unprocessable Content

Description

This endpoint is used to submit the completed entity profile for review, approval, or onboarding. Once all required sections (e.g., general info, officers, business info, communication details) have been completed and validated, this API triggers the formal submission process to move the entity into an approval state.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity (e.g., NUMXXXXXX105).

Response Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
timestamp	String	Date and time of the response in ISO 8601 format	`2026-09-01T12:53:51Z`
status	String	Status of the API call (e.g., SUCCESS, ERROR)	`SUCCESS`
message	String	Human-readable message about the API operation	`Entity submitted successfully for the approval process.`
path	String	The API endpoint path that was called	`/api/v1/entity/NUMXXXXXX105/submit`
data	Object	Contains response data relevant to the request	`{\"entityCode\": \"NUMXXXXXX105\", \"entityStatus\": \"Submitted\"}`
data.entityCode	String	Unique code identifying the entity	`NUMXXXXXX105`
data.entityStatus	String	Current status of the entity after submission	`Submitted`

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status	HTTP Status Text
MISSING_ENTITY_GENERAL_INFO	General Info is missing for entityCode : {0}.	422	Unprocessable Content
MISSING_ENTITY_OFFICERS	Entity officers list is empty for entityCode : {0}.	422	Unprocessable Content
MISSING_ADDITIONAL_RCD_AUTHORIZER	Additional contacts (Authorizer) are missing for entityCode : {0}.	422	Unprocessable Content
MISSING_ADDITIONAL_DETAILS_BILLING_DETAILS	Additional contacts (Billing Details) are missing for entityCode : {0}.	422	Unprocessable Content
MISSING_ENTITY_BUSINESS_DETAILS	Business information is missing for entityCode : {0}.	422	Unprocessable Content
MISSING_COMMUNICATION_INFO	Communication information is missing for entityCode : {0}.	422	Unprocessable Content

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","submit"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"67caaa92-7b92-48a3-ae0b-8cb59bcc7756","name":"200-OK-Submit","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/submit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2026-09-01T12:53:51Z\",\r\n \"status\": \"SUCCESS\",\r\n \"message\": \"Entity submitted successfully for the approval process.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX105/submit\",\r\n \"data\": {\r\n \"entityCode\": \"NUMXXXXXX105\",\r\n \"entityStatus\": \"Submitted\"\r\n },\r\n \"links\": {}\r\n}"},{"id":"63a37eb4-b88c-46c9-81fe-4959355f52d0","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/submit"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-08-11T01:37:14:14Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Business Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/entity/NUMXXXXXX10/submit\",\r\n \"details\": [\r\n {\r\n \"issue\": \"Invalid Entity Code INTXXXXXX105.\",\r\n \"customCode\": \"INVALID_ENTITY_CODE\"\r\n }\r\n ]\r\n}"}],"_postman_id":"812a13fe-7f13-4cde-a3f9-04b69e619818"},{"name":"EmailNotification","id":"b23ae3f2-8ca1-4277-8980-41113ff64cbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Health Check By Brand\",\r\n \"entityCode\": \"NUMXXXXXX105\",\r\n \"emailAddresses\": [\r\n \"alerts@example.com\",\r\n \"ops@example.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification","description":"

Description

The Email Notification API lets users set up and control notification preferences for an entity. It allows sending automated alerts (like risk rating updates or health check notifications) to designated email addresses linked to the entity.

Notification Types

1.Health Check By Brand

2.Health Check By Group

3.Risk Rating Changes

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Allowed Values / Format	Description
`notificationType`	string	Yes	1.Health Check By Brand 2.Health Check By Group 3.Risk Rating Changes	Type of notification being subscribed to or triggered.
`entityCode`	string	Yes	Alphanumeric with underscores and uppercase letters (e.g., ENT_PROTERA_HEALTH)	Unique identifier of the entity receiving notifications.
`emailAddresses`	array of string	Yes	Each must be a valid RFC 5322 email address	List of recipients for the notification. Must contain at least one address.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Entity email notification info saved successfully. Proceed to the next step.
`path`	String	The API endpoint path that was called	/api/v1/entity/email-notification
`data`	Object	Contains response data relevant to the request	{\"entityCode\": \"NUMXXXXXX105\"}
`data.entityCode`	String	Unique code identifying the entity	NUMXXXXXX105
`data.entityStatus`	String	Status of the Entity	\"New\"
`links`	Object	Contains hyperlinks for next actions or related endpoints	{\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/submit\"}
`links.nextAction`	String	URL path for the next API step	/api/v1/entity/NUMXXXXXX105/submit

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Error Code	Error Message	Http Status Code	Http Status Text
`notificationType`	INVALID_NOTIFICATION_TYPE	NotificationType cannot be null or blank.	400	Bad Request
`entityCode`	INVALID_ENTITY_ID	\"InvalidEntityCode {0}.\"	400	Bad Request
`emailAddresses`	MAXIMUM_15_EMAILS_ALLOWED	Too many recipients — maximum allowed is 15	400	Bad Request
`emailAddresses`	INVALID_EMAIL	At least one email address must be provided	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Message	Http Status	Http Status Text
DUPLICATE_EMAIL	\"Duplicate email found : {0}.\"	422	Unprocessable Content
INVALID_NOTIFICATION_TYPE	\"Invalid notification type.\"	422	Unprocessable Content

Description

Partially updates basic info for an entity. Only entityName can be updated; entityType and clientLegalName are read-only.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`entityName`	String	Yes	New entity name (min 4, max 200).	\\\"Demo Entity Updated\\\"

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Entity basic info updated successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/basic-info
`data.entityCode`	String	Code of the entity.	NUMEXXXXXXXX
`data.entityName`	String	Updated entity name.	Demo Entity Updated
`data.entityType`	String	Entity type.	ROOT
`data.clientLegalName`	String	Client legal name.	Demo Rest LLC
`data.entityStatus`	String	Status of the Entity	Edit
`links.self`	String	Link to fetch the same basic info again.	/api/v1/entity/NUMEXXXXXXXX/basic-info
`links.update`	String	Link to update basic info again.	/api/v1/entity/NUMEXXXXXXXX/basic-info
`links.view`	String	Link to view basic info (same as self).	/api/v1/entity/NUMEXXXXXXXX/basic-info

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityName`	String	Yes	INVALID_ENTITY_NAME	entityName cannot be null or blank.	400	Bad Request
`entityName`	String	Yes	INVALID_ENTITY_NAME_LENGTH	entityName minimum length is 4 characters and maximum length is 200 characters. (includes manual handler check when non-blank but < 4 chars)	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ACOUNT_TYPE_IS_SINGLE_ENTITY	(message from bundle)	403	Forbidden
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
DUPLICATE_ENTITY_NAME	Entity with name ''{0}'' already exists.	422	Unprocessable Entity (WebDAV) (RFC 4918)
ENTITY_IN_APPROVED_STATUS	Cannot edit entity in approved status.	422	Unprocessable Entity (WebDAV) (RFC 4918)
ENTITY_SUBMITTED_STATE	Entity is in submitted status. Cannot Edit entity {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","basic-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"874af8be-a1fe-4a0c-8f28-0e58ff0358f9","name":"200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"testDemo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/basic-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 06:43:33 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T14:28:33:33Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity basic info updated successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityName\": \"Updated Demo Entity Name as test runner DD\",\n \"entityType\": \"Root\",\n \"clientLegalName\": \"Demo Rest1\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"update\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"view\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\"\n }\n}"},{"id":"19ce345a-405a-439d-89a0-297fda1dbbb3","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"testDemo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/ /basic-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 05:03:14 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"entityName\",\n \"issue\": \"entityName cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_NAME\"\n },\n {\n \"field\": \"entityName\",\n \"issue\": \"entityName minimum length is 4 characters and maximum length is 200 characters. _(includes manual handler check when non-blank but < 4 chars)_\",\n \"customCode\": \"INVALID_ENTITY_NAME_LENGTH\"\n }\n ]\n}"},{"id":"81d7b80d-a86a-4294-873e-1fccb1dc6869","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"testDemo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/basic-info"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 06:41:20 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=7D0B60F08D7BD674FA2A6FC0509FAC3C; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"details\": [\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n },\n {\n \"issue\": \"(message from bundle)\",\n \"customCode\": \"ACOUNT_TYPE_IS_SINGLE_ENTITY\"\n }\n ]\n}"},{"id":"a9519702-c06e-44e5-becc-51a459c3556d","name":"404-Not-Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"testDemo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/basic-info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=93F0B9944FDB61119AFB75CB6BC17414; Path=/dev2-eim; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 05:00:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"},{"id":"4d6ed634-4a9e-4a86-81da-11f40b86a4d2","name":"422 Unprocessable Entity (WebDAV) (RFC 4918)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityName\": \"Test KYC27\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/basic-info"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 06:47:33 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n },\n {\n \"issue\": \"(message from bundle)\",\n \"customCode\": \"ACOUNT_TYPE_IS_SINGLE_ENTITY\"\n }\n ]\n}"}],"_postman_id":"e97fd5d3-f308-4d66-9892-0e7991360a93"},{"name":"General Info","id":"c485df50-f599-4262-99d2-c40c263684a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Updated entity description\",\r\n \"parentCompany\": \"Updated Parent Company\",\r\n \"addressLine1\": \"456 Updated Street\",\r\n \"addressLine2\": \"Suite 200\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"90001\",\r\n \"addressType\": \"OTHER\",\r\n \"addressTypeOther\": \"WAREHOUSE\",\r\n \"country\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"fax\": \"2079460XXX\",\r\n \"website\": \"https://www.updatedexample.com\",\r\n \"pointOfContact\": {\r\n \"firstName\": \"Updated\",\r\n \"lastName\": \"Contact\",\r\n \"designation\": \"CTO\",\r\n \"otherDesignation\": null,\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"email\": \"updated.contact@example.com\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info","description":"

Description

Partially updates general info for an entity with merge semantics. Only provided fields are updated; omitted fields remain unchanged.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity. (e.g., NUMXXXXXX105).

Request Parameters:

Name	Type	Required	Description	Example
`description`	String	No	Entity description (max 100).	Demo entity for campaign support
`parentCompany`	String	No	Parent company (max 75).	Demo Parent Inc
`addressLine1`	String	No	Address line 1 (max 100).	123 Main St
`addressLine2`	String	No	Address line 2 (max 100).	Suite 200
`city`	String	No	City (alphabetic/space/hyphen, max 20).	McLean
`zipCode`	String	No	ZIP/postal code (digits only, max 10).	22XX2
`addressType`	String	Yes	Primary address type. Allowed: STATE_REGISTRATION_ADDRESS, PRINCIPAL_BUSINESS_ADDRESS, MAILING_ADDRESS, HEAD_OFFICE, OTHER	OTHER
`addressTypeOther`	String	Conditional	Required when addressType is OTHER (max 100). Free-text description.	WAREHOUSE
`country`	String	No	Country code (ISO 3166-1 alpha-2).	US
`subdivisionType`	String	Conditional	Preferred region type (e.g. STATE for US). Required with subdivisionCode unless US sends stateCode only.	STATE
`subdivisionCode`	String	Conditional	Preferred region code. Required for non-US; for US, required unless stateCode is sent.	VA
`stateCode`	String	Conditional	US only. Legacy region code — accepted during transition instead of subdivisionCode. Do not send with subdivisionType/subdivisionCode.	VA
`phoneNumber`	String	No	Phone number (exactly 10 digits).	2079460XXX
`fax`	String	No	Fax (digits only, max 10).	2079460XXX
`website`	String	No	Website (max 75).	[https://www.demoentity.com](https://www.demoentity.com](https://www.demoentity.com](https://www.demoentity.com)))
`pointOfContact`	Object	No	Point of contact object.	{\"firstName\": \"John\", \"lastName\": \"Doe\"}
`pointOfContact.firstName`	String	No	POC first name.	John
`pointOfContact.lastName`	String	No	POC last name.	Doe
`pointOfContact.designation`	String	No	POC designation code (validated against DB).	CEO
`pointOfContact.otherDesignation`	String	No	Other designation (required when designation = `OTH`).	Founder
`pointOfContact.phoneNumber`	String	No	POC phone (10 digits).	2079460XXX
`pointOfContact.email`	String	No	POC email.	[john.doe@example.com](https://mailto:john.doe@example.com)

i18n

Region fields (i18n)

US backward compatible

Prefer subdivisionType + subdivisionCode for the primary address region. stateCode is still accepted for US entities during transition — do not send both patterns.

countryUS ISO 3166-1 alpha-2 country on the primary addresssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"country\": \"US\",\n  \"stateCode\": \"TX\"\n}\n\n

Preferred

{\n  \"country\": \"US\",\n  \"subdivisionType\": \"STATE\",\n  \"subdivisionCode\": \"TX\"\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	General information is retrieved successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/general-info
`data.\\`	Object	Same fields as GET – View Entity General Info response `data`.	{\"data\": {\"entityCode\": \"NUMXXXXXX105\", \"entityStatus\": \"Edit\"}}
`links.\\`	Object	Same fields as GET – View Entity General Info response `links`.	{\"links\": {\"nextAction\": \"/api/v1/entity/NUMXXXXXX105/general-info\"}}

Input Validation

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityCode`	String	Yes	INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
`requestBody`	n/a	Yes	INVALID_REQUEST_BODY	Request body cannot be null.	400	Bad Request
`requestBody`	n/a	Yes	INVALID_REQUEST_BODY	Malformed request body.	400	Bad Request
`description`	String	No	INVALID_DESCRIPTION_LENGTH	description maximum length is 100 characters. (when key sent)	400	Bad Request
`parentCompany`	String	No	INVALID_PARENT_COMPANY_LENGTH	parentCompany maximum length is 75 characters. (when key sent)	400	Bad Request
`addressLine1`	String	No	INVALID_ADDRESS_LINE1_LENGTH	addressLine1 maximum length is 100 characters. (when key sent)	400	Bad Request
`addressLine2`	String	No	INVALID_ADDRESS_LINE2_LENGTH	addressLine2 maximum length is 100 characters. (when key sent)	400	Bad Request
`city`	String	No	INVALID_CITY_LENGTH	city maximum length is 20 Characters. (when key sent)	400	Bad Request
`city`	String	No	INVALID_CITY_FORMAT	city must contain only alphabetic characters. (when key sent)	400	Bad Request
`zipCode`	String	No	INVALID_ZIPCODE_LENGTH	zipCode minimum length is 1 digit and maximum length is 10 digit. (when key sent)	400	Bad Request
`zipCode`	String	No	INVALID_ZIPCODE	zipCode format is invalid for the selected country. (when key sent)	400	Bad Request
`addressType`	String	No	INVALID_ADDRESS_TYPE	addressType cannot be null or blank. (when key sent)	400	Bad Request
`addressType`	String	No	INVALID_ADDRESS_TYPE	addressType is invalid. Allowed values are: STATE_REGISTRATION_ADDRESS, PRINCIPAL_BUSINESS_ADDRESS, MAILING_ADDRESS, HEAD_OFFICE, OTHER.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther is required when addressType is OTHER.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther maximum length is 100 characters.	400	Bad Request
`addressTypeOther`	String	Conditional	INVALID_ADDRESS_TYPE_OTHER	addressTypeOther is only allowed when addressType is OTHER.	400	Bad Request
`addressType`	String	No	DUPLICATE_PRIMARY_ADDRESS_TYPE	Primary address addressType cannot match additional address addressType.	400	Bad Request
`country`	String	No	UNSUPPORTED_COUNTRY_CODE	Country Code not supported. Refer /v1/country-codes	400	Bad Request
`country`	String	No	INVALID_COUNTRY_CODE	Invalid country code {code}.	400	Bad Request
`subdivisionType`	String	No	INVALID_SUBDIVISION_TYPE	subdivisionType is invalid for the selected country.	400	Bad Request
`subdivisionCode`	String	No	INVALID_SUBDIVISION_CODE	Invalid subdivision code {code} for country {country}.	400	Bad Request
`stateCode`	String	No	INVALID_STATE_CODE	Invalid state code {code} for country {country}.	400	Bad Request
`county`	String	No	INVALID_COUNTY_LENGTH	county maximum length is 100 characters.	400	Bad Request
`phoneNumber`	String	No	INVALID_PHONE_NUMBER	phoneNumber must contain digits only (optional leading '+').	400	Bad Request
`phoneNumber`	String	No	INVALID_PHONE_NUMBER_LENGTH	phoneNumber must contain exactly 10 digits for country US.	400	Bad Request
`fax`	String	No	INVALID_FAX	fax must contain digits only (optional leading '+').	400	Bad Request
`fax`	String	No	INVALID_FAX_LENGTH	fax must contain exactly 10 digits for country US.	400	Bad Request
`website`	String	No	INVALID_WEBSITE_FORMAT	Invalid website format. Please enter a URL that starts with 'https://www.' and includes a valid domain name.	400	Bad Request
`website`	String	No	INVALID_WEBSITE_LENGTH	website maximum length is 75 characters.	400	Bad Request
`pointOfContact.firstName`	String	No	INVALID_POC_FIRST_NAME_LENGTH	PointOfContact:FirstName maximum length is 50 Characters.	400	Bad Request
`pointOfContact.firstName`	String	No	INVALID_POC_FIRST_NAME_FORMAT	PointOfContact:FirstName name must contain only alphabetic characters and spaces.	400	Bad Request
`pointOfContact.lastName`	String	No	INVALID_POC_LAST_NAME_LENGTH	PointOfContact:LastName maximum length is 50 Characters.	400	Bad Request
`pointOfContact.lastName`	String	No	INVALID_POC_LAST_NAME_FORMAT	PointOfContact:LastName name must contain only alphabetic characters and spaces.	400	Bad Request
`pointOfContact.designation`	String	No	INVALID_POC_DESIGNATION_LENGTH	PointOfContact:Designation maximum length is 100 characters.	400	Bad Request
`pointOfContact.otherDesignation`	String	No	INVALID_POC_OTHER_DESIGNATION_LENGTH	PointOfContact:OtherDesignation minimum length 1 characters and maximum length is 100 characters.	400	Bad Request
`pointOfContact.phoneNumber`	String	No	INVALID_POC_PHONE_FORMAT	PointOfContact:PhoneNumber must contain digits only (optional leading '+').	400	Bad Request
`pointOfContact.phoneNumber`	String	No	INVALID_POC_PHONE_LENGTH	PointOfContact:PhoneNumber must contain exactly 10 digits for country US.	400	Bad Request
`pointOfContact.email`	String	No	INVALID_POC_EMAIL_FORMAT	PointOfContact:Please enter valid email.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
MISSING_REQUIRED_FIELDS	After update, required fields are missing: {field list}.	422	Unprocessable Entity
MISSING_REQUIRED_FIELDS	Required fields are missing: addressLine1	422	Unprocessable Entity
MISSING_REQUIRED_FIELDS	Required fields are missing: addressType	422	Unprocessable Entity
MISSING_REQUIRED_FIELDS	Required fields are missing: addressTypeOther	422	Unprocessable Entity
MISSING_REQUIRED_FIELDS	Required fields are missing: pointOfContact.firstName, pointOfContact.lastName, pointOfContact.designation, pointOfContact.phoneNumber, pointOfContact.email	422	Unprocessable Entity
PLEASE_ENTER_POINT_OF_CONTACT_DESIGNATION	Invalid \"Contact Designation\"	422	Unprocessable Entity
PLEASE_ENTER_POINT_OF_CONTACT_OTHER_DESIGNATION	Invalid \"Contact Designation\"	422	Unprocessable Entity
INVALID_POINT_OF_CONTACT_OTHER_DESIGNATION	Invalid PointOfContactOtherDesignation. Ensure that the designation value is set to Other(OTH).	422	Unprocessable Entity
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

Description

Partially updates one additional address. Only fields present in the body are updated; omitted fields remain unchanged. The addressId in the path is authoritative.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.
`addressId`	String	Yes	Numeric address identifier (server-assigned).

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`addressLine1`	String	No	Street address line 1	1600 Pennsylvania Avenue NW
`addressLine2`	String	No	Street address line 2
`city`	String	No	City	McLean
`zipCode`	String	No	Postal code	20500-0001
`addressType`	String	No	Address type	MAILING_ADDRESS
`addressTypeOther`	String	No	Other address type description
`country`	String	No	Country code	US
`subdivisionType`	String	No	Region type	STATE
`subdivisionCode`	String	No	Region code	VA
`county`	String	No	County

i18n

Supported countries and region fields

Each address requires country, subdivisionType, and subdivisionCode (optional county). Supported countries: US. POST accepts a non-empty array; PATCH updates one address by path addressId.

countryUS ISO 3166-1 alpha-2 country on each addresssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response time (UTC).	2025-07-08T13:00:00Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Additional address updated successfully.
`path`	String	API endpoint called.	/api/v1/entity/NUMEXXXXXXXX/additional-addresses/1001
`data.addressId`	String	Updated address identifier.	1001
`data.addressLine1`	String	Street address line 1.	1600 Pennsylvania Avenue NW
`data.country`	String	Country code.	US
`data.subdivisionType`	String	Region type.	STATE
`data.subdivisionCode`	String	Region code.	VA
`data.entityStatus`	String	Status of the Entity	Edit

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Error Message	HTTP Status Code	Http Status Text
`addressId`	String	Yes	INVALID_ADDRESS_ID	addressId must be a valid numeric identifier.	400	Bad Request
`requestBody`	Object	Yes	EMPTY_UPDATE_PAYLOAD	At least one field is required to update.	400	Bad Request
`subdivisionType`	String	No	INVALID_SUBDIVISION_TYPE	subdivisionType is invalid for the selected country.	400	Bad Request
`subdivisionCode`	String	No	INVALID_SUBDIVISION_CODE	subdivisionCode is invalid for the selected country and subdivisionType.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ADDITIONAL_ADDRESS_NOT_FOUND	Additional address not found.	404	Not Found
ADDITIONAL_ADDRESS_ENTITY_MISMATCH	Additional address does not belong to entity.	404	Not Found

Description

Partially updates existing entity officers stored in JSON. Officers are matched by id (UUID); only provided fields are updated.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`entityOfficers`	Array	Yes	List of officers to update (must not be empty).	[{\"id\": \"2a52f426-58cb-4e7d-8f57-bf39047f31f1\"}]
`id`	String	Yes	Officer UUID (v4). Used to match an existing officer record.	2a52f426-58cb-4e7d-8f57-bf39047f31f1
`firstName`	String	No	Officer first name.	John
`lastName`	String	No	Officer last name.	Doe
`designation`	String	No	Officer designation code (validated against DB).	CEO
`otherDesignation`	String	No	Other designation (required when designation = `OTH`).	Co-Founder
`phone`	String	No	Phone number (10 digits); JSON property name matches `EntityOfficersTO`.	2079460XXX
`email`	String	No	Email.	[john.doe@example.com](https://mailto:john.doe@example.com)

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Entity officers information is retrieved successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/entity-officers
`data.\\`	Object	Same fields as GET – View Entity General Info response `data`.	{\"data\": {\"entityCode\": \"NUMXXXXXX105\", \"entityStatus\": \"Edit\"}}
`links.\\`	Object	Same fields as GET – View Entity Officers response `links`.	{\"links\": {\"self\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\", \"view\": \"/api/v1/entity/NUMXXXXXX105/entity-officers\"}}

Input Validation

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityOfficers`	Array	Yes	INVALID_ENTITY_OFFICERS	entityOfficers cannot be empty.	400	Bad Request
`id`	String	Yes	INVALID_ENTITY_OFFICER_UUID	EntityOfficer:id must be a valid UUID v4 format.	400	Bad Request
`firstName`	String	No	INVALID_ENTITY_OFFICER_FIRSTNAME	EntityOfficer:firstName cannot be null or blank.	400	Bad Request
`firstName`	String	No	INVALID_ENTITY_OFFICER_FIRSTNAMEE_LENGTH	EntityOfficer:firstName maximum length is 100 characters.	400	Bad Request
`firstName`	String	No	INVALID_ENTITY_OFFICER_FIRSTNAME_FORMAT	EntityOfficer:firstName must contain only alphabetic characters and spaces.	400	Bad Request
`lastName`	String	No	INVALID_ENTITY_OFFICER_LASTNAME	EntityOfficer:lastName cannot be null or blank.	400	Bad Request
`lastName`	String	No	INVALID_ENTITY_OFFICER_LASTNAME_LENGTH	EntityOfficer:lastName maximum length is 100 characters.	400	Bad Request
`lastName`	String	No	INVALID_ENTITY_OFFICER_LASTNAME_FORMAT	EntityOfficer:lastName must contain only alphabetic characters and spaces.	400	Bad Request
`designation`	String	No	INVALID_ENTITY_OFFICER_DESIGNATION	EntityOfficer:designation cannot be null or blank.	400	Bad Request
`designation`	String	No	INVALID_ENTITY_OFFICER_DESIGNATION_LENGTH	EntityOfficer:designation maximum length is 100 characters.	400	Bad Request
`otherDesignation`	String	No	INVALID_ENTITY_OFFICER_OTHER_DESIGNATION_LENGTH	EntityOfficer:otherDesignation maximum length is 100 characters.	400	Bad Request
`phone`	String	No	INVALID_ENTITY_OFFICER_PHONE_NUMBER_LENGTH	EntityOfficer:phoneNumber must contain 10 digits.	400	Bad Request
`email`	String	No	INVALID_ENTITY_OFFICER_EMAIL	EntityOfficer:Please enter valid email.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","entity-officers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"8a50c5a2-5079-4746-8d2b-33c447a94b64","name":"200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityOfficers\": [\r\n {\r\n \"id\": \"fc6e2d26-35ab-48cc-8730-ee61ef4cc79a\",\r\n \"firstName\": \"wayne\",\r\n \"lastName\": \"master\",\r\n \"designation\": \"CTO\",\r\n \"otherDesignation\": \"\",\r\n \"phoneNumber\": \"9876543210\",\r\n \"email\": \"test@example.com\"\r\n },\r\n {\r\n \"id\": \"e5a10d6a-b3a9-466a-854a-b68b58be150c\",\r\n \"firstName\": \"matt\",\r\n \"lastName\": \"murdock\",\r\n \"designation\": \"CIO\",\r\n \"otherDesignation\": \"\",\r\n \"phoneNumber\": \"1234567890\",\r\n \"email\": \"demo@example.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 28 Mar 2026 15:31:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T15:45:11Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity officers updated successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"view\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\"\n }\n}"},{"id":"4a84348d-a1df-4331-9e59-2d81e7b5ae60","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityOfficers\": [\r\n {\r\n \"id\": \"fc6e2d26-35ab-48cc-8730-ee61ef4cc79a\",\r\n \"firstName\": \"\",\r\n \"lastName\": \"kent\",\r\n \"designation\": \"CEO\",\r\n \"phoneNumber\": \"9876543210\",\r\n \"email\": \"test.officer@example.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 27 Mar 2026 11:25:22 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"entityOfficers\",\n \"issue\": \"entityOfficers cannot be empty.\",\n \"customCode\": \"INVALID_ENTITY_OFFICERS\"\n },\n {\n \"field\": \"id\",\n \"issue\": \"EntityOfficer:id must be a valid UUID v4 format.\",\n \"customCode\": \"INVALID_ENTITY_OFFICER_UUID\"\n }\n ]\n}"},{"id":"70f4d4d9-ba1a-4c1d-bca6-0fcb4982ecde","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityOfficers\": [\r\n {\r\n \"id\": \"56da706e-fbbd-4e11-a237-af2924f466e3\",\r\n \"firstName\": \"clark\",\r\n \"lastName\": \"kent\",\r\n \"designation\": \"CEO\",\r\n \"phoneNumber\": \"9876543210\",\r\n \"email\": \"updated.officer@example.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 10:38:18 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"details\": [\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n }\n ]\n}"},{"id":"b335e6e4-1ac3-47a6-bfb0-ed7bfd9630da","name":"404-Not-Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityOfficers\": [\r\n {\r\n \"id\": \"56da706e-fbbd-4e11-a237-af2924f466e3\",\r\n \"firstName\": \"clark\",\r\n \"lastName\": \"kent\",\r\n \"designation\": \"CEO\",\r\n \"phoneNumber\": \"9876543210\",\r\n \"email\": \"updated.officer@example.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 10:31:33 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"}],"_postman_id":"dc656263-1716-4552-9f11-c19efa955ccc"},{"name":"Billing RCD Info","id":"8495b230-055f-448c-8fd1-506ca7a0ce2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main St\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"22XX2\",\r\n \"countryAbbr\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"country\": \"US\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"firstName\": \"Jane\",\r\n \"lastName\": \"Smith\",\r\n \"email\": \"jane.smith@example.com\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info","description":"

Description

Partial update of billing details and/or RCD authorizer information with merge semantics. Any JSON key present under businessEntityBillingDetails or rcdAuthorizer must not be JSON null or a blank string.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

Name	Type	Required	Description	Example
`businessEntityBillingDetails`	Object	No	Partial billing details object. For Assigned entity, this section is not allowed.	{\"addressLine1\": \"123 Main St\", \"city\": \"McLean\", \"zipCode\": \"22XX2\", \"countryAbbr\": \"US\", \"stateCode\": \"VA\", \"phoneNumber\": \"2079460XXX\"}
`rcdAuthorizer`	Object	No	Partial RCD authorizer details object.	{\"firstName\": \"Jane\", \"lastName\": \"Smith\", \"email\": \"jane.smith@example.com\"}
`businessEntityBillingDetails.addressLine1`	String	No	Billing address line 1.	123 Main St
`businessEntityBillingDetails.city`	String	No	Billing city.	McLean
`businessEntityBillingDetails.zipCode`	String	No	Billing ZIP/postal code.	22XX2
`businessEntityBillingDetails.countryAbbr`	String	No	Billing country code (`US`/`CA`).	US
`businessEntityBillingDetails.stateCode`	String	No	Billing state code.	VA
`businessEntityBillingDetails.phoneNumber`	String	No	Billing phone number (10 digits).	2079460XXX
`rcdAuthorizer.firstName`	String	No	RCD authorizer first name.	Jane
`rcdAuthorizer.lastName`	String	No	RCD authorizer last name.	Smith
`rcdAuthorizer.email`	String	No	RCD authorizer email.	jane.smith@example.com
`businessEntityBillingDetails.country`	String	Yes	Billing country (ISO 3166-1 alpha-2). Preferred over countryAbbr.	US
`businessEntityBillingDetails.subdivisionType`	String (Enum)	Yes	Billing region type. US: `STATE`.	STATE
`businessEntityBillingDetails.subdivisionCode`	String	Yes	Billing region code (e.g. TX).	TX

i18n

Region fields (i18n)

US backward compatible

On businessEntityBillingDetails, prefer country + subdivisionType + subdivisionCode instead of countryAbbr + stateCode. Send one pattern only. rcdAuthorizer is unchanged.

countryUS ISO 3166-1 alpha-2 country on businessEntityBillingDetailssubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"businessEntityBillingDetails\": {\n    \"countryAbbr\": \"US\",\n    \"stateCode\": \"TX\"\n  }\n}\n\n

Preferred

{\n  \"businessEntityBillingDetails\": {\n    \"country\": \"US\",\n    \"subdivisionType\": \"STATE\",\n    \"subdivisionCode\": \"TX\"\n  }\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Billing and RCD information is updated successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info
`data.\\`	Object	Same fields as GET – View Entity General Info response `data`.	{\"data\": {\"entityCode\": \"NUMXXXXXX105\", \"entityStatus\": \"Edit\"}}
`links.\\`	Object	Same fields as GET – View Entity Officers response `links`.	{\"links\": {\"self\": \"/api/v1/entity/NUMXXXXXX105/business-info\", \"view\": \"/api/v1/entity/NUMXXXXXX105/business-info\"}}

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`requestBody`	n/a	Yes	INVALID_REQUEST_BODY	Malformed request body.	400	Bad Request
`Name`	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`businessEntityBillingDetails`	Object	Conditional	INVALID_BILLING_DETAILS	Invalid billing details.	400	Bad Request
`rcdAuthorizer`	Object	Conditional	INVALID_RCD_AUTHORIZER	rcdAuthorizer cannot be null.	400	Bad Request
`_(nested billing fields)_`	various	Conditional	INVALID_BILLING_DETAILS_\\	(issue strings align with `fieldValidtionErrorCode.properties_`, e.g._ `INVALID_BILLING_DETAILS_FIRST_NAME_`,_ `INVALID_BILLING_DETAILS_ZIPCODE_`, …)_	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`_(nested RCD fields)_`	various	Conditional	INVALID_RCD_AUTHORIZER	(e.g. firstName/lastName/email messages matching property keys)	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country must be a supported country code. Refer /v1/country-codes.	400	Bad Request
`businessEntityBillingDetails.countryAbbr`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request
`businessEntityBillingDetails.country`	String	Conditional	UNSUPPORTED_COUNTRY_CODE	BillingDetails:Country cannot be null or blank.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTER_RCD_DETAILS	(either billing or RCD section required)	400	Bad Request
BILLING_DETAILS_NOT_ALLOWED_FOR_ASSIGNED	(billing payload on Assigned entity)	422	Unprocessable Entity (WebDAV) (RFC 4918)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","billing-rcd-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"311d6f0b-7184-4eee-a29f-627b286e1e49","name":"200 - Billing RCD Info updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"123 Main St\",\r\n \"city\": \"Reston\",\r\n \"zipCode\": \"20190\",\r\n \"phoneNumber\": \"7035551234\",\r\n \"country\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"firstName\": \"Jane\",\r\n \"lastName\": \"Smith\",\r\n \"email\": \"jane.smith@example.com\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 11:07:22 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-30T11:07:22Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Billing and RCD information is updated successfully.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/billing-rcd-info\",\n \"data\": {\n \"entityCode\": \"NUMXXXXXX105\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMXXXXXX105/business-info\"\n }\n}"},{"id":"2f75a055-b786-4873-82ec-519f3fb39f81","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"456 Boulevard\",\r\n \"addressLine2\": \"Sunstreet\",\r\n \"city\": \"Sacramento\",\r\n \"zipCode\": \"9000\",\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"CA\",\r\n \"phoneNumber\": \"98765as43210\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 18:01:48 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"requestBody\",\n \"issue\": \"Malformed request body.\",\n \"customCode\": \"INVALID_REQUEST_BODY\"\n },\n {\n \"field\": \"Name\",\n \"issue\": \"Message\",\n \"customCode\": \"Custom Error Code\"\n }\n ]\n}"},{"id":"d3c3595a-6295-4229-8f43-b655f2907a80","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"456 Boulevard\",\r\n \"addressLine2\": \"Sunstreet\",\r\n \"city\": \"Sacramento\",\r\n \"zipCode\": \"9000\",\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"CA\",\r\n \"phoneNumber\": \"9876543210\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"firstName\": \"john\",\r\n \"lastName\": \"anderson\",\r\n \"email\": \"test@example.com\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 18:03:40 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info\",\n \"details\": [\n {\n \"issue\": \"_(either billing or RCD section required)_\",\n \"customCode\": \"ENTER_RCD_DETAILS\"\n },\n {\n \"issue\": \"_(billing payload on Assigned entity)_\",\n \"customCode\": \"BILLING_DETAILS_NOT_ALLOWED_FOR_ASSIGNED\"\n }\n ]\n}"},{"id":"cbb02d4b-a49e-4190-b393-43a52295b0f8","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"456 Boulevard\",\r\n \"addressLine2\": \"Sunstreet\",\r\n \"city\": \"Sacramento\",\r\n \"zipCode\": \"9000\",\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"CA\",\r\n \"phoneNumber\": \"9876543210\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 11:04:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info\",\n \"details\": [\n {\n \"issue\": \"_(either billing or RCD section required)_\",\n \"customCode\": \"ENTER_RCD_DETAILS\"\n },\n {\n \"issue\": \"_(billing payload on Assigned entity)_\",\n \"customCode\": \"BILLING_DETAILS_NOT_ALLOWED_FOR_ASSIGNED\"\n }\n ]\n}"},{"id":"75402533-d2e0-4f49-bac5-ef99ac70045c","name":"422 Unprocessable Entity (WebDAV) (RFC 4918)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"businessEntityBillingDetails\": {\r\n \"addressLine1\": \"456 Boulevard\",\r\n \"addressLine2\": \"Sunstreet\",\r\n \"city\": \"Sacramento\",\r\n \"zipCode\": \"9000\",\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"CA\",\r\n \"phoneNumber\": \"9876543210\"\r\n },\r\n \"rcdAuthorizer\": {\r\n \"firstName\": \"KYC\",\r\n \"lastName\": \"Testrunner\",\r\n \"email\": \"kyc@example.com\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/billing-rcd-info"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 18:06:29 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info\",\n \"details\": [\n {\n \"issue\": \"_(either billing or RCD section required)_\",\n \"customCode\": \"ENTER_RCD_DETAILS\"\n },\n {\n \"issue\": \"_(billing payload on Assigned entity)_\",\n \"customCode\": \"BILLING_DETAILS_NOT_ALLOWED_FOR_ASSIGNED\"\n }\n ]\n}"}],"_postman_id":"8495b230-055f-448c-8fd1-506ca7a0ce2b"},{"name":"Business Info","id":"e6a9f5f4-ae7c-4c82-97f9-b043385df8ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": \"2022\",\r\n \"type\": \"CORP\",\r\n \"businessIndustry\": \"FINANCE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info","description":"

Description

Partial update; only provided fields are validated and merged. Any JSON key that is present must not be JSON null or a blank string.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

Name	Type	Required	Description	Example
`entityBusinessDetails`	Object	No	Partial business details object; only provided fields are merged.	{\"year\": 2020, \"legalStructure\": \"Corporation\", \"type\": \"PRI\"}
`registeredAgent`	Object	No	Partial registered agent object.	{\"name\": \"Agent Pro LLC\", \"address\": \"50 State St\", \"city\": \"McLean\", \"stateCode\": \"VA\", \"zipCode\": \"22XX2\", \"countryAbbr\": \"US\"}
`year`	Integer	No	Year of incorporation/business start.	2020
`legalStructure`	String	No	Legal structure.	Corporation
`type`	String	No	Business type code.	PRI
`businessIndustry`	String	No	Business industry code.	OTH
`otherBusinessIndustry`	String	No	Other business industry when businessIndustry is `OTH`.	Consulting
`naicsCode`	String	No	NAICS code.	541611
`noOfEmployees`	String	No	Positive number of employees (max 7 digits).	250
`ticker`	String	No	Stock ticker.	DME
`eins`	String	No	US principal only.** EIN value.	123456789
`duns`	String	No	DUNS number (9 digits).	123456789
`lei`	String	No	LEI value.	ABCDEFGH
`industryAssociations`	Array\\[String\\]	No	Industry association codes.	[\"ICL\"]
`otherIndustryAssociation`	String	No	Other industry association text.	Custom Association
`stateOfIncorporation`	Array\\[Object\\]	No	US principal only.	[{\"countryAbbr\": \"US\", \"stateCode\": \"VA\", \"fileNumber\": \"FN-001\"}]
`stateOfIncorporation\\[\\].countryAbbr`	String	No	US incorporation country.	US
`stateOfIncorporation\\[\\].stateCode`	String	No	US state code.	VA
`stateOfIncorporation\\[\\].fileNumber`	String	No	US incorporation file number.	FN001
`dbas`	Array\\[String\\]	No	DBA names list.	\\[Demo DBA\\]
`licenseType`	String	No	License type.	State
`professionalLicense`	String	No	Professional license identifier.	LIC12345
`registeredAgent.name`	String	No	Registered agent name.	Agent Pro LLC
`registeredAgent.address`	String	No	Registered agent address.	50 State St
`registeredAgent.city`	String	No	Registered agent city.	McLean
`registeredAgent.stateCode`	String	No	Registered agent state code.	VA
`registeredAgent.zipCode`	String	No	Registered agent ZIP.	22XX2
`registeredAgent.countryAbbr`	String	No	Registered agent country code.	US
`stateOfIncorporation[].country`	String	Conditional	US principal only. Incorporation jurisdiction country (preferred over countryAbbr).	US
`stateOfIncorporation[].subdivisionType`	String	Conditional	US principal only. Incorporation region type. US: `STATE`.	STATE
`stateOfIncorporation[].subdivisionCode`	String	Conditional	US principal only. Incorporation region code.	DE
`registeredAgent.country`	String	Yes	Registered agent country (preferred over countryAbbr).	US
`registeredAgent.subdivisionType`	String	Yes	Registered agent region type.	STATE
`registeredAgent.subdivisionCode`	String	Yes	Registered agent region code.	DE

i18n

Region fields (i18n)

US backward compatible

stateOfIncorporation[] and eins are US principal only . On US stateOfIncorporation[] rows and registeredAgent, prefer country + subdivisionType + subdivisionCode (countryAbbr/stateCode still accepted).

countryUS ISO 3166-1 alpha-2 country on incorporation / registered agentsubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"countryAbbr\": \"US\",\n  \"stateCode\": \"DE\",\n  \"fileNumber\": \"1234567\"\n}\n\n

Preferred

{\n  \"country\": \"US\",\n  \"subdivisionType\": \"STATE\",\n  \"subdivisionCode\": \"DE\",\n  \"fileNumber\": \"1234567\"\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response timestamp (UTC).	2026-04-30T10:15:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Success message.	Entity business info updated successfully.
`path`	String	Current endpoint path.	/api/v1/entity/NUMEXXXXXXXX/business-info
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.entityStatus`	String	Entity status after patch.	Edit
`links.nextAction`	String	Next step endpoint.	/api/v1/entity/NUMEXXXXXXXX/communication-info

Input Validation

Input Validation◀▶

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityCode`	String	Yes	INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
`entityBusinessDetails`	Object	Conditional	INVALID_BUSINESS_DETAILS	Invalid business details.	400	Bad Request
`year`	Integer	Conditional	INVALID_BUSINESS_DETAILS_YEAR	BusinessDetails:year cannot be blank or null.	400	Bad Request
`legalStructure`	String	Conditional	INVALID_BUSINESS_DETAILS_LEGAL_STRUCTURE	BusinessDetails:legalStructure cannot be blank or null.	400	Bad Request
`type`	String	Conditional	INVALID_BUSINESS_DETAILS_TYPE	BusinessDetails:type cannot be blank or null.	400	Bad Request
`businessIndustry`	String	Conditional	INVALID_BUSINESS_DETAILS_BUSINESS_INDUSTRY	BusinessDetails:businessIndustry cannot be blank or null.	400	Bad Request
`noOfEmployees`	String	Conditional	INVALID_BUSINESS_DETAILS_NO_OF_EMPLOYEES	BusinessDetails:noOfEmployees must be a positive number with a maximum of 7 digits.	400	Bad Request
`eins`	String	Conditional	INVALID_BUSINESS_DETAILS_EINS	BusinessDetails:Invalid eins format. Allowed formats are 'XX-XXXXXXX' or 'XXXXXXXXX'. No other format is permitted.	400	Bad Request
`duns`	String	Conditional	INVALID_BUSINESS_DETAILS_DUNS_LENGTH	BusinessDetails:duns must be exactly 9 digits.	400	Bad Request
`lei`	String	Conditional	INVALID_BUSINESS_DETAILS_LEI	BusinessDetails:lei must contain only alphabetic characters.	400	Bad Request
`stateOfIncorporation\\[\\].countryAbbr`	String	Conditional	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_COUNTRY_INVALID	BusinessDetails:stateOfIncorporation:countryAbbr cannot be null or blank.	400	Bad Request
`stateOfIncorporation\\[\\].stateCode`	String	Conditional	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_STATE_INVALID	BusinessDetails:stateOfIncorporation:stateCode cannot be null or blank.	400	Bad Request
`stateOfIncorporation\\[\\].fileNumber`	String	Conditional	INVALID_BUSINESS_DETAILS_STATE_OF_INCORPORATION_FILE_NUM_INVALID	BusinessDetails:stateOfIncorporation:fileNumber cannot be null or blank.	400	Bad Request
`registeredAgent.name`	String	Conditional	INVALID_Registered_AGENT_NAME_LENGTH	RegisteredAgent:Name must be a maximum of 20 characters.	400	Bad Request
`registeredAgent.address`	String	Conditional	INVALID_Registered_AGENT_ADDRESS_LENGTH	RegisteredAgent:Address must be a maximum of 100 characters.	400	Bad Request
`registeredAgent.city`	String	Conditional	INVALID_Registered_AGENT_CITY_FORMAT	RegisteredAgent:City must contain only alphabetic characters.	400	Bad Request
`registeredAgent.stateCode`	String	Conditional	INVALID_Registered_AGENT_STATE_FORMAT	RegisteredAgent:StateCode must contain only alphabetic characters.	400	Bad Request
`registeredAgent.zipCode`	String	Conditional	INVALID_Registered_AGENT_ZIPCODE	RegisteredAgent:ZipCode must contain only digits.	400	Bad Request
`registeredAgent.countryAbbr`	String	Conditional	INVALID_REGISTERED_AGENT_COUNTRY	Registered Agent Country is invalid.	422	Unprocessable Entity

Business Validations

International registry validation on PATCH runs when any of these keys are patched: otherBusinessIdentification, legalStructure.

Profile	Custom Error Code	Message	HTTP Status Code	Http Status Text
All	ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
All	ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
All	ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found
All	ENTITY_IN_APPROVED_STATUS	Cannot edit entity in approved status.	422	Unprocessable Entity
All	ENTITY_SUBMITTED_STATE	Entity is in submitted status. Cannot Edit entity {0}.	422	Unprocessable Entity
All	INVALID_YEAR	Invalid year {0}. The year must be within the range of 1600 to the current year.	422	Unprocessable Entity
All	INVALID_BUSINESS_TYPE	Invalid \"Business Type\"	422	Unprocessable Entity
All	INVALID_INDUSTRY_TYPE	Invalid Industry {0}.	422	Unprocessable Entity
All	PLEASE_ENTER_OTHER_BUSINESS_INDUSTRY	Please enter other business industry.	422	Unprocessable Entity
All	INVALID_OTHER_BUSINESS_INDUSTRY	Invalid other business industry {0}.	422	Unprocessable Entity
All	INVALID_LEI	BusinessDetails:lei must be exactly 20 alphanumeric characters.	422	Unprocessable Entity
All	INVALID_REGISTERED_AGENT_COUNTRY	Registered Agent Country is invalid.	422	Unprocessable Entity
All	INVALID_SUBDIVISION_CODE	Invalid subdivision code for country.	400	Bad Request
All	INVALID_REGISTERED_AGENT_ZIP	RegisteredAgent:zipCode format is invalid for the selected country.	422	Unprocessable Entity
All	INVALID_STATE_OF_INCORPORATION	stateOfIncorporation must be a non-empty array when the key is present.	400	Bad Request
US	EINS_OR_DUNS	Either EIN or DUNS values is mandatory.	422	Unprocessable Entity
US	INVALID_ENTITY_INDUSTRY_ASSOCIATIONS	Invalid industry associations {0}.	422	Unprocessable Entity
US	INVALID_ENTITY_OTHER_INDUSTRY_ASSOCIATIONS	Invalid OtherIndustryAssociations {0}.	422	Unprocessable Entity
US	INVALID_OTHER_INDUSTRY_ASSOCIATION	Invalid OtherIndustryAssociation {0}.	422	Unprocessable Entity
US	INVALID_SUBDIVISION_CODE	Invalid subdivision for incorporation jurisdiction.	422	Unprocessable Entity
US	INVALID_FILENUMBER	Invalid FileNumber, maximum length is 30 characters.	422	Unprocessable Entity

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","business-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"3b09b561-f991-4d6c-b1d6-6083d0c7061b","name":"200 - Updated Business Info","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"123456789\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"123456789\",\r\n \"eins\": \"123456789\",\r\n \"duns\": \"123456789\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": null,\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AK\",\r\n \"fileNumber\": \"Y13me3255\"\r\n },\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AR\",\r\n \"fileNumber\": \"Y13me1000\"\r\n }\r\n ],\r\n \"dbas\": [],\r\n \"licenseType\": \"ABC Testing\",\r\n \"professionalLicense\": \"Testing 12343\"\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Registered Office Services Ltd\",\r\n \"address\": \"1 Example Street\",\r\n \"city\": \"McLean\",\r\n \"zipCode\": \"20190\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionCode\": \"VA\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 16:57:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-30T10:15:30Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity business info updated successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\"\n }\n}"},{"id":"0fb8eec3-4253-4d3a-a22f-8845ebc8f945","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543477736\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": null,\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AK\",\r\n \"fileNumber\": \"Y13me3255\"\r\n },\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AR\",\r\n \"fileNumber\": \"Y13me1000\"\r\n }\r\n ],\r\n \"dbas\": [],\r\n \"licenseType\": \"ABC Testing\",\r\n \"professionalLicense\": \"Testing 12343\"\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Updated Agent Inc\",\r\n \"city\": \"SanFrancisco\",\r\n \"address\": \"999 Agent Street\",\r\n \"stateCode\": \"CA\",\r\n \"zipCode\": \"94102\",\r\n \"countryAbbr\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:16:40 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode maximum length is 50 characters.\",\n \"customCode\": \"INVALID_ENTITY_CODE_LENGTH\"\n },\n {\n \"field\": \"entityBusinessDetails\",\n \"issue\": \"Invalid business details.\",\n \"customCode\": \"INVALID_BUSINESS_DETAILS\"\n }\n ]\n}"},{"id":"f7fa0fac-e93c-441c-8323-8bf3f8078bf4","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": 2020,\r\n \"legalStructure\": \"service\",\r\n \"type\": \"PRI\",\r\n \"businessIndustry\": \"MD\",\r\n \"otherBusinessIndustry\": null,\r\n \"naicsCode\": \"888543436\",\r\n \"noOfEmployees\": \"222\",\r\n \"ticker\": \"888543436\",\r\n \"eins\": \"888543436\",\r\n \"duns\": \"888543436\",\r\n \"lei\": \"Demos\",\r\n \"industryAssociations\": [\r\n \"ICL\"\r\n ],\r\n \"otherIndustryAssociation\": null,\r\n \"stateOfIncorporation\": [\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AK\",\r\n \"fileNumber\": \"Y13me3255\"\r\n },\r\n {\r\n \"countryAbbr\": \"US\",\r\n \"stateCode\": \"AR\",\r\n \"fileNumber\": \"Y13me1000\"\r\n }\r\n ],\r\n \"dbas\": [],\r\n \"licenseType\": \"ABC Testing\",\r\n \"professionalLicense\": \"Testing 12343\"\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Updated Agent Inc\",\r\n \"city\": \"SanFrancisco\",\r\n \"address\": \"999 Agent Street\",\r\n \"stateCode\": \"CA\",\r\n \"zipCode\": \"94102\",\r\n \"countryAbbr\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:10:47 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"details\": [\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n }\n ]\n}"},{"id":"afa9d7c8-b781-470e-b65d-ed18d4bc8c33","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": \"2022\",\r\n \"type\": \"CORP\",\r\n \"businessIndustry\": \"FINANCE\"\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Updated Agent Inc\",\r\n \"city\": \"SanFrancisco\",\r\n \"address\": \"999 Agent Street\",\r\n \"stateCode\": \"CA\",\r\n \"zipCode\": \"94102\",\r\n \"countryAbbr\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 16:35:22 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"},{"id":"1f781ed3-6d3c-4522-afe4-8f2b949dd4a2","name":"422 Unprocessable Entity (WebDAV) (RFC 4918)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityBusinessDetails\": {\r\n \"year\": \"2022\",\r\n \"type\": \"CORP\",\r\n \"businessIndustry\": \"FINANCE\"\r\n },\r\n \"registeredAgent\": {\r\n \"name\": \"Updated Agent Inc\",\r\n \"city\": \"SanFrancisco\",\r\n \"address\": \"999 Agent Street\",\r\n \"stateCode\": \"CA\",\r\n \"zipCode\": \"94102\",\r\n \"countryAbbr\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/business-info"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 16:38:47 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"}],"_postman_id":"e6a9f5f4-ae7c-4c82-97f9-b043385df8ae"},{"name":"Communication Info","id":"c37e977c-45c0-4ed4-b774-5ad4efe8703d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \"communicationsSubdivisions\": [\r\n {\r\n \"countryCode\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionSelectionMode\": \"ALL_EXCEPT\",\r\n \"subdivisionCodes\": [\r\n \"VA\",\r\n \"AK\"\r\n ]\r\n }\r\n ]\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info","description":"

Description

Partially updates communication configuration for the entity with merge semantics.

Patch behavior

Only fields included in the request are updated; omitted fields retain existing values.
\n
Arrays are replaced entirely when provided (not merged element-by-element).
\n
The merged state must satisfy all required-field validations.
\n

Calling area (communicationsSubdivisions[])

Each row configures calling area for one country.

subdivisionSelectionMode: ALL — all subdivisions; omit subdivisionCodes
\n
subdivisionSelectionMode: SPECIFIC — inclusive list in subdivisionCodes
\n
subdivisionSelectionMode: ALL_EXCEPT — exclusion list in subdivisionCodes
\n

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

Name	Type	Required	Description
`entityCommunicationDetails`	Object	No	Communication details patch.
`entityCommunicationDetails.type`	Array	Conditional	Required in merged state; list replaced when provided.
`entityCommunicationDetails.customerRelationship`	Array	Conditional	Required in merged state; list replaced when provided.
`entityCommunicationDetails.existingPeriod`	Array	Conditional	Required when relationship contains `ECL`.
`entityCommunicationDetails.communicationsSubdivisions[]`	Array	No	Replaces entire per-country calling-area list when provided.
`entityCommunicationDetails.communicationsSubdivisions[].countryCode`	String	Yes	ISO country code on each row.
`entityCommunicationDetails.communicationsSubdivisions[].subdivisionType`	String	Yes	Region type for the country.
`entityCommunicationDetails.communicationsSubdivisions[].subdivisionSelectionMode`	String	Yes	ALL, SPECIFIC, or ALL_EXCEPT.
`entityCommunicationDetails.communicationsSubdivisions[].subdivisionCodes`	Array	Conditional	Required when mode is `SPECIFIC` or `ALL_EXCEPT`.
`entityCommunicationDetails.communicationPrograms`	Array	No	Program codes.
`entityCommunicationDetails.programDescription`	String	No	Description (valid only with specific programs).
`entityCommunicationDetails.numberOfMonths`	String	No	Number of months (string digits).
`entityCommunicationDetails.autoDailer`	Boolean	No	Autodialer flag.
`entityCommunicationDetails.autoDailerToCell`	Boolean	No	Autodialer-to-cell flag.
`entityCommunicationDetails.consumerComplaintEmail`	String	No	Complaint email.
`entityCommunicationDetails.consumerComplaintPhone`	String	No	Complaint phone.

i18n

Region fields (i18n)

US backward compatible

countryCodeUS Country on each communicationsSubdivisions[] rowsubdivisionTypeSTATEsubdivisionCodeTwo-letter code (e.g. TX, CA)

Previous (US)

{\n  \"communicationsStates\": {\n    \"countryCode\": \"US\",\n    \"stateCodes\": [\"TX\", \"CA\"]\n  }\n}\n\n

Preferred

{\n  \"communicationsSubdivisions\": [{\n    \"countryCode\": \"US\",\n    \"subdivisionType\": \"STATE\",\n    \"subdivisionSelectionMode\": \"SPECIFIC\",\n    \"subdivisionCodes\": [\"TX\", \"CA\"]\n  }]\n}\n\n

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Communication information saved successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/communication-info
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.entityStatus`	String	Status of the Entity	\"Edit\"
`links.nextAction`	String	Next action link (when applicable).	/api/v1/entity/NUMEXXXXXXXX/email-notification

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code
`entityCode`	String	Yes	(Spring validation: `@NotBlank`)

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found
ENTER_ENITTY_COMMUNICATION_DETAILS	pleaseEnterEntityCommunicationDetails (when body has no patch fields)	400	Bad Request
MISSING_REQUIRED_FIELDS	Missing required fields: {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CUSTOMER_TYPE	invalidCustomerType	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CUSTOMER_RELATION	invalidCustomerRelation	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_EXISTING_PERIOD	existngPeriod	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_EXISTING_CLIENT	invalidExistingClient	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_COUNTRY_CODE	pleaseEnterCountryCode	400	Bad Request
INVALID_STATE_COMMUNICATION	invalidStateCommunication	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_COMMUNICATION_PROGRAM	invalidCommunicationProgram	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PROGRAM_DESCRIPTOR	invalidProgramDescriptor	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NUMBER_OF_MONTH	invalidNumberOFMonth	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","communication-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"65f95224-90d9-4f61-aac1-e90a9bd5a440","name":"200 - Updated Communication Info","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \"type\": [\r\n \"B2C\"\r\n ],\r\n \"customerRelationship\": [\r\n \"ECL\"\r\n ],\r\n \"existingPeriod\": [\r\n \"06M\"\r\n ],\r\n \"communicationsSubdivisions\": [\r\n {\r\n \"countryCode\": \"US\",\r\n \"subdivisionType\": \"STATE\",\r\n \"subdivisionSelectionMode\": \"ALL_EXCEPT\",\r\n \"subdivisionCodes\": [\r\n \"AK\",\r\n \"HI\"\r\n ]\r\n }\r\n ],\r\n \"communicationPrograms\": [\r\n \"MKAD\",\r\n \"RETP\"\r\n ],\r\n \"numberOfMonths\": 9,\r\n \"autoDailer\": false,\r\n \"autoDailerToCell\": true,\r\n \"descriptionOfCalls\": \"ABC Inc\",\r\n \"consentManagement\": \"Demo Consent description\",\r\n \"consumerComplaintEmail\": \"john.anderson@test.com\",\r\n \"consumerComplaintPhone\": \"1234567890\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:44:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T15:59:07Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity communication info saved successfully. Proceed to the next step.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\"\n }\n}"},{"id":"643589c0-e5d8-4d05-ab7b-4ea8295a62d0","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \r\n \"customerRelationship\": [\r\n \"ECL\"\r\n ],\r\n \"existingPeriod\": [\r\n \"06M\"\r\n ],\r\n \"allStates\": \"Specific States\",\r\n \"communicationsStates\": {\r\n \"countryCode\": \"IN\",\r\n \"stateCodes\": [\r\n \"AK\"\r\n ]\r\n },\r\n \"communicationPrograms\": [\r\n \"MKAD\",\r\n \"RETP\"\r\n ],\r\n \"numberOfMonths\": 9,\r\n \"autoDailer\": false,\r\n \"autoDailerToCell\": true,\r\n \"descriptionOfCalls\": \"ABC Inc\",\r\n \"consentManagement\": \"Calls to existing and prospective customers to generate the sale of goods or services.d\",\r\n \"consumerComplaintEmail\": \"testservices@demo.com\",\r\n \"consumerComplaintPhone\": \"1234567890\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:49:28 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"customCode\": \"(Spring validation: `@NotBlank`)\"\n }\n ]\n}"},{"id":"c354eb20-aa8e-4dec-bf96-06408ea10d78","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \"type\": [\"B2C\"],\r\n \"customerRelationship\": [\"ECL\"], \r\n \"existingPeriod\": [\"06M\"],\r\n // \"allStates\": \"\",\r\n // \"communicationsStates\": {\r\n // \"countryCode\": \"US\",\r\n // \"stateCodes\": [\"\"]\r\n // },\r\n // \"communicationPrograms\": [],\r\n // \"programDescription\": \"\",\r\n // \"numberOfMonths\": \"\",\r\n // \"autoDialer\": null,\r\n // \"autoDialerToCell\": \"\",\r\n // \"descriptionOfCalls\": \"\"\r\n // \"consentManagement\": \"\",\r\n // \"consumerComplaintEmail\": \"\",\r\n // \"consumerComplaintPhone\": \"\",\r\n \"linkToDataPrivacy\": \"test\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=F0E6E77B6339CAD0CA2323C196B22028; Path=/dev2-eim; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:38:13 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"details\": [\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ENTITY_ACCESS_DENIED\"\n }\n ]\n}"},{"id":"5eaae271-54f4-4d2c-a37e-f5ec6a19ce12","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \r\n \"customerRelationship\": [\r\n \"ECL\"\r\n ],\r\n \"existingPeriod\": [\r\n \"06M\"\r\n ],\r\n \"allStates\": \"Specific States\",\r\n \"communicationsStates\": {\r\n \"countryCode\": \"US\",\r\n \"stateCodes\": [\r\n \"AK\"\r\n ]\r\n },\r\n \"communicationPrograms\": [\r\n \"MKAD\",\r\n \"RETP\"\r\n ],\r\n \"numberOfMonths\": 9,\r\n \"autoDailer\": false,\r\n \"autoDailerToCell\": true,\r\n \"descriptionOfCalls\": \"ABC Inc\",\r\n \"consentManagement\": \"Calls to existing and prospective customers to generate the sale of goods or services.d\",\r\n \"consumerComplaintEmail\": \"numeservices@demo.com\",\r\n \"consumerComplaintPhone\": \"8550861488\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:51:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"details\": [\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"},{"id":"a1add972-4a01-4e33-b27c-3fdf7e418366","name":"422 Unprocessable Entity (WebDAV) (RFC 4918)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCommunicationDetails\": {\r\n \"type\": [\r\n \"PRI\"\r\n ],\r\n \"customerRelationship\": [\r\n \"ECL\"\r\n ],\r\n \"existingPeriod\": [\r\n \"06M\"\r\n ],\r\n \"allStates\": \"Specific States\",\r\n \"communicationsStates\": {\r\n \"countryCode\": \"US\",\r\n \"stateCodes\": [\r\n \"AK\"\r\n ]\r\n },\r\n \"communicationPrograms\": [\r\n \"MKAD\",\r\n \"RETP\"\r\n ],\r\n \"numberOfMonths\": 9,\r\n \"autoDailer\": false,\r\n \"autoDailerToCell\": true,\r\n \"descriptionOfCalls\": \"ABC Inc\",\r\n \"consentManagement\": \"Calls to existing and prospective customers to generate the sale of goods or services.d\",\r\n \"consumerComplaintEmail\": \"numeservices@demo.com\",\r\n \"consumerComplaintPhone\": \"8550861488\"\r\n }\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 30 Apr 2026 17:47:13 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"details\": [\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ENTITY_ACCESS_DENIED\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"}],"_postman_id":"c37e977c-45c0-4ed4-b774-5ad4efe8703d"},{"name":"Email Notification","id":"e628f513-8a18-4d4b-8aac-544b5f2ebba7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Health Check By Brand\",\r\n \"emailAddresses\": [\r\n \"alerts@example.com\",\r\n \"ops@example.com\"\r\n ],\r\n \"emailAddresses[]\": \"[alerts@example.com](https://mailto:alerts@example.com)\"\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification","description":"

Description

Updates email notification recipients for a specific notification type. notificationType is required. If emailAddresses is provided, it replaces the entire recipient list for that type.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`notificationType`	String	Yes	Notification type display name (validated).	Health Check By Brand
`emailAddresses`	Array	No	List of recipient emails (max 15). When provided, replaces existing list.	[\"alerts@example.com\", \"[ops@example.com](https://mailto:ops@example.com)\"])
`emailAddresses\\[\\]`	String	No	Email address (validated).	[alerts@example.com](https://mailto:alerts@example.com)

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Email notification saved successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/email-notification
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.entityStatus`	String	Status of the Entity	\"Edit\"

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`notificationType`	String	Yes	INVALID_NOTIFICATION_TYPE	NotificationType cannot be null or blank.	400	Bad Request
`emailAddresses`	Array	No	MAXIMUM_15_EMAILS_ALLOWED	Too many recipients - maximum allowed is 15.	400	Bad Request
`emailAddresses\\[\\]`	String	No	INVALID_EMAIL_FORMAT	Invalid email format.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_CODE_BLANK	entityCode cannot be blank.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NOTIFICATION_TYPE	Invalid notification type.	422	Unprocessable Entity (WebDAV) (RFC 4918)
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_IN_APPROVED_STATUS	Entity status is Approved for entity {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_EMAIL	Duplicate email found : {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","email-notification"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"b2f95dd8-eef3-4675-a484-70c1ea0b5cba","name":"200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Health Check by Group\",\r\n \"emailAddresses\": [\r\n \"support@example.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 13:21:40 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T16:05:45Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity email notification updated successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"view\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\"\n }\n}"},{"id":"67bfbd17-de62-4fd8-844c-2d9c8fb88e4c","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Health Check by Group\",\r\n \"emailAddresses\": [\r\n \"admin@example.com\",\r\n \"runnexample.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 02 Apr 2026 08:25:53 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"notificationType\",\n \"issue\": \"NotificationType cannot be null or blank.\",\n \"customCode\": \"INVALID_NOTIFICATION_TYPE\"\n },\n {\n \"field\": \"emailAddresses\",\n \"issue\": \"Too many recipients - maximum allowed is 15.\",\n \"customCode\": \"MAXIMUM_15_EMAILS_ALLOWED\"\n }\n ]\n}"},{"id":"d3b3088d-4949-4fa9-ae5f-9475df3c1932","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Risk Rating Changes\",\r\n \"emailAddresses\": [\r\n \"admin@example.com\",\r\n \"runner@example.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 02 Apr 2026 10:07:17 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"details\": [\n {\n \"issue\": \"entityCode cannot be blank.\",\n \"customCode\": \"ENTITY_CODE_BLANK\"\n },\n {\n \"issue\": \"Invalid notification type.\",\n \"customCode\": \"INVALID_NOTIFICATION_TYPE\"\n },\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"},{"id":"6729dae5-0088-4f12-9447-e3b11f4772a4","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Health Check by Group\",\r\n \"emailAddresses\": [\r\n \"support@example.com\",\r\n \"support@example.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 30 Apr 2026 11:51:16 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"details\": [\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"},{"id":"2ec41c60-2a4c-4cfb-85d8-751f943fec27","name":"422 Unprocessable Entity (WebDAV) (RFC 4918)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notificationType\": \"Risk Changes\",\r\n \"emailAddresses\": [\r\n \"admin@example.com\",\r\n \"runner@example.com\"\r\n ]\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=D639B534763772F0F777FB85A1584871; Path=/dev2-eim; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 02 Apr 2026 10:06:03 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/email-notification\",\n \"details\": [\n {\n \"issue\": \"entityCode cannot be blank.\",\n \"customCode\": \"ENTITY_CODE_BLANK\"\n },\n {\n \"issue\": \"Invalid notification type.\",\n \"customCode\": \"INVALID_NOTIFICATION_TYPE\"\n },\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"}],"_postman_id":"e628f513-8a18-4d4b-8aac-544b5f2ebba7"}],"id":"f6d58ce3-caf8-493d-b9f9-4f2fbf2d45ff","_postman_id":"f6d58ce3-caf8-493d-b9f9-4f2fbf2d45ff","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}}},{"name":"Delete","item":[{"name":"Additional Address","id":"2039ff02-3682-444e-a5c0-bc11415d0a32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/additional-addresses/{addressId}","description":"

Description

Removes one additional address for an entity.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.
`addressId`	String	Yes	Numeric address identifier to delete.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response time (UTC).	2025-07-08T13:00:00Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Additional address deleted successfully.
`path`	String	API endpoint called.	/api/v1/entity/NUMEXXXXXXXX/additional-addresses/1001
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.entityStatus`	String	Status of the Entity	Edit
`data.addressId`	String	Deleted address identifier.	1001

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ADDITIONAL_ADDRESS_NOT_FOUND	Additional address not found.	404	Not Found

Description

Removes a single officer from the entity officers list by officer UUID.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.
`id`	String	Yes	Officer UUID.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Entity officer removed successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/entity-officers/{id}
`data.entityCode`	String	Entity code.	NUMEXXXXXXXX
`data.entityStatus`	String	Status of the Entity	Edit
`links.nextAction`	String	Link to view officers list.	/api/v1/entity/NUMEXXXXXXXX/entity-officers

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request
`id`	String	Yes	Officer ID (UUID) is required and must be a valid UUID format.	INVALID_OFFICER_ID	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","entity-officers","7354a94d-9ae0-4627-9fc3-b702a31bcec8"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"42dd883d-13d9-4264-b504-7bbd075fa44f","name":"200","originalRequest":{"method":"DELETE","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers/{entityOfficeId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 31 Mar 2026 11:30:30 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-09-01T16:34:38Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity officer removed successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers/fbdcf882-982c-4167-8a64-e8e1db682ebf\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Edit\"\n },\n \"links\": {\n \"nextAction\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers\"\n }\n}"},{"id":"37b8580b-7d8a-4566-b5ac-862d0066687c","name":"400-Bad-Request","originalRequest":{"method":"DELETE","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/ /entity-officers/{entityOfficeId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Apr 2026 14:04:58 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers/7354a94d-9ae0-4627-9fc3-b702a31bcec8\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"INVALID_ENTITY_CODE\",\n \"customCode\": \"entityCode cannot be null or blank.\"\n },\n {\n \"field\": \"id\",\n \"issue\": \"INVALID_OFFICER_ID\",\n \"customCode\": \"Officer ID (UUID) is required and must be a valid UUID format.\"\n }\n ]\n}"},{"id":"c3889dd5-5070-4535-8def-d38e8a40cf93","name":"404-Not-Found","originalRequest":{"method":"DELETE","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/entity-officers/{entityOfficeId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 31 Mar 2026 11:30:58 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/entity-officers/7354a94d-9ae0-4627-9fc3-b702a31bcec8\",\n \"details\": [\n {\n \"issue\": \"Entity with entityCode {0} was not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"}],"_postman_id":"8aa9005b-8f8a-420a-8dfb-f920a3cdf86a"},{"name":"Delete-Entity","id":"f99688fa-b9d5-4479-88fc-0faccdd6d240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMXXXXXX105","description":"

Description

Soft deletes an entity and cascades deletion to assigned entities (as implemented in service layer).

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity to delete.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2026-03-26T10:15:30:30Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Entity deleted successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ACOUNT_TYPE_IS_SINGLE_ENTITY	(message from bundle)	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found
ENTITY_STATUS_RESTRICTION	This entity is in {0} status which is restricted for deletion.	422	Unprocessable Entity (WebDAV) (RFC 4918)

Description

This endpoint returns high-level details for a specific entity, including its type, legal name, and status. This is typically the first step to inspect entity configuration before reviewing more detailed sections.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message about the response.	Entity basic information is retrieved successfully.
path	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/basic-info
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityName	String	Name of the entity.	Demo Entity
data.entityType	String	Entity type.	ROOT
data.clientLegalName	String	Full legal name of the client.	Demo Rest LLC
data.entityStatus	String	Current entity status.	NEW
data.rootEntityCode	String	Root entity code if this is an assigned entity; null for ROOT.	NUMROOT000001
links.self	String	Link to fetch the same basic info again.	/api/v1/entity/NUMEXXXXXXXX/basic-info
links.update	String	Link to update basic info (PATCH).	/api/v1/entity/NUMEXXXXXXXX/basic-info
links.view	String	Link to view basic info (same as self).	/api/v1/entity/NUMEXXXXXXXX/basic-info

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ACOUNT_TYPE_IS_SINGLE_ENTITY	(message from bundle)	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","basic-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"425129e8-2d18-4d34-aebb-7ba90cebded3","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/basic-info"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 29 Apr 2026 05:43:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=9299B4852D0FEA8FE203D5D2A36A22E6; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-29T05:43:43:43Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity basic information is retrieved successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityName\": \"Demo Root Entity\",\n \"entityType\": \"Root\",\n \"clientLegalName\": \"Demo Rest\"\n \"entityStatus\": \"New\",\n \"rootEntityCode\": \"NUMEXXXXXX105\"\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\",\n \"update\": \"/api/v1/entity/NUMEXXXXXXXX/basic-info\"\n }\n}"},{"id":"393a0361-483a-40b5-9560-12acdfed4355","name":"400-Bad-Request","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/ /basic-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=810BD2B1900D2D19153650BB826F01F2; Path=/dev2-eim; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 28 Apr 2026 06:21:13 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-28T06:21:13:13Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/dev2-eim/api/v1/entity/%20%20%20/basic-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n }\n ]\n}"},{"id":"48092c89-8ffb-4f65-bd81-9c37330421d4","name":"404-Not-Found","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/entity-officers"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Mar 2026 11:37:28 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-03-26T11:37:28:28Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/dev2-eim/api/v1/entity/NUMEXXXXXXXX/entity-officers\",\n \"details\": [\n {\n \"issue\": \"Entity with code NUMEXXXXXXXX has been deleted.\",\n \"customCode\": \"ENTITY_DELETED\"\n }\n ]\n}"}],"_postman_id":"a502db7c-c509-4c01-b2e6-77edfcce8328"},{"name":"General info","id":"56101909-1801-4f9e-95be-43f11d604312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/general-info","description":"

Description

Returns the entity’s descriptive fields, business address, and primary point-of-contact details.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message about the response.	General information is retrieved successfully.
path	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/general-info
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Current entity status.	NEW
data.description	String	Entity description.	Demo description
data.parentCompany	String	Parent company (if applicable).	Demo Parent Inc.
data.addressLine1	String	Address line 1.	123 Main St
data.addressLine2	String	Address line 2.	Suite 100
data.city	String	City.	Reston
data.zipCode	String	ZIP/postal code.	20190
data.country	String	Country (currently returned as stored value in DB; may be an ID).	US
data.stateCode	String	State (currently returned as stored value in DB; may be an ID).	VA
data.phoneNumber	String	Primary phone number.	5551234567
data.fax	String	Fax number.	5559876543
data.website	String	Website URL.	https://www.example.com
data.pointOfContact.firstName	String	Point of contact first name.	John
data.pointOfContact.lastName	String	Point of contact last name.	Doe
data.pointOfContact.designation	String	Point of contact designation code.	DIR
data.pointOfContact.otherDesignation	String	Point of contact other designation (when designation is OTH).	VP
data.pointOfContact.phoneNumber	String	Point of contact phone number.	5551112222
data.pointOfContact.email	String	Point of contact email.	john.doe@example.com
links.self	String	Link to fetch general info again.	/api/v1/entity/NUMEXXXXXXXX/general-info
links.update	String	Link to update general info (PATCH).	/api/v1/entity/NUMEXXXXXXXX/general-info

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

Description

Returns the entity officers list for the specified entity.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message about the response.	Entity officers information is retrieved successfully.
path	String	The API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/entity-officers
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Current entity status.	NEW
data.entityOfficers[]	Array	List of officers (may be empty).
data.entityOfficers[].id	String	Officer UUID.	9f2b7a3d-4d8b-4a58-9d26-2fbd0d2b5a11
data.entityOfficers[].firstName	String	Officer first name.	John
data.entityOfficers[].lastName	String	Officer last name.	Doe
data.entityOfficers[].designation	String	Officer designation code.	CEO
data.entityOfficers[].otherDesignation	String	Other designation (when designation is OTH).	VP
data.entityOfficers[].phoneNumber	String	Officer phone number.	5551112222
data.entityOfficers[].email	String	Officer email.	john.doe@example.com
links.self	String	Link to fetch officers again.	/api/v1/entity/NUMEXXXXXXXX/entity-officers
links.update	String	Link to update officers (PATCH).	/api/v1/entity/NUMEXXXXXXXX/entity-officers

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

Description

Returns billing address/contact information and RCD authorizer details for the specified entity.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message.	Billing and RCD information is retrieved successfully.
path	String	API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Entity status.	NEW
data.businessEntityBillingDetails.addressLine1	String	Billing address line 1.	123 Main St
data.businessEntityBillingDetails.addressLine2	String	Billing address line 2.	Suite 200
data.businessEntityBillingDetails.city	String	Billing city.	Reston
data.businessEntityBillingDetails.zipCode	String	Billing ZIP/postal code.	20190
data.businessEntityBillingDetails.country	String	Billing country (currently returned as stored value in DB; may be an ID).	US
data.businessEntityBillingDetails.stateCode	String	Billing state (currently returned as stored value in DB; may be an ID).	VA
data.businessEntityBillingDetails.phoneNumber	String	Billing phone number.	5557778888
data.rcdAuthorizer.firstName	String	RCD authorizer first name.	John
data.rcdAuthorizer.lastName	String	RCD authorizer last name.	Doe
data.rcdAuthorizer.designation	String	RCD authorizer designation (may be null).
data.rcdAuthorizer.otherDesignation	String	RCD authorizer other designation (may be null).
data.rcdAuthorizer.phoneNumber	String	RCD authorizer phone (may be null).
data.rcdAuthorizer.email	String	RCD authorizer email.	john.doe@example.com
links.self	String	Link to fetch billing & RCD info again.	/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info
links.update	String	Link to update billing & RCD info (PATCH).	/api/v1/entity/NUMEXXXXXXXX/billing-rcd-info

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

Description

Returns business profile details and registered agent information for the specified entity.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message.	Business information is retrieved successfully.
path	String	API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/business-info
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Entity status.	NEW
data.entityBusinessDetails.year	String	Year of incorporation/established.	2015
data.entityBusinessDetails.type	String	Business type code.	NP
data.entityBusinessDetails.businessIndustry	String	Business industry code.	HLTH
data.entityBusinessDetails.otherBusinessIndustry	String	Other industry description (when businessIndustry is OTH).	Other
data.entityBusinessDetails.stateOfIncorporation[]	Array	States of incorporation list.
data.entityBusinessDetails.stateOfIncorporation[].stateCode	String	State code.	VA
data.entityBusinessDetails.stateOfIncorporation[].stateName	String	State name (resolved).	Virginia
data.entityBusinessDetails.industryAssociations	Array	Industry association codes.	[\"CTIA\"]
data.entityBusinessDetails.otherIndustryAssociation	String	Other industry association (when OTH selected).	Other
data.registeredAgent.name	String	Registered agent name.	RA Corp
data.registeredAgent.address	String	Registered agent address.	1 RA Plaza
data.registeredAgent.city	String	Registered agent city.	Reston
data.registeredAgent.stateCode	String	Registered agent state code.	VA
data.registeredAgent.zipCode	String	Registered agent ZIP code.	20190
data.registeredAgent.countryAbbr	String	Registered agent country abbreviation.	US
links.self	String	Link to fetch business info again.	/api/v1/entity/NUMEXXXXXXXX/business-info
links.update	String	Link to update business info (PATCH).	/api/v1/entity/NUMEXXXXXXXX/business-info

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","business-info"],"host":["www","sandbox","numeracle","com"],"query":[{"disabled":true,"key":"entityCode","value":"INTE2047DEM2286"}],"variable":[]}},"response":[{"id":"e08534ca-1885-4b56-b2f5-719a5208a7ee","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/business-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity","NUMEXXXXXXXX","business-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:00:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=4160BF3EFAB875487F537F6E1DDDBA5C; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n\"timestamp\": \"2025-09-02T17:22:14Z\",\n\"status\": \"SUCCESS\",\n\"message\": \"Business information is retrieved successfully.\",\n\"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n\"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"NEW\",\n \"entityBusinessDetails\": {\n \"year\": \"2015\",\n \"legalStructure\": \"Service\",\n \"type\": \"NP\",\n \"businessIndustry\": \"HLTH\",\n \"otherBusinessIndustry\": null,\n \"naicsCode\": \"888543436\",\n \"noOfEmployees\": \"222\",\n \"ticker\": \"888543436\",\n \"eins\": \"888543436\",\n \"duns\": \"888543436\",\n \"lei\": \"Demos\",\n \"industryAssociations\": [\"ICL\",\"OTH\"],\n \"otherIndustryAssociation\": \"associations\",\n \"dbas\":[],\n \"licenseType\":\"ABC Testing\",\n \"professionalLicense\":\"Testing 12343\",\n \"stateOfIncorporation\": [\n {\n \"countryAbbr\": \"US\",\n \"stateCode\": \"AK\",\n \"fileNumber\": \"Y13me3255\"\n },\n {\n \"countryAbbr\": \"US\",\n \"stateCode\": \"AR\",\n \"fileNumber\": \"Y13me1000\"\n }\n ],\n },\n \"registeredAgent\": {\n \"name\": \"john\",\n \"address\": \"Ongole\",\n \"city\": \"ongole\",\n \"stateCode\": \"AK\",\n \"zipCode\": \"545434\",\n \"countryAbbr\": \"US\"\n }\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"update\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\"\n }\n}"},{"id":"fd3d88a3-3eb9-467a-beac-2bc65b88501e","name":"404-Not-Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/business-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity","NUMEXXXXXXXX","business-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:00:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T05:00:31:31Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/business-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code NUMEXXXXXXXX not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"},{"id":"ddc63d46-5b66-4e0b-a8af-9cb73456f2b9","name":"400-Bad-Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/ /business-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity"," ","business-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 28 Apr 2026 06:23:21 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-28T06:23:21:21Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/%20/business-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n }\n ]\n}"}],"_postman_id":"39598a32-772c-4a61-bb7f-73fdc76b2cce"},{"name":"Communication Info","id":"5d3105eb-d40a-42bb-96e5-6699a27e70a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/communication-info","description":"

Description

Returns communication configuration for the entity (customer types/relationships, programs, complaint channels, and state targeting).

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message.	Communication information is retrieved successfully.
path	String	API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/communication-info
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Entity status.	NEW
data.entityCommunicationDetails.type	Array	Communication customer type codes.	[\"BPO\"]
data.entityCommunicationDetails.customerType	Array	Customer type (currently not stored; may be null).
data.entityCommunicationDetails.customerRelationship	Array	Customer relationship codes.	[\"ECL\"]
data.entityCommunicationDetails.existingPeriod	Array	Existing period codes (required when relationship includes ECL).	[\"LT12\"]
data.entityCommunicationDetails.allStates	String	State targeting mode.	Specific States
data.entityCommunicationDetails.communicationsStates.countryCode	String	Country code for communications states.	US
data.entityCommunicationDetails.communicationsStates.stateCodes	Array	State codes list for communications.	[\"VA\",\"CA\"]
data.entityCommunicationDetails.communicationPrograms	Array	Communication program codes.	[\"MKAD\"]
data.entityCommunicationDetails.programDescription	String	Program description (only valid with specific programs).	Description
data.entityCommunicationDetails.numberOfMonths	Integer	Duration in months (parsed).	6
data.entityCommunicationDetails.autoDailer	Boolean	Uses autodialer.	true
data.entityCommunicationDetails.autoDailerToCell	Boolean	Uses autodialer to cell phones.	false
data.entityCommunicationDetails.consumerComplaintEmail	String	Complaint email.	complaints@example.com
data.entityCommunicationDetails.consumerComplaintPhone	String	Complaint phone.	5551112222
links.self	String	Link to fetch communication info again.	/api/v1/entity/NUMEXXXXXXXX/communication-info
links.update	String	Link to update communication info (PATCH).	/api/v1/entity/NUMEXXXXXXXX/communication-info

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","communication-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"27bf26d5-6c43-4428-b100-1b909262b706","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/communication-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity","NUMEXXXXXXXX","communication-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:55:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=1DF243A0E5DABE789EDC7DBCF9DEA9B1; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T05:55:07:07Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Communication information is retrieved successfully.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"data\": {\n \"entityCode\": \"NUMEXXXXXXXX\",\n \"entityStatus\": \"Approved\",\n \"entityCommunicationDetails\": {\n \"type\": [\n \"B2B\"\n ],\n \"customerRelationship\": [\n \"ECL\"\n ],\n \"existingPeriod\": [\n \"06M\"\n ],\n \"allStates\": \"Specific States\",\n \"communicationsStates\": {\n \"countryCode\": \"US\",\n \"stateCodes\": [\n \"AK\"\n ]\n },\n \"communicationPrograms\": [\n \"MKAD\",\n \"WIEF\"\n ],\n \"programDescription\": \"Test Program Description API\",\n \"numberOfMonths\": 9,\n \"autoDailer\": true,\n \"autoDailerToCell\": true,\n \"descriptionOfCalls\": \"Service Upgraded\",\n \"consentManagement\": \"Test Consent Mgt API\",\n \"consumerComplaintEmail\": \"demotesterentity@test.com\",\n \"consumerComplaintPhone\": \"123456789\"\n }\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"update\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\"\n }\n}"},{"id":"292fb0bc-4234-4ba3-a496-bf702bd249cd","name":"404-Not-Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/communication-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity","NUMEXXXXXXXX","communication-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:55:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T05:55:32:32Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/communication-info\",\n \"details\": [\n {\n \"issue\": \"Entity with code NUMEXXXXXXXX not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"},{"id":"d6be8559-659a-4e4c-a24f-6b05feb1d5f6","name":"400-Bad-Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/entity/ /communication-info","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","entity"," ","communication-info"],"query":[{"key":"entityCode","value":"INTE2047DEM2286","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=FC63EFCFA99122DA5C1A9656DEFBBE63; Path=/dev2-eim; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 27 Apr 2026 07:03:06 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T07:03:06:06Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/%20%20/communication-info\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n }\n ]\n}"}],"_postman_id":"5d3105eb-d40a-42bb-96e5-6699a27e70a1"},{"name":"Email Notification","id":"84115a78-d970-471d-b371-a1b098dc3919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/email-notification","description":"

Description

Returns email notification recipients grouped by notification type for the entity. Only active (non-deleted) recipients are returned.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity.

Response Parameters (200)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message.	Email notification settings are retrieved successfully.
path	String	API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/email-notification
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Entity status.	NEW
data.notifications[]	Array	Notifications grouped by type.
data.notifications[].notificationType	String	Notification display name (derived from notificationId).	Daily Digest
data.notifications[].emailAddresses	Array	Active email addresses for that notification type.	[\"a@x.com\",\"b@x.com\"]
links.self	String	Link to fetch notifications again.	/api/v1/entity/NUMEXXXXXXXX/email-notification
links.update	String	Link to update notifications (PATCH).	/api/v1/entity/NUMEXXXXXXXX/email-notification
links.delete	String	Link to delete notifications (DELETE).	/api/v1/entity/NUMEXXXXXXXX/email-notification

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

Description

Returns the feature configuration (enabled/disabled flags) for a ROOT entity.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
entityCode	String	Yes	Unique identifier for the entity. Must be a ROOT entity.

Response Parameters (200)

Name	Type	Description	Example
timestamp	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
status	String	API response status.	SUCCESS
message	String	Informational message.	Config features information is retrieved successfully.
path	String	API endpoint that was called.	/api/v1/entity/NUMEXXXXXXXX/config-features
data.entityCode	String	Code of the entity.	NUMEXXXXXXXX
data.entityStatus	String	Entity status.	NEW
data.features.numberReputationManagement.enabled	Boolean	Number Reputation Management enabled flag.	true
data.features.remediation.enabled	Boolean	Remediation enabled flag.	false
data.features.numberCheck.enabled	Boolean	Number Check enabled flag.	true
data.features.numberCheck.options.checkType	String	Number Check checkType option (when applicable).	NOT_APPLICABLE
data.features.smartBranding.sVIP.enabled	Boolean	Smart Branding SVIP enabled flag.	true
data.features.smartBranding.brandedCalling.enabled	Boolean	Smart Branding Branded Calling enabled flag.	false
links.self	String	Link to fetch config features again.	/api/v1/entity/NUMEXXXXXXXX/config-features
links.update	String	Link to update config features (PATCH).	/api/v1/entity/NUMEXXXXXXXX/config-features
links.delete	String	Link to delete/disable features (if supported).	/api/v1/entity/NUMEXXXXXXXX/config-features

Input Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
entityCode	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with entityCode {0} was not found.	404	Not Found
ENTITY_ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found
INVALID_ENTITY_TYPE_FOR_FEATURES	Features are only available for Root entities.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","config-features"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"4a88e7f8-f75a-48fb-adcd-90eac93ebed5","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/config-features"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:56:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T05:56:57Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity feature configuration retrieved successfully.\",\n \"path\": \"/api/v1/entity/NUMXXXXXX105/config-features\",\n \"data\": {\n \"entityCode\": \"NUMXXXXXX105\",\n \"entityStatus\": \"Approved\",\n \"features\": {\n \"numberReputationManagement\": {\n \"enabled\": true\n },\n \"remediation\": {\n \"enabled\": true\n },\n \"numberCheck\": {\n \"enabled\": false,\n \"options\": {\n \"checkType\": \"Allow trial\"\n }\n },\n \"smartBranding\": {\n \"brandedCalling\": {\n \"enabled\": true\n },\n \"sVIP\": {\n \"enabled\": false\n }\n }\n }\n },\n \"links\": {\n \"self\": \"/api/v1/entity/NUMXXXXXX105/config-features\",\n \"update\": \"/api/v1/entity/NUMXXXXXX105/config-features\",\n \"delete\": \"/api/v1/entity/NUMXXXXXX105/config-features\"\n }\n}"},{"id":"e5c8c5df-8a2e-4bf9-b486-238716e5fe45","name":"404-Not-Found","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/config-features"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Apr 2026 05:57:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-27T05:57:28:28Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/NUMEXXXXXXXX/config-features\",\n \"details\": [\n {\n \"issue\": \"Entity with code NUMEXXXXXXXX not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n }\n ]\n}"},{"id":"1f811280-dfac-42a5-872d-da7f7db97c03","name":"400-Bad-Request","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/ /config-features"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 28 Apr 2026 06:24:14 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-04-28T06:24:14:14Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/%20%20/config-features\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n }\n ]\n}"}],"_postman_id":"29bd1777-6788-4b95-9964-03e83a592504"},{"name":"View Entity","id":"49e77290-66a0-4c62-8b6b-ae914ebe912b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/view","description":"

Description

Returns the complete entity profile in a single flat response, aggregating all v1 split sections (basic info, general info, additional addresses, officers, billing/RCD, business info, and communication info). This is the v1 equivalent of the legacy v0 View Entity (GET /api/entityInfo?entityCode=...) endpoint.

Use this endpoint when you need the full entity snapshot without calling each section GET separately. The links object includes URLs to each individual section endpoint.

entityBusinessDetails by principal address country

data.entityBusinessDetails uses the same country-specific shaping as GET business-info (driven by the entity principal address country on general-info):

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Unique identifier for the entity.

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	Time when the response was generated (UTC).	2025-09-02T17:22:14:14Z
`status`	String	API response status.	SUCCESS
`message`	String	Informational message.	Entity details retrieved successfully.
`path`	String	The API endpoint that was called.	/api/v1/entity/INTEXXXXBC2446/view
`data.entityCode`	String	Entity code.	INTEXXXXBC2446
`data.entityStatus`	String	Current entity status.	NEW
`data.entityName`	String	Entity name.	Demo Entity
`data.entityType`	String	Entity type (`Root` or `Assigned`).	Root
`data.clientLegalName`	String	Client legal name.	Demo Rest LLC
`data.rootEntityCode`	String	Root entity code for assigned entities; null for Root.	NUMROOT000001
`data.description`	String	Entity description.	Demo entity for campaign support
`data.parentCompany`	String	Parent company.	Demo Parent Inc
`data.addressLine1`	String	Primary address line 1.	123 Main St
`data.addressLine2`	String	Primary address line 2.	Suite 200
`data.city`	String	City.	Reston
`data.county`	String	County (when applicable).	Fairfax
`data.zipCode`	String	Postal code.	20190
`data.addressType`	String	Address type code.	HEAD_OFFICE
`data.addressTypeOther`	String	Other address type (when addressType is OTHER).
`data.country`	String	ISO country code.	US
`data.subdivisionType`	String	Region type (e.g. STATE, PROVINCE).	STATE
`data.subdivisionCode`	String	Region code.	VA
`data.stateCode`	String	US-only legacy state code (same as subdivisionCode for US).	VA
`data.phoneNumber`	String	Entity phone number.	7035550100
`data.fax`	String	Fax number.	7035550101
`data.website`	String	Website URL.	https://www.example.com
`data.pointOfContactFirstName`	String	Point of contact first name.	Jane
`data.pointOfContactLastName`	String	Point of contact last name.	Doe
`data.pointOfContactDesignation`	String	POC designation code.	CEO
`data.pointOfContactOtherDesignation`	String	Other POC designation (when designation is OTH).
`data.pointOfContactPhoneNumber`	String	POC phone.	7035550102
`data.pointOfContactEmail`	String	POC email.	jane.doe@example.com
`data.entityOfficers[]`	Array	Entity officers (same shape as GET entity-officers).
`data.entityOfficers[].id`	String	Officer UUID.	2a52f426-58cb-4e7d-8f57-bf39047f31f1
`data.entityOfficers[].firstName`	String	Officer first name.	John
`data.entityOfficers[].lastName`	String	Officer last name.	Smith
`data.entityOfficers[].designation`	String	Officer designation code.	CEO
`data.entityOfficers[].otherDesignation`	String	Other designation (when designation is OTH).
`data.entityOfficers[].phoneNumber`	String	Officer phone.	7035550103
`data.entityOfficers[].email`	String	Officer email.	john.smith@example.com
`data.additionalAddresses[]`	Array	Additional addresses (same shape as GET additional-addresses).
`data.entityBusinessDetails`	Object	Business profile (country-specific registry shaping; see table above).
`data.entityBusinessDetails.year`	Integer	Year of incorporation/business start.	2000
`data.entityBusinessDetails.legalStructure`	String	Legal structure (country-specific lookup values).	LLC
`data.entityBusinessDetails.type`	String	Business type code.	PRI
`data.entityBusinessDetails.businessIndustry`	String	Business industry code.	MD
`data.entityBusinessDetails.otherBusinessIndustry`	String	Other industry (when businessIndustry is OTH).
`data.entityBusinessDetails.noOfEmployees`	String	Employee count band.	200
`data.entityBusinessDetails.lei`	String	Legal Entity Identifier.
`data.entityBusinessDetails.ticker`	String	Stock ticker.
`data.entityBusinessDetails.dbas[]`	Array	Doing-business-as names.
`data.entityBusinessDetails.industryAssociations[]`	Array	Industry association codes.
`data.entityBusinessDetails.otherIndustryAssociation`	String	Other association (when OTH selected).
`data.entityBusinessDetails.naicsCode`	String	US principal only.** NAICS code.	541511
`data.entityBusinessDetails.eins[]`	Array	US principal only.** EIN list.
`data.entityBusinessDetails.duns`	String	US principal only.** DUNS.
`data.entityBusinessDetails.stateOfIncorporation[]`	Array	US principal only**.
`data.entityBusinessDetails.stateOfIncorporation[].countryAbbr`	String	Country of incorporation.	US
`data.entityBusinessDetails.stateOfIncorporation[].subdivisionType`	String	Region type.	STATE
`data.entityBusinessDetails.stateOfIncorporation[].subdivisionCode`	String	Region code.	VA
`data.entityBusinessDetails.stateOfIncorporation[].stateCode`	String	US state code (resolved).	VA
`data.entityBusinessDetails.stateOfIncorporation[].fileNumber`	String	Incorporation file number.	12345678
`data.entityBusinessDetails.otherBusinessIdentification`	Object
`data.entityBusinessDetails.otherBusinessIdentification.identificationType`	String	Identification type.
`data.entityBusinessDetails.otherBusinessIdentification.identificationNumber`	String	Identification number.
`data.entityBusinessDetails.otherBusinessIdentification.description`	String	Description (10–500 chars).
`data.registeredAgent`	Object	Registered agent (same shape as GET business-info `registeredAgent`).
`data.businessEntityBillingDetails`	Object	Billing address (same shape as GET billing-rcd-info).
`data.rcdAuthorizer`	Object	RCD authorizer (same shape as GET billing-rcd-info).
`data.entityCommunicationDetails`	Object	Communication details (same shape as GET communication-info; legacy `allStates` / `communicationsStates` omitted).
`links.self`	String	Link to this view endpoint.	/api/v1/entity/INTEXXXXBC2446/view
`links.basicInfo`	String	Link to basic-info section.	/api/v1/entity/INTEXXXXBC2446/basic-info
`links.generalInfo`	String	Link to general-info section.	/api/v1/entity/INTEXXXXBC2446/general-info
`links.additionalAddresses`	String	Link to additional-addresses section.	/api/v1/entity/INTEXXXXBC2446/additional-addresses
`links.entityOfficers`	String	Link to entity-officers section.	/api/v1/entity/INTEXXXXBC2446/entity-officers
`links.billingRcdInfo`	String	Link to billing-rcd-info section.	/api/v1/entity/INTEXXXXBC2446/billing-rcd-info
`links.businessInfo`	String	Link to business-info section.	/api/v1/entity/INTEXXXXBC2446/business-info
`links.communicationInfo`	String	Link to communication-info section.	/api/v1/entity/INTEXXXXBC2446/communication-info

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request

Business Validations

Business Validations◀▶

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
ENTITY_NOT_FOUND	Entity with code {0} not found.	404	Not Found
ACCESS_DENIED	You do not have access to entity {0}.	403	Forbidden
ACOUNT_TYPE_IS_SINGLE_ENTITY	(message from bundle)	403	Forbidden
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
ENTITY_NO_LONGER_AVAILABLE	Entity with code {0} has been deleted.	404	Not Found

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","entity","{entityCode}","view"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"fd218f0f-927c-49c0-a071-f5640a3c0706","name":"200","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/view"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jul 2026 11:37:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: \""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-02T17:22:14:14Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Entity details retrieved successfully.\",\n \"path\": \"/api/v1/entity/INTEXXXXBC2446/view\",\n \"data\": {\n \"entityCode\": \"INTEXXXXBC2446\",\n \"entityStatus\": \"NEW\",\n \"entityName\": \"Demo US Entity\",\n \"entityType\": \"Root\",\n \"clientLegalName\": \"Demo Rest LLC\",\n \"rootEntityCode\": null,\n \"description\": \"US demo entity\",\n \"parentCompany\": \"Demo Parent Inc\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Suite 200\",\n \"city\": \"Reston\",\n \"county\": \"Fairfax\",\n \"zipCode\": \"20190\",\n \"addressType\": \"HEAD_OFFICE\",\n \"addressTypeOther\": null,\n \"country\": \"US\",\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"VA\",\n \"stateCode\": \"VA\",\n \"phoneNumber\": \"7035550100\",\n \"fax\": \"7035550101\",\n \"website\": \"https://www.example.com\",\n \"pointOfContactFirstName\": \"Jane\",\n \"pointOfContactLastName\": \"Doe\",\n \"pointOfContactDesignation\": \"CEO\",\n \"pointOfContactOtherDesignation\": null,\n \"pointOfContactPhoneNumber\": \"7035550102\",\n \"pointOfContactEmail\": \"jane.doe@example.com\",\n \"entityOfficers\": [\n {\n \"id\": \"2a52f426-58cb-4e7d-8f57-bf39047f31f1\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"designation\": \"CEO\",\n \"otherDesignation\": null,\n \"phoneNumber\": \"7035550103\",\n \"email\": \"john.smith@example.com\"\n }\n ],\n \"additionalAddresses\": [],\n \"entityBusinessDetails\": {\n \"year\": 2000,\n \"legalStructure\": \"LLC\",\n \"type\": \"PRI\",\n \"businessIndustry\": \"MD\",\n \"noOfEmployees\": \"200\",\n \"naicsCode\": \"541511\",\n \"ticker\": null,\n \"duns\": \"123456789\",\n \"lei\": null,\n \"dbas\": [],\n \"eins\": \"12-3456789\",\n \"industryAssociations\": [],\n \"stateOfIncorporation\": [\n {\n \"countryAbbr\": \"US\",\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"VA\",\n \"stateCode\": \"VA\",\n \"fileNumber\": \"12345678\"\n }\n ]\n },\n \"registeredAgent\": null,\n \"businessEntityBillingDetails\": {\n \"addressLine1\": \"456 Billing Ave\",\n \"addressLine2\": null,\n \"city\": \"Reston\",\n \"zipCode\": \"20190\",\n \"country\": \"US\",\n \"countryAbbr\": \"US\",\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"VA\",\n \"stateCode\": \"VA\",\n \"county\": null,\n \"phoneNumber\": \"7035550104\"\n },\n \"rcdAuthorizer\": {\n \"firstName\": \"Alice\",\n \"lastName\": \"Authorizer\",\n \"email\": \"alice.authorizer@example.com\"\n },\n \"entityCommunicationDetails\": {\n \"type\": [\n \"B2B\"\n ],\n \"customerRelationship\": [\n \"ECL\"\n ],\n \"existingPeriod\": [\n \"06M\"\n ],\n \"communicationPrograms\": [\n \"MKAP\"\n ],\n \"programDescription\": \"Demo Service\",\n \"numberOfMonths\": 9,\n \"autoDailer\": false,\n \"autoDailerToCell\": false,\n \"descriptionOfCalls\": \"Demo outbound calls\",\n \"consentManagement\": \"Consent managed per policy.\",\n \"consumerComplaintEmail\": \"complaints@example.com\",\n \"consumerComplaintPhone\": \"7035550105\",\n \"linkToDataPrivacy\": \"https://www.example.com/privacy\",\n \"communicationsSubdivisions\": [\n {\n \"countryCode\": \"US\",\n \"subdivisionType\": \"STATE\",\n \"subdivisionSelectionMode\": \"SELECTED\",\n \"subdivisionCodes\": [\n \"VA\"\n ]\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"/api/v1/entity/INTEXXXXBC2446/view\",\n \"basicInfo\": \"/api/v1/entity/INTEXXXXBC2446/basic-info\",\n \"generalInfo\": \"/api/v1/entity/INTEXXXXBC2446/general-info\",\n \"additionalAddresses\": \"/api/v1/entity/INTEXXXXBC2446/additional-addresses\",\n \"entityOfficers\": \"/api/v1/entity/INTEXXXXBC2446/entity-officers\",\n \"billingRcdInfo\": \"/api/v1/entity/INTEXXXXBC2446/billing-rcd-info\",\n \"businessInfo\": \"/api/v1/entity/INTEXXXXBC2446/business-info\",\n \"communicationInfo\": \"/api/v1/entity/INTEXXXXBC2446/communication-info\"\n }\n}"},{"id":"85b55a74-f7ed-4d70-8867-008e9a47ff9d","name":"400 - Bad Request","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/view"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jul 2026 11:37:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: \""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/{entityCode}/view\",\n \"details\": [\n {\n \"field\": \"entityCode\",\n \"issue\": \"INVALID_ENTITY_CODE\",\n \"customCode\": \"entityCode cannot be null or blank.\"\n }\n ]\n}"},{"id":"b39e138b-7c5a-4784-a0b3-485c03712b43","name":"403 - Forbidden","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/view"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jul 2026 11:37:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: \""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/{entityCode}/view\",\n \"details\": [\n {\n \"issue\": \"You do not have access to entity {0}.\",\n \"customCode\": \"ACCESS_DENIED\"\n },\n {\n \"issue\": \"(message from bundle)\",\n \"customCode\": \"ACOUNT_TYPE_IS_SINGLE_ENTITY\"\n }\n ]\n}"},{"id":"e3860986-86cc-48b6-b7d9-7b7bf7050c99","name":"404 - Entity not found","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/entity/{entityCode}/view"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jul 2026 11:37:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: \""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/entity/{entityCode}/view\",\n \"details\": [\n {\n \"issue\": \"Entity with code {0} not found.\",\n \"customCode\": \"ENTITY_NOT_FOUND\"\n },\n {\n \"issue\": \"Entity with code {0} has been deleted.\",\n \"customCode\": \"ENTITY_NO_LONGER_AVAILABLE\"\n }\n ]\n}"}],"_postman_id":"49e77290-66a0-4c62-8b6b-ae914ebe912b"}],"id":"f299fbdc-e942-4b9a-8f2e-bb2f38c86798","_postman_id":"f299fbdc-e942-4b9a-8f2e-bb2f38c86798","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f","id":"692a3820-fb79-487c-9b7a-8524ec78928f","name":"v1","type":"folder"}}},{"name":"Add Document","id":"bad948d0-72d7-47a6-ba8e-bfafc1efeaaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"document","type":"file","uuid":"944630ff-ba81-4aeb-b434-facf0c9a697a","src":"/C:/Users/JudeSanthoshKumarJos/Downloads/loa.pdf"},{"key":"description","value":"LOA for entity","type":"text","uuid":"ead180b3-d185-4098-ab9f-c3a6e67f647b"},{"key":"documentType","value":"LOA","type":"text","uuid":"19c44b84-98ba-4d2c-a6b5-847abf047e9f"}]},"url":"https://www.sandbox.numeracle.com/api/v1/entity/NUMEXXXXXXXX/addDocument","description":"

Description

Uploads a document for an entity and stores it for later download via Get Document.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Entity code. Must be a valid root entity code per v1 document rules.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`document`	File	Yes	Document file. Supported types: JPG/JPEG, PNG, DOC, DOCX, PDF.
`description`	String	Yes	Document description. Max length 50 characters.
`documentType`	String	Yes	Type of the document. Valid values are LOA , W9 or Other

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`documentID`	String	Uploaded document id.	3f5a1b2c-8c0d-4b7a-9c2e-7d3a0c9f1234
`documentName`	String	Original file name.	loa.pdf
`documentDescription`	String	Stored description.	LOA for entity
`uploadedDate`	String	Upload date.	2026-03-26

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Custom Error Code	Message	HTTP Status	Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityCode`	String	Yes	INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
`entityCode`	String	Yes	INVALID_ENTITY_CODE	Invalid Entity Code {0}. (super-user, missing)	400	Bad Request
`entityCode`	String	Yes	ACCESS_DENIED	Invalid entity mapping for root entity {0}. (non–super-user)	400	Bad Request
`document`	File	Yes	INVALID_DOCUMENT_FORMAT	Invalid document type or empty file.	400	Bad Request
`description`	String	Yes	INVALID_DESCRIPTION	description cannot be null or length exceeds 50 characters.	400	Bad Request
documentType	String	Yes	MALFORMED_REQUEST_PARAMETERS	Malformed request parameters. Check the request parameters.	400	Bad Request
documentType	String	Yes	INVALID_DOCUMENT_TYPE	documentType is required and must be a valid document type.	400	Bad Request

Description

Returns root entities accessible to the caller. For Rest API Super User, returns all root entities; otherwise returns client-specific root entities. Supports optional search/sort/pagination and an optional short response format.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`groupCount`	Integer	Yes	groupCount refers to the count of entities that need to be retrieved. Supported Maximum is 100
`groupStartIndex`	Integer	Yes	groupStartIndex refers to the start range in the index
`groupEndIndex`	Integer	Yes	groupEndIndex refers to the end range in the index
`isSort`	Boolean	Yes	isSort refers to sort the given column
`searchField`	String	Yes	searchField refers to entitycode
`searchValue`	String	No	Search value.
`sortColumn`	String	Yes	sortColumn refers to sorting that will be applied based on the name. (sortColumn=any filed name)
`sortOrder`	String	Yes	sortOrder refers to sorting the data in ascending order and descending order. (ASC/ DESC)
`shortResponse`	String	No	shortResponse specifies a short response body(with reduced response parameters). If set to N or if the field omitted from the request complete/detailed response will be returned. If set to Y, the body will contain a short response.
`lastFetchDateTime`	String	No	lastFetchDateTime specifies the DateTime in ISO 8601 Format (YYYY-MM-DDTHH:MM:SSZ) beyond which the records which were either newly added or newly deleted will be fetched. If not set, all records will be fetched.(e.g. `2026-03-26T10:15:30Z`).

Response Parameters:

Name	Type	Description	Example
`totalCount`	Long	Total number of records returned.	2
`activeCount`	Long	Active count for the returned list.	2
`maxFetchedDateTime`	String	Max fetched timestamp (UTC).	2026-03-26T10:15:30Z
`entityList\\[\\]`	Array	List of entities.
`entityList\\[\\].id`	Integer	Entity internal id.	123
`entityList\\[\\].entityCode`	String	Entity code.	NUMEXXXXXXXX
`entityList\\[\\].entityName`	String	Entity name.	Demo Entity
`entityList\\[\\].masterEntity`	String	Master/root entity code (for assigned).	NUMROOT000001
`entityList\\[\\].masterEntityName`	String	Master/root entity name.	Root Entity
`entityList\\[\\].entityType`	String	Entity type.	Root
`entityList\\[\\].clientLegalName`	String	Client legal name.	Demo Rest LLC
`entityList\\[\\].parentCompany`	String	Parent company.	Demo Parent Inc.
`entityList\\[\\].docsPresent`	Boolean	Indicates whether docs are present.	true
`entityList\\[\\].hasAssigned`	Boolean	Indicates whether assigned entities exist.	true
`entityList\\[\\].hasApprovedProfiles`	Boolean	Indicates whether approved profiles exist.	false
`entityList\\[\\].status`	String	Entity status.	New
`entityList\\[\\].accountType`	String	Account type label.	Multi
`entityList\\[\\].eid`	String	EID (if applicable).	EID123
`Name`	Type	Description	Example
`totalCount`	Long	Total number of records returned.	2
`activeCount`	Long	Active count for the returned list.	2
`maxFetchedDateTime`	String	Max fetched timestamp (UTC).	2026-03-26T10:15:30Z
`entityList\\[\\]`	Array	List of entities (short form).

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`shortResponse`	String	No	INVALID_SHORT_RESPONSE	shortResponse must be either 'Y' or 'N' if provided.	400	Bad Request
`lastFetchDateTime`	String	No	INVALID_LAST_FETCH_DATE_TIME_RESPONSE	lastFetchDateTime must follow ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).	400	Bad Request
`groupCount`	Integer	Yes	INVALID_GROUP_COUNT	groupCount is required.; or groupCount must be greater than 0 and maximum 100.	400	Bad Request
`groupStartIndex`	Integer	Yes	INVALID_GROUP_START_INDEX	groupStartIndex is required.; or groupStartIndex must be greater than or equal to 0.	400	Bad Request
`groupEndIndex`	Integer	Yes	INVALID_GROUP_END_INDEX	groupEndIndex is required.; or groupEndIndex must be greater than or equal to 0.; or groupEndIndex must be greater than or equal to groupStartIndex.	400	Bad Request
`isSort`	Boolean	Yes	INVALID_IS_SORT	isSort is required.	400	Bad Request
`searchField`	String	Yes	INVALID_SEARCH_FIELD	searchField is required.	400	Bad Request
`sortColumn`	String	Yes	INVALID_SORT_COLUMN	sortColumn is required.	400	Bad Request
`sortOrder`	String	Yes	INVALID_SORT_ORDER	sortOrder is required.; or sortOrder must be either ASC or DESC.	400	Bad Request

Description

Returns all assigned entities for the given root entity code. Supports optional incremental fetch and optional short response format.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`entityCode`	String	Yes	Root entity code. Must refer to a ROOT entity.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`shortResponse`	String	No	Y` for short list; `N` or omitted for full objects.
`lastFetchDateTime`	String	No	Incremental fetch; ISO 8601 UTC, format `YYYY-MM-DDTHH:MM:SSZ`.

Response Parameters:

Name	Type	Description	Example
`totalCount`	Long	Total number of records returned.	2
`activeCount`	Long	Active count for the returned list.	2
`maxFetchedDateTime`	String	Max fetched timestamp (UTC).	2026-03-26T10:15:30Z
`entityList\\[\\]`	Array	List of assigned entities.
`entityList\\[\\].id`	Integer	Entity internal id.	456
`entityList\\[\\].entityCode`	String	Assigned entity code.	NUMA00000001
`entityList\\[\\].entityName`	String	Assigned entity name.	Assigned Entity 1
`entityList\\[\\].masterEntity`	String	Root entity code.	NUMROOT000001
`entityList\\[\\].masterEntityName`	String	Root entity name.	Root Entity
`entityList\\[\\].entityType`	String	Entity type.	Assigned
`entityList\\[\\].clientLegalName`	String	Client legal name.	Demo Rest LLC
`entityList\\[\\].status`	String	Entity status.	New
`Name`	Type	Description	Example
`totalCount`	Long	Total number of records returned.	2
`activeCount`	Long	Active count for the returned list.	2
`maxFetchedDateTime`	String	Max fetched timestamp (UTC).	2026-03-26T10:15:30Z
`entityList\\[\\]`	Array	List of assigned entities (short form).

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`entityCode`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank.	400	Bad Request
`entityCode`	String	Yes	INVALID_ENTITY_CODE_LENGTH	entityCode maximum length is 50 characters.	400	Bad Request
`shortResponse`	String	No	INVALID_SHORT_RESPONSE	shortResponse must be either 'Y' or 'N' if provided.	400	Bad Request
`lastFetchDateTime`	String	No	INVALID_LAST_FETCH_DATE_TIME_RESPONSE	lastFetchDateTime must follow ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
INVALID_ENTITY_CODE	Invalid Entity Code {0}. (super-user, entity missing)	400	Bad Request
ACCESS_DENIED	Invalid entity mapping for root entity {0}. (non–super-user)	400	Bad Request
INVALID_ROOT_ENTITY	Details can only be retrieved for Root Entities. (non-root `entityCode_`)_	400	Bad Request

Description

Downloads a previously uploaded document by documentId.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`documentId`	String	Yes	Unique document identifier.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`(response body)`	Binary	File bytes streamed as an attachment.	(file)
`Content-Disposition`	String (header)	Attachment header with filename.	attachment; filename=loa.pdf
`Content-Type`	String (header)	MIME type of the stored document (or `application/octet-stream`).	application/pdf

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Custom Error Code	Message	HTTP Status Code	Http Status Text
`documentId`	String	Yes	INVALID_DOCUMENT_ID	(bundle `_INVALID_ENTITY_DCOUMENT_ID_` — blank/unknown id)	400	Bad Request
`documentId`	String	Yes	INVALID_ENTITY_CODE	entityCode cannot be null or blank. (if path constraint fires)	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	Http Status Text
INVALID_DOCUMENT_ID	(deleted document — `checkDocumentIsDeleted_`)_	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	400	Bad Request
ACCESS_DENIED	Invalid entity mapping for root entity {0}.	400	Bad Request

Introduction:
This suite of REST APIs facilitates a structured and modular approach to onboarding entities into the system. The process is divided into sequential steps, allowing for the incremental collection and submission of all necessary entity information. Each endpoint focuses on a specific aspect of entity data to ensure flexibility, maintainability, and data integrity throughout the onboarding workflow.

Summary of Entity API Endpoints
The API for entity management is structured into a series of endpoints, each dedicated to a specific step of the onboarding process.
1. Add Entity - Basic Info
This endpoint is the initial step, capturing essential identification details such as the entity's name, its type (root or assigned) and legal name.
2. Add Entity - General Info
After the basic info is saved, this endpoint handles additional metadata. It's used to store general details like business address, phone number, and website.
3. Add Entity - Officers
Use this endpoint to register key officers and personnel. It records their roles and contact
information.
4. Add Entity - Billing Details & RCD POC Info
This endpoint is for collecting billing related POC information. It also captures the designated point of contact for approvals (Rich call data POC).
5. Add Entity - Business Details
This endpoint is for gathering all operational and business-specific details, such as EIN, DUNS
number, and state of incorporation.
6. Add Entity - Communication Details
This endpoint collects all communication-related information for the entity. This includes the
business communication type, customer relationship status, consent management, and the types of calls made to name a few.
7. Submit Entity
This is the final step in the process. It validates and submits all the data collected from the previous endpoints for the final approval.

8. Email Notification
This endpoint enables email notifications for the entity.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"f73799a0-a0c2-4182-b20c-592f14919256"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"efebfeb2-0881-443b-abaf-fd67ea48ab37"}}],"_postman_id":"692a3820-fb79-487c-9b7a-8524ec78928f"}],"id":"0b145135-afd9-454e-975a-69e9f9830e2a","description":"

General Codes used in Entity APIs

Designation Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Designation	Codes
CEO	CEO
CFO	CFO
CIO	CIO
CTO	CTO
Other	OTH
President	PRE

State Table

State	Codes
Alberta	AB
British Columbia	BC
Manitoba	MB
New Brunswick	NB
Newfoundland and Labrador	NL
Northwest Territories	NT
Nova Scotia	NS
Nunavut	NU
Ontario	ON
Prince Edward Island	PE
Quebec	QC
Saskatchewan	SK
Yukon	YT
Alabama	AL
Alaska	AK
Arizona	AZ
Arkansas	AR
California	CA
Colorado	CO
Connecticut	CT
Delaware	DE
Florida	FL
Georgia	GA
Hawaii	HI
Idaho	ID
Illinois	IL
Indiana	IN
Iowa	IA
Kansas	KS
Kentucky	KY
Louisiana	LA
Maine	ME
Maryland	MD
Massachusetts	MA
Michigan	MI
Minnesota	MN
Mississippi	MS
Missouri	MO
Montana	MT
Nebraska	NE
Nevada	NV
New Hampshire	NH
New Jersey	NJ
New Mexico	NM
New York	NY
North Carolina	NC
North Dakota	ND
Ohio	OH
Oklahoma	OK
Oregon	OR
Pennsylvania	PA
Rhode Island	RI
South Carolina	SC
South Dakota	SD
Tennessee	TN
Texas	TX
Utah	UT
Vermont	VT
Virginia	VA
Washington	WA
West Virginia	WV
Wisconsin	WI
Wyoming	WY
Puerto Rico	PR
District of Columbia	DC

Country Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Country	Short Code
United States	US
Canada	CA

Industry Table

Business Category	Codes
Life and Safety	LAS
Safety Recall	SR
Telecommunications or Cable	TC
Insurance	INS
Resort and Travel	RAT
Accounts Receivable or Debt Collection	ARDC
Payday Loans	PL
Student Financing & Admissions	SFA
Lease and Rentals	LAR
Retail	RET
Medical Device	MD
Survey, Research, Polling	SRP
Financial Investment	FI
Home Security	HS
Charity, Nonprofit	CN
Other	OTH
Automotive	AUTO
Business Services	BUSE
Delivery/Shipping	DELV
Education	EDU
Government	GOV
Hospitality/Entertainment	HOSP
Legal	LEGA
Manufacturing	MANU
Non-Profit	NPRO
Personal Services	PER
Prison	PRIN
Public Service	PUB
Real Estate	REAL
Religious	RELI
Restaurant/Food Services	FOOD
Technology	TECH
Telecommunications	TELE
Trade Contractors	TRAD
Transportation	TRAN
Utilities	UTIL
Veterinary Services	VETE
Hospital/Healthcare	HEAL
Home Improvement	HIMP

Customer Relationship table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Customer Relation Name	Codes
New	NEW
Existing Client	ECL
Previous Purchaser	PPR

Customer Type Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Customer Type Name	Codes
Business to Business	B2B
Business to Consumer	B2C

Existing Period Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Existing Period Name	Codes
Current	CUR
within 6 months	06M
within 12 months	12M
within 18 months	18M

Communication Program Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Communication Program Name	Codes
Making appointments for face-to-face meetings at which a solicitation will be made	MKAP
Offering additional free items after the customer agrees to purchase one or more items, whether or not of the same type purchased	OFFI
Represents or implies the person will receive a prize or gift if the person makes a purchase or pays any money, including, but not limited to, delivery or shipping charges	RETP
Making calls to persons who have made an inquiry about an advertisement. If so, how long since the inquiry? Entre number of months (Text field)	MKAD
Using pre-recorded messages	PRME
Misrepresent or give a false representation or imply that a customer will receive a gift prize, or the value of a gift/prize, or misrepresent the value of a time-share offer/vacation, misrepresent the identity of the seller or the manufacturer of the goods or services	MIGI
Soliciting contracts for maintenance or repair of goods previously purchased from the seller	SOMA
Making calls for religious, charitable, political, educational or other non-commercial purposes	MARE
Program will not do any of these types of solicitation efforts (If yes, provide description below)	WIEF

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"c715afb2-38be-4930-b7b0-c0b30d223556"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"ddcdd78c-834b-40d6-90c8-722e6784ff8a"}}],"_postman_id":"0b145135-afd9-454e-975a-69e9f9830e2a"},{"name":"Profile","item":[{"name":"v1","item":[{"name":"Number Profile Api's","item":[{"name":"Add Profile","id":"c3ca4520-b248-4a09-82ba-027e3942930b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles","description":"

Description

This API end point is used to create a new number profile and associate numbers to it.

Create number profile contains two sections.

1.Number Profile Details.

2.Phone Number Details

Minimum one phone number must be added, and Maximum limit is 50 numbers.

Request Parameters:

Name	Type	Required	Description	Example
`contactCenter`	String	Yes	Type of contact center	Customer contact center
`country`	String	Yes	Country code	US
`terminatingCountry`	String	Conditional	Required when `country` is CA; must be omitted or blank for US/GB profiles.	US
`displayName`	String	Yes	Display name of the profile	Called display name
`entityCode`	String	No	Entity code	NUMEXXXXXXX
`infrastructure`	String	Yes	Infrastructure info	Infra@123
`intent`	String	Yes	Intent of the profile	GOVN
`numberHolder`	String	Yes	Number holder code	NUMEXXXXXXX
`procuredFrom`	String	Yes	Source of procurement	Renewal
`profileDescriptor`	String	Yes	Profile descriptor	Description of Profile
`rootEntityCode`	String	Yes	Root entity code	NUMEXXXXXXX
`shortCallDisplay`	String	No	Short call display name	Caller display
`phoneNumberList.active`	String	Yes	Whether the number is active	2079460XXX
`phoneNumberList.dno`	String	Yes	Direct number option	2079460XXX
`phoneNumberList.groupName`	String	Yes	Name of the group	2079460XXX
`phoneNumberList.phoneNumber`	String	Yes	Phone number	2079460XXX
`phoneNumberList.type`	String	Yes	Type of number (in/out)	2079460XXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	The time when the request was processed	2025-07-08T13:00:00Z
`status`	String	The overall result of the operation	SUCCESS
`message`	String	Informational message about the request	Number Profile Details are submitted for approval.
`path`	String	API endpoint path	/api/v1/number-profile
`data.numberProfileID`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	SUBMITTED
`links.self`	String	URL to view the submitted number profile	/api/v1/number-profile{numberProfileID}/view

Input Validation

Field	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`rootEntityCode`	Yes	@NotBlank	INVALID_ROOT_ENTITY_CODE	rootEntityCode cannot be null or blank.	400	Bad Request
`entityCode`	Yes	@NotBlank	INVALID_ENTITY_CODE_	entityCode cannot be null or blank.	400	Bad Request
`profileDescriptor`	Yes	@NotBlank	INVALID_PROFILE_DESCRIPTOR	profileDescriptor cannot be null or blank.	400	Bad Request
`profileDescriptor`	Yes	@Size	INVALID_PROFILE_DESCRIPTOR_LENGTH	profileDescriptor maximum length is 100 characters.	400	Bad Request
`procuredFrom`	Yes	@NotBlank	INVALID_PROCURED_FROM	procuredFrom cannot be null or blank.	400	Bad Request
`country`	Yes	@NotBlank	INVALID_COUNTRY	country cannot be null or blank.	400	Bad Request
`country`	Yes	@SupportedCountry	UNSUPPORTED_COUNTRY_CODE	Country Code not supported. Refer /v1/country-codes	400	Bad Request
`terminatingCountry`	Conditional (CA)	@Size	INVALID_TERMINATING_COUNTRY_LENGTH	terminatingCountry maximum length is 50 characters.	400
`displayName`	Yes	@NotBlank	INVALID_DISPLAY_NAME	displayName cannot be null or blank.	400	Bad Request
`displayName`	Yes	@Size	INVALID_DISPLAY_NAME_LENGTH	displayName minimum length is 3 characters and maximum length is 32 characters.	400	Bad Request
`shortCallDisplay`	Yes	@NotBlank	INVALID_SHORT_CALL_DISPLAY	shortCallDisplay cannot be null or blank.	400	Bad Request
`shortCallDisplay`	Yes	@Size	INVALID_SHORT_CALL_DISPLAY_LENGTH	shortCallDisplay min 3 chars, max 15 chars.	400	Bad Request
`intent`	Yes	@NotBlank	INVALID_INTENT	intent cannot be null or blank.	400	Bad Request
`numberHolder`	Yes	@NotBlank	INVALID_NUMBER_HOLDER	numberHolder cannot be null or blank.	400	Bad Request
`contactCenter`	Yes	@NotBlank	INVALID_CONTACT_CENTER	contactCenter cannot be null or blank.	400	Bad Request
`contactCenter`	Yes	@Size	INVALID_CONTACT_CENTER_LENGHT	contactCenter min 3 chars, max 100 chars.	400	Bad Request
`infrastructure`	Yes	@NotBlank	INVALID_INFRASTRUCTURE	infrastructure cannot be null or blank.	400	Bad Request
`infrastructure`	Yes	@Size	INVALID_INFRASTRUCTURE_LENGTH	infrastructure min 3 chars, max 100 chars.	400	Bad Request
`phoneNumberList`	Yes	@NotNull, @NotEmpty	INVALID_PHONE_NUMBER_LIST	phoneNumberList cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`phoneNumber`	Yes	@NotBlank	INVALID_PHONE_NUMBER	phoneNumber cannot be null or blank.	400	Bad Request
`phoneNumber`	Yes	E.164	INVALID_PHONE_NUMBER_E164	Phone number must be valid for profile country (E.164).	422	Unprocessable Entity
`phoneNumber`	Yes	Area code	INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for number in profile country.	422	Unprocessable Entity
`active`	Yes	@NotBlank	INVALID_ACTIVE	active cannot be null or blank.	400	Bad Request
`active`	Yes	@Pattern	INVALID_ACTIVE_PATTERN	active value must be 'Y' – Active, or 'N' – at Rest.	400	Bad Request
`type`	Yes	@NotBlank	INVALID_TYPE	type cannot be null or blank.	400	Bad Request
`type`	Yes	@Pattern	INVALID_TYPE_PATTERN	Type must hold 'in', 'out', or 'both' (monolithic). Split APIs use 'Inbound', 'Outbound', or 'both'.	400	Bad Request
`dno`	Yes	@NotBlank	INVALID_DNO	dno cannot be null or blank. Must be 'Y' or 'N'.	400	Bad Request
`dno`	Yes	@Pattern	INVALID_DNO_PATTERN	dno must be 'Y' or 'N'.	400	Bad Request
`groupName`	No	@Size	INVALID_GROUP_LENGTH	groupName maximum length is 50 characters.	400	Bad Request

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ROOT_ENTITY_TYPE	Invalid rootEntityCode {0}. Ensure that rootEntity entityType is Root	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT	Invalid \"Call Intent\" {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PHONE_NUMBER	Duplicate phone number detected: {0}. Please eliminate the duplicate.	409	Conflict
MAXIMUM_SIZE_OF_PHONENUMBER	Invalid phone Number list size {0}. Ensure that phoneNumberList must have 50 Phone Numbers.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NUMBER_HOLDER	Invalid Number Holder {0}. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_HOLDER_BRAND_STATUS	Number Holder or Brand entity is not submitted. Please submit the entity before adding the number profile.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent, The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
VENDOR_VALIDATION	NumberProfile is enabled for BCID. Please disable it to change the BPO.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for {0} in {1}	422	Unprocessable Entity (WebDAV) (RFC 4918)
NPA_FORMATE	Invalid number format observed for NPA-NXX-XXXX, allowed first digit under NXX should be within 2 and 9.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_WITH_RELATION	{0} already assigned to another relationship, please delete and add to this relationship.	409	Conflict
BRAND_CANNOT_BE_MODIFIED	Brand cannot be modified since the profile has been enabled for Smart branding. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)
CROSS_COUNTRY_PROFILE_NOT_ALLOWED	Cross-country number profile is not allowed for entity {0}. The entity must have an additional address in {1}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_REQUIRED_FOR_CA	TerminatingCountry is required for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_ONLY_FOR_CA	TerminatingCountry is only for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_TERMINATING_COUNTRY	Invalid TerminatingCountry	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","number-profiles"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"3851bb78-802f-404c-95c3-5daa7a49e3ec","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number Profile Details are submitted for approval.\",\n \"path\": \"/api/v1/number-profile\",\n \"data\": {\n \"numberProfileID\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"SUBMITTED\"\n },\n \"links\": {\n \"self\": \"/api/v1/number-profile{numberProfileID}/view\"\n }\n}"},{"id":"a56accb3-fa44-4290-a201-c7a9f73a7150","name":"400-BadRequest","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_ROOT_ENTITY_CODE\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_ENTITY_CODE_\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PROFILE_DESCRIPTOR\"\n }\n ]\n}"},{"id":"d92e9260-6b89-43af-ba34-e4c6c32b21b3","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Business validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/number-profiles\",\r\n \"details\": [\r\n {\r\n \"issue\": \"Invalid Entity Code {0}.\",\r\n \"customCode\": \"INVALID_ENTITY_CODE\"\r\n },\r\n {\r\n \"issue\": \"Invalid rootEntityCode {0}. Ensure that rootEntity entityType is Root\",\r\n \"customCode\": \"INVALID_ROOT_ENTITY_TYPE\"\r\n },\r\n {\r\n \"issue\": \"Invalid \"Call Intent\" {0}\",\r\n \"customCode\": \"INVALID_CALL_INTENT\"\r\n }\r\n ]\r\n}"}],"_postman_id":"c3ca4520-b248-4a09-82ba-027e3942930b"},{"name":"Update Profile","id":"88c81b2d-0a01-470f-a4c7-e0a740468f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/{numberProfileId}","description":"

Description

The Update Number Profile feature allows users to make changes to both single and multiple fields within a number profile. This includes modifying profile and phone information like display name, BPO, Contact centre, Procured from, number holder to name a few. In addition, users have the option to perform phone number actions such as adding, editing, or deleting numbers and its attributes such as active status, DNO (Directory Number Option), group name, and type. Users can update anywhere from one to a maximum of 50 phone numbers in a single API call.

In number profile action refers to what kind of operations performed on the phone numbers. Action includes (ADD, EDIT, DELETE). In actions like Edit, while the phone numbers themselves remain unchanged, various attributes associated with them can be updated.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

Name	Type	Required	Description	Example
`contactCenter`	String	Yes	Name of the customer contact center	Customer contact center
`country`	String	Yes	Country code	US
`displayName`	String	Yes	Caller display name	Caller display name
`entityCode`	String	Yes	Code of the entity	NUMEXXXXXXXXXX
`infrastructure`	String	Yes	Name of the customer infrastructure entity	Customer infrastructure
`intent`	String	Yes	Business intent code	GOVN
`numberHolder`	String	Yes	Code of the number holder	NUMEXXXXXXXXXX
`procuredFrom`	String	Yes	Source of phone number procurement	Renewal
`profileDescriptor`	String	Yes	Description of the number profile	Description of Profile
`rootEntityCode`	String	Yes	Code of the root entity	NUMEXXXXXXXXXX
`shortCallDisplay`	String	No	Caller display name for short calls	Caller display
`phoneNumberList.action`	String	Yes	Action on phone number is mentioned	2079460XXX
`phoneNumberList.active`	String	Yes	Whether the number is active (Y/N)	2079460XXX
`phoneNumberList.dno`	String	No	DNO flag (Y/N)	2079460XXX
`phoneNumberList.groupName`	String	No	Group name under which the number is added	2079460XXX
`phoneNumberList.phoneNumber`	String	Yes	Phone number to be added	2079460XXX
`phoneNumberList.type`	String	Yes	Type of number (e.g., \"in\" for inbound)	2079460XXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time when the response was generated	2025-07-08T13:00:00Z
`status`	String	Overall status of the request	SUCCESS
`message`	String	Informational message about the operation	Number Profile Details are submitted for approval.
`path`	String	Endpoint path that was called	/api/v1/number-profile
`data.numberProfileID`	String	Unique ID of the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	SUBMITTED
`links.self`	String	Link to view the submitted number profile	api/v1/number-profile/{numberProfiileId}/view

Input Validation

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`rootEntityCode`	Yes	rootEntityCode cannot be null or blank.	INVALID_ROOT_ENTITY_CODE	400	Bad Request
`entityCode`	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request
`profileDescriptor`	Yes	profileDescriptor maximum length is 100 characters.	INVALID_PROFILE_DESCRIPTOR_LENGTH	400	Bad Request
`procuredFrom`	Yes	procuredFrom cannot be blank.	INVALID_PROCURED_FROM_BLANK	400	Bad Request
`country`	Yes	country cannot be null or blank.	INVALID_COUNTRY	400	Bad Request
`country`	Yes	Country Code not supported. Refer /v1/country-codes	UNSUPPORTED_COUNTRY_CODE	400	Bad Request
`displayName`	Yes	displayName minimum length is 3 characters and maximum length is 32 characters.	INVALID_DISPLAY_NAME_LENGTH	400	Bad Request
`shortCallDisplay`	Yes	shortCallDisplay minimum length is 3 characters and maximum length is 15 characters.	INVALID_SHORT_CALL_DISPLAY_LENGTH	400	Bad Request
`intent`	Yes	intent cannot be blank.	INVALID_INTENT_BLANK	400	Bad Request
`numberHolder`	Yes	numberHolder cannot be blank.	INVALID_NUMBER_HOLDER_BLANK	400	Bad Request
`contactCenter`	Yes	contactCenter minimum length is 3 Characters and maximum length is 100 characters.	INVALID_CONTACT_CENTER_LENGHT	400	Bad Request
`numberProfileId`	Yes	numberProfileId cannot be null or blank.	INVALID_NUMBER_PROFILE_ID	400	Bad Request
`infrastructure`	Yes	infrastructure minimum length is 3 Characters and maximum length is 100 characters.	INVALID_INFRASTRUCTURE_LENGTH	400	Bad Request
`phoneNumberList`	Yes	phoneNumberList cannot be null or empty. Ensure that a single number is added.	INVALID_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumber`	Yes	phoneNumber cannot be null or blank.	INVALID_PHONE_NUMBER	400	Bad Request
`phoneNumber`	Yes	phoneNumber length is 10 digit.	INVALID_PHONE_NUMBER_LENGTH	400	Bad Request
`phoneNumber`	Yes	phoneNumber must contain digits only.	INVALID_PHONE_NUMBER_PATTERN	400	Bad Request
`active`	Yes	active cannot be null or blank.	INVALID_ACTIVE	400	Bad Request
`active`	Yes	active value must hold 'Y' – Active, or 'N'- at Rest.	INVALID_ACTIVE_PATTERN	400	Bad Request
`type`	Yes	type cannot be null or blank.	INVALID_TYPE	400	Bad Request
`type`	Yes	Type must hold 'in','out',or 'both'.	INVALID_TYPE_PATTERN	400	Bad Request
`dno`	Yes	dno cannot be null blank. dno must be 'Y' or 'N'.	INVALID_DNO	400	Bad Request
`dno`	Yes	dno must be 'Y' or 'N'.	INVALID_DNO_PATTERN	400	Bad Request
`groupName`	No	groupName maximum length is 50 characters.	INVALID_GROUP_LENGTH	400	Bad Request
`action`	Yes	action cannot be null or blank.	INVALID_ACTION	400	Bad Request
`action`	Yes	action must be 'ADD', 'EDIT', or 'DELETE'.	INVALID_ACTION_PATTERN	400	Bad Request

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ROOT_ENTITY_TYPE	Invalid rootEntityCode {0}. Ensure that rootEntity entityType is Root	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_PROFILE_NOT_FOUND	Number profiles are deleted.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT	Invalid \"Call Intent\" {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)
MAXIMUM_SIZE_OF_PHONENUMBER	Invalid phone Number list size {0}. Ensure that phoneNumberList must have 50 Phone Numbers.	422	Unprocessable Entity (WebDAV) (RFC 4918)
UNIQUEPHONENUMBERCHECK	\"Phone Number\" already exists	409	Conflict
INVALID_NUMBER_HOLDER	Invalid Number Holder {0}. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_HOLDER_BRAND_STATUS	Number Holder or Brand entity is not submitted. Please submit the entity before adding the number profile.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent. The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
VENDOR_VALIDATION	NumberProfile is enabled for BCID. Please disable it to change the BPO.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for {0} in {1}	422	Unprocessable Entity (WebDAV) (RFC 4918)
NPA_FORMATE	Invalid number format observed for NPA-NXX-XXXX, allowed first digit under NXX should be within 2 and 9.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_NOT_WITH_RELATION	Number {0} you are trying to delete does not exist in this \"Number Profile\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_WITH_RELATION	{0} already assigned to another relationship, please delete and add to this relationship.	409	Conflict
INVALID_RELATIONSHIP	Invalid \"Relationship\"	422	Unprocessable Entity (WebDAV) (RFC 4918)
BRAND_CANNOT_BE_MODIFIED	Brand cannot be modified since the profile has been enabled for Smart branding. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","number-profiles","{numberProfileId}"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"4530af95-2df8-4973-9dea-1c7b6975bab5","name":"200-OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXX"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number Profile Details are submitted for approval.\",\n \"path\": \"/api/v1/number-profile\",\n \"data\": {\n \"numberProfileID\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"SUBMITTED\"\n },\n \"links\": {\n \"self\": \"api/v1/number-profile/{numberProfiileId}/view\"\n }\n}"},{"id":"4c91f2c6-d88f-40c1-a18d-bb060a5ef9f6","name":"400-BadRequest","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXX"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/{numberProfileId}\",\n \"details\": [\n {\n \"field\": \"rootEntityCode\",\n \"issue\": \"rootEntityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ROOT_ENTITY_CODE\"\n },\n {\n \"field\": \"entityCode\",\n \"issue\": \"entityCode cannot be null or blank.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"field\": \"profileDescriptor\",\n \"issue\": \"profileDescriptor maximum length is 100 characters.\",\n \"customCode\": \"INVALID_PROFILE_DESCRIPTOR_LENGTH\"\n }\n ]\n}"},{"id":"469da560-1d90-4edf-9569-8b6bf3e9dbda","name":"422-Unprocessable Content","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXX"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/{numberProfileId}\",\n \"details\": [\n {\n \"issue\": \"Invalid Entity Code {0}.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"issue\": \"Invalid rootEntityCode {0}. Ensure that rootEntity entityType is Root\",\n \"customCode\": \"INVALID_ROOT_ENTITY_TYPE\"\n },\n {\n \"issue\": \"Number profiles are deleted.\",\n \"customCode\": \"NUMBER_PROFILE_NOT_FOUND\"\n }\n ]\n}"}],"_postman_id":"88c81b2d-0a01-470f-a4c7-e0a740468f1c"},{"name":"Delete Profile","id":"316af734-bfc6-49c8-a14b-4fe6014ef9f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"numberProfileIds\": [\r\n \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/batch-delete","description":"

Description

The Delete Number Profile feature allows users to remove entire number profiles from the system. By utilizing this functionality, users can permanently erase all associated information, including active status, DNO (Directory Number Option), group name, type, and any other details linked to the number profile. This action is irreversible and removes the number profile from the system entirely. It's essential to exercise caution when using this feature to avoid unintentional data loss. Users should ensure they have appropriate authorization and carefully review their actions before proceeding with the deletion of number profiles.

In number profile delete API along with profile details, associated numbers will also get deleted.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileIds`	List	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time when the response was sent	2025-08-19T17:10:45:45Z
`status`	String	Status of the response	SUCCESS
`message`	String	Description of the operation	Number Profiles are Deleted.
`path`	String	API endpoint that was hit	/api/number-profile
`data.numberProfileIds`	List	List of number profile Ids deleted	[\"NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\"]

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Constraint	Custom Error Code	Validation Message	HTTP Status Code	HTTP Error Message
`numberProfileIds`	Yes	@NotEmpty	INVALID_NUMBER_PROFILE_IDS	numberProfileIds must contain at least one profile Id.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_NUMBER_PROFILE_ID	Invalid numberProfileId {0}, please provide a valid numberProfileId.	422	Unprocessable Entity (WebDAV) (RFC 4918)
PROFILES_WITH_ACTIVE_BCIDS	Selected profile(s) has BCID enabled and cannot be deleted. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)
PROFILE_WITH_ACTIVE_BRANDED_CALLING	Selected profile(s) has Smart Branding enabled and cannot be deleted. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)

Description

The View Number Profile Details feature grants users access to comprehensive information about a specific number profile within the system. Users can examine various attributes and properties. This feature offers users a detailed overview of the number profile, enabling them to understand its characteristics and associated data fully.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	The time when the response was generated	2025-09-02T17:22:14:14Z
`status`	String	API response status	SUCCESS
`message`	String	Informational message about the response	Number profile details are retrieved.
`path`	String	The API endpoint that was called	/api/v1/number-profile/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/view
`data.rootEntityCode`	String	Code of the root entity	NUMEXXXXXXXXX
`data.rootEntityName`	String	Name of the root entity	ABC Testing Company
`data.entityCode`	String	Code of the assigned entity	NUMEXXXXXXXXX
`data.entityName`	String	Name of the assigned entity	ABC Testing Company
`data.profileDescriptor`	String	Descriptor for the number profile	Description of the profile
`data.numberProfileId`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
`data.procuredFrom`	String	Source from which numbers are procured	Renewal
`data.country`	String	Country associated with the number profile	US
`data.terminatingCountry`	String	TerminatingCountry (present for CA profiles)	US
`data.numberCount`	Integer	Count of phone numbers in the profile	1
`data.channel`	String	Communication channel used	Voice
`data.displayName`	String	Name displayed for calls	Caller display name
`data.shortCallDisplay`	String	Short display name for calls	Caller display
`data.intent`	String	Purpose or intent of the number	Government
`data.numberProvider`	String	The provider of the phone number	Renewal
`data.numberHolder`	String	Entity holding the phone number	ABC Testing Company
`data.contactCenter`	String	Contact center associated with the profile	Customer contact center
`data.infrastructure`	String	Infrastructure details	Customer infrastructure
`data.numberProfileStatus`	String	Status of the number profile	Submitted
`data.smartBranding`	String	Whether Smart Branding is enabled or disabled	Disable
`links.self`	String	Link to fetch the same profile again	/api/v1/number-profile/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/view

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Constraint	Custom Error Code	Validation Message	HTTP Status Code	HTTP Error Message
`numberProfileId`	Yes	@NotBlank	INVALID_NUMBER_PROFILE_ID	numberProfileId cannot be null or blank.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
NUMBER_PROFILE_NOT_FOUND	Number profiles are deleted.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_RELATIONSHIP_CODE	Invalid \"Relationship Code\" {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)

Description

This API end point is used to retrieve information about the list of number profiles associated with the given entity code or brand.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`entity code`	String	Yes	Unique number for an entity or brand	NUMEXXXXXXXXXXX
`groupCount`	int	Yes	groupCount	500
`groupEndIndex`	int	Yes	groupEndIndex	500
`groupStartIndex`	int	Yes	groupStartIndex	0
`lastFetchDateTime`	String	Yes	groupStartIndex	2025-08-16T01:07:07Z
`shortResponse`	String	Yes	shortResponse	Y

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	The time when the response was generated	2025-09-03T08:42:00:00Z
`status`	String	Status of the response	SUCCESS
`message`	String	Description of the response	Number profile details are retrieved.
`path`	String	API endpoint path	/api/v1/number-profile/list
`data.totalCount`	Long	Total number of number profiles	5
`data.activeCount`	Long	Number of active profiles	5
`data.maxFetchedDateTime`	LocalDateTime	Timestamp of the most recently updated profile	2025-08-18T09:25:43Z
`data.enterpriseRelationshipList.profileDescriptor`	String	Descriptor or label of the number profile	Description of Profile
`data.enterpriseRelationshipList.relationshipCode`	String	Unique code for the relationship	NUMEXXXXXXXXXXXXXXXX
`data.enterpriseRelationshipList.numberCount`	Integer	Count of numbers associated with the profile	1
`data.enterpriseRelationshipList.entityCode`	String	Code of the entity	NUMEXXXXXXX
`data.enterpriseRelationshipList.entityName`	String	Name of the entity	ABC Testing Company
`data.enterpriseRelationshipList.holderCode`	String	Code of the number holder (same as entity in this case)	NUMEXXXXXXX
`data.enterpriseRelationshipList.holderName`	String	Name of the number holder	ABC Testing Company
`data.enterpriseRelationshipList.procuredFrom`	String	Source from which the number was procured	Renewal
`data.enterpriseRelationshipList.brandName`	String	Name of the brand associated	ABC Testing Comapny
`data.enterpriseRelationshipList.brandCode`	String	Code of the brand	NUMEXXXXXXX
`data.enterpriseRelationshipList.status`	String	Status of the number profile (e.g., Submitted, Deleted)	Submitted
`data.enterpriseRelationshipList.callingPartyName`	String	Display name of the calling party	Caller Name
`data.enterpriseRelationshipList.shortCallDisplay`	String	Shortened display name for calling party	Caller Display
`data.enterpriseRelationshipList.callIntentCode`	String	Code for the call intent	GOVN
`data.enterpriseRelationshipList.callIntent`	String	Human-readable name for call intent	Government
`data.enterpriseRelationshipList.rcdStatus`	String	RCD (Rich Call Data) status	Pending
`data.enterpriseRelationshipList.countryAbbr`	String	Country abbreviation	US
`data.enterpriseRelationshipList.terminatingCountry`	String	TerminatingCountry (returned when countryAbbr is CA)	US
`data.enterpriseRelationshipList.createdDt`	String	Creation timestamp (formatted)	Aug 18 2025 09:25:43 AM
`data.enterpriseRelationshipList.updatedDate`	String	Last updated timestamp (formatted)	Aug 18 2025 09:25:46 AM

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`groupCount`	Yes	Group count must be greater than 0.	INVALID_GROUP_COUNT_MIN	400	Bad Request
`groupStartIndex`	Yes	Group start index must be greater than or equal to 0.	INVALID_GROUP_START_INDEX_MIN	400	Bad Request
`groupEndIndex`	Yes	Group end index must be greater than or equal to 0.	INVALID_GROUP_END_INDEX_MIN	400	Bad Request
`entityCode`	Yes	entityCode cannot be null.	INVALID_ENTITY_CODE	400	Bad Request
`shortResponse`	No	shortResponse must be either 'Y' or 'N' if provided.	INVALID_SHORT_RESPONSE	400	Bad Request
`lastFetchDateTime`	No	lastFetchDateTime must follow ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).	INVALID_LAST_FETCH_DATE_TIME_RESPONSE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
GROUP_START_POSITIVE	Group start index must be greater than or equal to 0.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_END_POSITIVE	Group end index must be greater than or equal to 0.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_END_INDEX	Group end index must be greater than or equal to group start index.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_INDEX_DIFFERENCE	The difference between group end index and group start index must be exactly {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_COUNT	Group count must always be {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_LAST_FETCH_DATE_TIME_FUTURE	lastFetchDateTime cannot be in the future. Please enter a correct date.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","number-profiles","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"e434b82a-73b0-44c9-a93e-e349cc239722","name":"200-OK Short Response-Y","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"groupCount\": 500,\r\n \"groupEndIndex\": 500,\r\n \"groupStartIndex\": 0,\r\n \"lastFetchDateTime\": \"2025-08-16T01:07:07Z\",\r\n \"shortResponse\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-09-03T08:42:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number profile details are retrieved.\",\n \"path\": \"/api/v1/number-profiles/search\",\n \"data\": {\n \"totalCount\": 5,\n \"activeCount\": 5,\n \"maxFetchedDateTime\": \"2025-08-18T09:25:43Z\",\n \"enterpriseRelationshipList\": [\n {\n \"profileDescriptor\": \"Profile Description 01\",\n \"relationshipCode\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"entityCode\": \"NUMEXXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXXX\",\n \"status\": \"Submitted\",\n \"createdDt\": \"Aug 18 2025 09:25:43 AM\",\n \"updatedDate\": \"Aug 18 2025 09:25:46 AM\"\n },\n {\n \"profileDescriptor\": \"Profile Description 02\",\n \"relationshipCode\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"entityCode\": \"NUMEXXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXXX\",\n \"status\": \"New\",\n \"createdDt\": \"Aug 18 2025 06:22:58 AM\",\n \"updatedDate\": \"Aug 18 2025 06:23:00 AM\"\n },\n {\n \"profileDescriptor\": \"Profile Description 03\",\n \"relationshipCode\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"entityCode\": \"NUMEXXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXXX\",\n \"status\": \"Deleted\",\n \"createdDt\": \"Aug 16 2025 12:41:46 PM\",\n \"updatedDate\": \"Aug 18 2025 04:12:05 AM\"\n },\n {\n \"profileDescriptor\": \"Profile Description 04\",\n \"relationshipCode\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"entityCode\": \"NUMEXXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXXX\",\n \"status\": \"Submitted\",\n \"createdDt\": \"Aug 16 2025 12:29:36 PM\",\n \"updatedDate\": \"Aug 16 2025 12:29:40 PM\"\n },\n {\n \"profileDescriptor\": \"Profile Description 05\",\n \"relationshipCode\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"entityCode\": \"NUMEXXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXXX\",\n \"status\": \"Submitted\",\n \"createdDt\": \"Aug 16 2025 12:17:45 PM\",\n \"updatedDate\": \"Aug 16 2025 12:17:46 PM\"\n }\n ]\n }\n}"},{"id":"07e4d092-9911-4e65-a14e-07bba32870db","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entityCode\": null,\r\n \"groupCount\": 500,\r\n \"groupEndIndex\": 500,\r\n \"groupStartIndex\": 0,\r\n \"lastFetchDateTime\": \"2025-08-16T01:07:07Z\",\r\n \"shortResponse\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/search\",\n \"details\": [\n {\n \"field\": \"groupCount\",\n \"issue\": \"Group count must be greater than 0.\",\n \"customCode\": \"INVALID_GROUP_COUNT_MIN\"\n },\n {\n \"field\": \"groupStartIndex\",\n \"issue\": \"Group start index must be greater than or equal to 0.\",\n \"customCode\": \"INVALID_GROUP_START_INDEX_MIN\"\n },\n {\n \"field\": \"groupEndIndex\",\n \"issue\": \"Group end index must be greater than or equal to 0.\",\n \"customCode\": \"INVALID_GROUP_END_INDEX_MIN\"\n }\n ]\n}"}],"_postman_id":"08e96b16-9787-4f6d-91ce-d04cdd3d3935"},{"name":"Create Profile Save","id":"385bb3ec-38b9-418f-84a7-d5ee21666eb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/draft","description":"

Description

This API end point is used to create a new number profile and associate numbers to it.

Create number profile contains two sections.

1.Number Profile Details.

2.Phone Number Details

Minimum one phone number must be added, and Maximum limit is 200 numbers.

Request Parameters:

Name	Type	Required	Description	Example
`contactCenter`	String	Yes	Type of contact center	Customer contact center
`country`	String	Yes	Country code	US
`terminatingCountry`	String	Conditional	Required when `country` is CA; must be omitted or blank for US/GB profiles.	US
`displayName`	String	Yes	Display name of the profile	Called display name
`entityCode`	String	No	Entity code	NUMEXXXXXXX
`infrastructure`	String	Yes	Infrastructure info	Infra@123
`intent`	String	Yes	Intent of the profile	GOVN
`numberHolder`	String	Yes	Number holder code	NUMEXXXXXXX
`procuredFrom`	String	Yes	Source of procurement	Renewal
`profileDescriptor`	String	Yes	Profile descriptor	Description of Profile
`rootEntityCode`	String	Yes	Root entity code	NUMEXXXXXXX
`shortCallDisplay`	String	No	Short call display name	Caller display
`phoneNumberList.active`	String	Yes	Whether the number is active	2079460XXX
`phoneNumberList.dno`	String	Yes	Direct number option	2079460XXX
`phoneNumberList.groupName`	String	Yes	Name of the group	2079460XXX
`phoneNumberList.phoneNumber`	String	Yes	Phone number	2079460XXX
`phoneNumberList.type`	String	Yes	Type of number (in/out)	2079460XXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	The time when the request was processed	2025-07-08T13:00:00Z
`status`	String	The overall result of the operation	SUCCESS
`message`	String	Informational message about the request	Number Profile Details are submitted for approval.
`path`	String	API endpoint path	/api/v1/number-profile
`data.numberProfileID`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	NEW
`links.self`	String	URL to view the submitted number profile	/api/v1/number-profile{numberProfileID}/view
`links.next`	String	Link to submit the number profile for approval	/api/v1/number-profile/{numberProfiileId}/submit

Input Validation

Field	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`rootEntityCode`	Yes	@NotBlank	INVALID_ROOT_ENTITY_CODE	rootEntityCode cannot be null or blank.	400	Bad Request
`entityCode`	Yes	@NotBlank	INVALID_ENTITY_CODE_	entityCode cannot be null or blank.	400	Bad Request
`profileDescriptor`	Yes	@NotBlank	INVALID_PROFILE_DESCRIPTOR	profileDescriptor cannot be null or blank.	400	Bad Request
`profileDescriptor`	Yes	@Size	INVALID_PROFILE_DESCRIPTOR_LENGTH	profileDescriptor maximum length is 100 characters.	400	Bad Request
`procuredFrom`	Yes	@NotBlank	INVALID_PROCURED_FROM	procuredFrom cannot be null or blank.	400	Bad Request
`country`	Yes	@NotBlank	INVALID_COUNTRY	country cannot be null or blank.	400	Bad Request
`country`	Yes	@SupportedCountry	UNSUPPORTED_COUNTRY_CODE	Country Code not supported. Refer /v1/country-codes	400	Bad Request
`terminatingCountry`	Conditional (CA)	@Size	INVALID_TERMINATING_COUNTRY_LENGTH	terminatingCountry maximum length is 50 characters.	400
`displayName`	Yes	@NotBlank	INVALID_DISPLAY_NAME	displayName cannot be null or blank.	400	Bad Request
`displayName`	Yes	@Size	INVALID_DISPLAY_NAME_LENGTH	displayName minimum length is 3 characters and maximum length is 32 characters.	400	Bad Request
`shortCallDisplay`	Yes	@NotBlank	INVALID_SHORT_CALL_DISPLAY	shortCallDisplay cannot be null or blank.	400	Bad Request
`shortCallDisplay`	Yes	@Size	INVALID_SHORT_CALL_DISPLAY_LENGTH	shortCallDisplay min 3 chars, max 15 chars.	400	Bad Request
`intent`	Yes	@NotBlank	INVALID_INTENT	intent cannot be null or blank.	400	Bad Request
`numberHolder`	Yes	@NotBlank	INVALID_NUMBER_HOLDER	numberHolder cannot be null or blank.	400	Bad Request
`contactCenter`	Yes	@NotBlank	INVALID_CONTACT_CENTER	contactCenter cannot be null or blank.	400	Bad Request
`contactCenter`	Yes	@Size	INVALID_CONTACT_CENTER_LENGHT	contactCenter min 3 chars, max 100 chars.	400	Bad Request
`infrastructure`	Yes	@NotBlank	INVALID_INFRASTRUCTURE	infrastructure cannot be null or blank.	400	Bad Request
`infrastructure`	Yes	@Size	INVALID_INFRASTRUCTURE_LENGTH	infrastructure min 3 chars, max 100 chars.	400	Bad Request
`phoneNumberList`	Yes	@NotNull, @NotEmpty	INVALID_PHONE_NUMBER_LIST	phoneNumberList cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`phoneNumber`	Yes	@NotBlank	INVALID_PHONE_NUMBER	phoneNumber cannot be null or blank.	400	Bad Request
`phoneNumber`	Yes	E.164	INVALID_PHONE_NUMBER_E164	Phone number must be valid for profile country (E.164).	422	Unprocessable Entity
`phoneNumber`	Yes	Area code	INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for number in profile country.	422	Unprocessable Entity
`active`	Yes	@NotBlank	INVALID_ACTIVE	active cannot be null or blank.	400	Bad Request
`active`	Yes	@Pattern	INVALID_ACTIVE_PATTERN	active value must be 'Y' – Active, or 'N' – at Rest.	400	Bad Request
`type`	Yes	@NotBlank	INVALID_TYPE	type cannot be null or blank.	400	Bad Request
`type`	Yes	@Pattern	INVALID_TYPE_PATTERN	Type must hold 'in', 'out', or 'both' (monolithic). Split APIs use 'Inbound', 'Outbound', or 'both'.	400	Bad Request
`dno`	Yes	@NotBlank	INVALID_DNO	dno cannot be null or blank. Must be 'Y' or 'N'.	400	Bad Request
`dno`	Yes	@Pattern	INVALID_DNO_PATTERN	dno must be 'Y' or 'N'.	400	Bad Request
`groupName`	No	@Size	INVALID_GROUP_LENGTH	groupName maximum length is 50 characters.	400	Bad Request

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_OF_ENTITY_TYPE	Invalid rootEntityCode.Ensure that rootEntity entityType is Root.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_VALUE	Invalid Call Intent.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PHONENUMBER_LIST	Duplicate phone number detected, Please eliminate the duplicate.	409	Conflict
MAXIMUM_SIZE_OF_PHONENUMBER	Invalid phone Number list size {0}. Ensure that phoneNumberList must have 50 Phone Numbers.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NUMBER_HOLDER_VALUE	Invalid Number Holder. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_HOLDER_BRAND_STATUS	Number Holder or Brand entity is not submitted. Please submit the entity before adding the number profile.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent, The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
VENDOR_VALIDATION	NumberProfile is enabled for BCID. Please disable it to change the BPO.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for {0} in {1}	422	Unprocessable Entity (WebDAV) (RFC 4918)
NPA_FORMATE	Invalid number format observed for NPA-NXX-XXXX, allowed first digit under NXX should be within 2 and 9.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_WITH_RELATION	{0} already assigned to another relationship, please delete and add to this relationship.	409	Conflict
BRAND_CANNOT_BE_MODIFIED	Brand cannot be modified since the profile has been enabled for Smart branding. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_REQUIRED_FOR_CA	TerminatingCountry is required for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_ONLY_FOR_CA	TerminatingCountry is only for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_TERMINATING_COUNTRY	Invalid TerminatingCountry	422	Unprocessable Entity (WebDAV) (RFC 4918)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","number-profiles","draft"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"cbc0f62b-01b7-415e-833c-a54c9794c9cb","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/draft"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number Profile Details are submitted for approval.\",\n \"path\": \"/api/v1/number-profile\",\n \"data\": {\n \"numberProfileID\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"NEW\"\n },\n \"links\": {\n \"self\": \"/api/v1/number-profile{numberProfileID}/view\",\n \"next\": \"/api/v1/number-profile/{numberProfiileId}/submit\"\n }\n}"},{"id":"942717ef-b0c7-49ac-beac-078ad15abfee","name":"400-BadRequest","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profile/draft"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/draft\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_ROOT_ENTITY_CODE\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_ENTITY_CODE_\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PROFILE_DESCRIPTOR\"\n }\n ]\n}"},{"id":"c209c0a3-fbce-407f-8ac0-e96e142775f3","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profile/draft"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/draft\",\n \"details\": [\n {\n \"issue\": \"Invalid Entity Code {0}.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"issue\": \"Invalid rootEntityCode.Ensure that rootEntity entityType is Root.\",\n \"customCode\": \"INVALID_OF_ENTITY_TYPE\"\n },\n {\n \"issue\": \"Invalid Call Intent.\",\n \"customCode\": \"INVALID_CALL_INTENT_VALUE\"\n }\n ]\n}"}],"_postman_id":"385bb3ec-38b9-418f-84a7-d5ee21666eb0"},{"name":"Update Profile Save","id":"45366bb8-993d-469a-a858-ab80ee51e7be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactCenter\": \"Customer contact center\",\r\n \"country\": \"US\",\r\n \"displayName\": \"Caller display name\",\r\n \"entityCode\": \"NUMEXXXXXXXXXX\",\r\n \"infrastructure\": \"Customer infrastructure\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"phoneNumberList\": [\r\n {\r\n \"active\": \"Y\",\r\n \"dno\": \"Y\",\r\n \"groupName\": \"Rest API\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"in\"\r\n }\r\n ],\r\n \"procuredFrom\": \"Renewal\",\r\n \"profileDescriptor\": \"Description of Profile\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"shortCallDisplay\": \"Caller display\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/{numberProfileId}","description":"

Description

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

Name	Type	Required	Description	Example
`contactCenter`	String	Yes	Name of the customer contact center	Customer contact center
`country`	String	Yes	Country code	US
`displayName`	String	Yes	Caller display name	Caller display name
`entityCode`	String	Yes	Code of the entity	NUMEXXXXXXXXXX
`infrastructure`	String	Yes	Name of the customer infrastructure entity	Customer infrastructure
`intent`	String	Yes	Business intent code	GOVN
`numberHolder`	String	Yes	Code of the number holder	NUMEXXXXXXXXXX
`phoneNumberList`	Array of Object	Yes	List of phone number objects	2079460XXX
`procuredFrom`	String	Yes	Source of phone number procurement	Renewal
`profileDescriptor`	String	Yes	Description of the number profile	Description of Profile
`rootEntityCode`	String	Yes	Code of the root entity	NUMEXXXXXXXXXX
`shortCallDisplay`	String	No	Caller display name for short calls	Caller display
`phoneNumberList.action`	String	Yes	Action on the phone Number	2079460XXX
`phoneNumberList.active`	String	Yes	Whether the number is active (Y/N)	2079460XXX
`phoneNumberList.dno`	String	No	DNO flag (Y/N)	2079460XXX
`phoneNumberList.groupName`	String	No	Group name under which the number is added	2079460XXX
`phoneNumberList.phoneNumber`	String	Yes	Phone number to be added	2079460XXX
`phoneNumberList.type`	String	Yes	Type of number (e.g., \"in\" for inbound)	2079460XXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time when the response was generated	2025-07-08T13:00:00Z
`status`	String	Overall status of the request	SUCCESS
`message`	String	Informational message about the operation	Number Profile Details are submitted for approval.
`path`	String	Endpoint path that was called	/api/v1/number-profile
`data.numberProfileID`	String	Unique ID of the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	SUBMITTED
`links.self`	String	Link to view the submitted number profile	/api/v1/number-profile/{numberProfiileId}/view
`links.next`	String	Link to submit the number profile for approval	/api/v1/number-profile/{numberProfiileId}/submit

Input Validation

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`rootEntityCode`	Yes	rootEntityCode cannot be null or blank.	INVALID_ROOT_ENTITY_CODE	400	Bad Request
`entityCode`	Yes	entityCode cannot be null or blank.	INVALID_ENTITY_CODE	400	Bad Request
`profileDescriptor`	Yes	profileDescriptor maximum length is 100 characters.	INVALID_PROFILE_DESCRIPTOR_LENGTH	400	Bad Request
`procuredFrom`	Yes	procuredFrom cannot be blank.	INVALID_PROCURED_FROM_BLANK	400	Bad Request
`country`	Yes	country cannot be null or blank.	INVALID_COUNTRY	400	Bad Request
`country`	Yes	Country Code not supported. Refer /v1/country-codes	UNSUPPORTED_COUNTRY_CODE	400	Bad Request
`displayName`	Yes	displayName minimum length is 3 characters and maximum length is 32 characters.	INVALID_DISPLAY_NAME_LENGTH	400	Bad Request
`shortCallDisplay`	Yes	shortCallDisplay minimum length is 3 characters and maximum length is 15 characters.	INVALID_SHORT_CALL_DISPLAY_LENGTH	400	Bad Request
`intent`	Yes	intent cannot be blank.	INVALID_INTENT_BLANK	400	Bad Request
`numberHolder`	Yes	numberHolder cannot be blank.	INVALID_NUMBER_HOLDER_BLANK	400	Bad Request
`contactCenter`	Yes	contactCenter minimum length is 3 Characters and maximum length is 100 characters.	INVALID_CONTACT_CENTER_LENGHT	400	Bad Request
`numberProfileId`	Yes	numberProfileId cannot be null or blank.	INVALID_NUMBER_PROFILE_ID	400	Bad Request
`infrastructure`	Yes	infrastructure minimum length is 3 Characters and maximum length is 100 characters.	INVALID_INFRASTRUCTURE_LENGTH	400	Bad Request
`phoneNumberList`	Yes	phoneNumberList cannot be null or empty. Ensure that a single number is added.	INVALID_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumber`	Yes	phoneNumber cannot be null or blank.	INVALID_PHONE_NUMBER	400	Bad Request
`phoneNumber`	Yes	phoneNumber length is 10 digit.	INVALID_PHONE_NUMBER_LENGTH	400	Bad Request
`phoneNumber`	Yes	phoneNumber must contain digits only.	INVALID_PHONE_NUMBER_PATTERN	400	Bad Request
`active`	Yes	active cannot be null or blank.	INVALID_ACTIVE	400	Bad Request
`active`	Yes	active value must hold 'Y' – Active, or 'N'- at Rest.	INVALID_ACTIVE_PATTERN	400	Bad Request
`type`	Yes	type cannot be null or blank.	INVALID_TYPE	400	Bad Request
`type`	Yes	Type must hold 'in','out',or 'both'.	INVALID_TYPE_PATTERN	400	Bad Request
`dno`	Yes	dno cannot be null blank. dno must be 'Y' or 'N'.	INVALID_DNO	400	Bad Request
`dno`	Yes	dno must be 'Y' or 'N'.	INVALID_DNO_PATTERN	400	Bad Request
`groupName`	No	groupName maximum length is 50 characters.	INVALID_GROUP_LENGTH	400	Bad Request
`action`	Yes	action cannot be null or blank.	INVALID_ACTION	400	Bad Request
`action`	Yes	action must be 'ADD', 'EDIT', or 'DELETE'.	INVALID_ACTION_PATTERN	400	Bad Request

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_OF_ENTITY_TYPE	Invalid rootEntityCode.Ensure that rootEntity entityType is Root.	422	Unprocessable Entity (WebDAV) (RFC 4918)
CHECK_FOR_NUMBER_PROFILE	Invalid numberProfileId {0}, please provide a valid numberProfileId.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_VALUE	Invalid Call Intent.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PHONENUMBER_LIST	Duplicate phone number detected, Please eliminate the duplicate.	409	Conflict
MAXIMUM_SIZE_OF_PHONENUMBER	Invalid phone Number list size {0}. Ensure that phoneNumberList must have 50 Phone Numbers.	422	Unprocessable Entity (WebDAV) (RFC 4918)
UNIQUEPHONENUMBERCHECK	\"Phone Number\" already exists	409	Conflict
INVALID_NUMBER_HOLDER	Invalid Number Holder {0}. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_STATUS	Invalid \"Status\"	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_HOLDER_BRAND_STATUS	Number Holder or Brand entity is not submitted. Please submit the entity before adding the number profile.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent. The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
VENDOR_VALIDATION	NumberProfile is enabled for BCID. Please disable it to change the BPO.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for {0} in {1}	422	Unprocessable Entity (WebDAV) (RFC 4918)
NPA_FORMATE	Invalid number format observed for NPA-NXX-XXXX, allowed first digit under NXX should be within 2 and 9.	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_NOT_WITH_RELATION	Number {0} you are trying to delete does not exist in this \"Number Profile\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
NUMBER_WITH_RELATION	{0} already assigned to another relationship, please delete and add to this relationship.	409	Conflict
INVALID_RELATIONSHIP	Invalid \"Relationship\"	422	Unprocessable Entity (WebDAV) (RFC 4918)
BRAND_CANNOT_BE_MODIFIED	Brand cannot be modified since the profile has been enabled for Smart branding. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)

Description

This API endpoint enables you to submit or commit changes made through the Create Number Profile - Save and Update Number Profile - Save actions described in previous sections. Operations such as creating a number profile and adding, editing, or deleting phone numbers will be submitted in bulk when this API is called, initiating the approval and registration process on our end.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time when the response was generated	2025-07-08T13:00:00Z
`status`	String	Overall status of the request	SUCCESS
`message`	String	Informational message about the operation	Number profile Details submitted successfully for approval process.
`path`	String	Endpoint path that was called	/api/v1/number-profile/CARE44aad8fNUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX171d34da0a7dd306d139d7035/submit
`data.numberProfileID`	String	Unique ID of the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	SUBMITTED
`links.self`	String	Link to view the submitted number profile	/api/v1/number-profile/{numberProfiileId}/view

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Constraint	Custom Error Code	Validation Message	HTTP Status Code	HTTP Error Message
`numberProfileId`	Yes	@NotBlank	INVALID_NUMBER_PROFILE_ID	numberProfileId cannot be null or blank.	400	Bad Request
`type`	Yes	@Pattern(submit)	INVALID_PROFILE_ACTION_TYPE	type must be 'submit'.	400	Bad Request

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_NUMBER_PROFILE_VLAUE	Invalid numberProfileId.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NUMBER_PROFILE_VLAUE	Invalid numberProfileId.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_NUMBER_PROFILE_VLAUE	Invalid numberProfileId.	422	Unprocessable Entity (WebDAV) (RFC 4918)
SUBMIT_PROFILE_FOR_SUBMIT_AND_APPROVE_VALUE	numberProfileId already in submitted or Approved status, please provide valid numberProfileId to initiate approval process	422	Unprocessable Entity (WebDAV) (RFC 4918)
SUBMIT_PROFILE_FOR_NEW_AND_EDIT_VALUE	numberProfileId is not in New or Edit status, so cannot initiate approval process	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_RELATIONSHIP	Invalid \"Relationship\"	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent, The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity (WebDAV) (RFC 4918)
BRAND_CANNOT_BE_MODIFIED	Brand cannot be modified since the profile has been enabled for Smart branding. Please reach out to your customer success team for further assistance.	422	Unprocessable Entity (WebDAV) (RFC 4918)
ENTITY_NOT_APPROVED	Root or Assigned entity is not approved. Please approve the entity before approving the number profile.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
VENDOR_VALIDATION	NumberProfile is enabled for BCID. Please disable it to change the BPO.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DISPLAY_NAME_LIMIT	Display Name needs to be 32 characters or less for a number profile enabled for Smart branding	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_REQUIRED_FOR_CA	TerminatingCountry is required for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
TERMINATING_COUNTRY_ONLY_FOR_CA	TerminatingCountry is only for country CA	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_TERMINATING_COUNTRY	Invalid TerminatingCountry	422	Unprocessable Entity (WebDAV) (RFC 4918)

Description

This API endpoint allows us to add RCD logo and call reason for a profile.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`logo`	MultipartFile	No	logo	Upload .png, .jpg and .bmp file
`entityCode`	String	No	Unique identifier for the entity	NUMEXXXXXXXX
`callReasons`	Array of String	No	Unique call reasons. Upto 10 call reasons can be added	Call Reasons
`defaultCallReason`	String	No	Any one of the value from list of call reason should be set as default call reason	Call Reasons

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	RCD details added.
`path`	String	The API endpoint path that was called	/api/v1/number-profile/rcd
`data`	Object	Contains response data relevant to the request	addImageFileResponse
`data.status`	Object	Contains the status of the image upload	success

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Constraint	Custom Error Code	Validation Message	HTTP Status Code	HTTP Error Message
`numberProfileId`	Yes	@NotBlank	INVALID_NUMBER_PROFILE_ID	numberProfileId cannot be null or blank.	400	Bad Request
`logo`	No	Multipart file	RCD_FILE_FORMATS	Logo must be .png, .jpg, or .bmp.	422	Unprocessable Entity
`logo`	No	Image dimensions	RCD_LOGO_VALIDATION	Logo dimensions must be between 256x256 and 1200x1200 pixels.	422	Unprocessable Entity
`callReasons`	No	Max 10 items	MAXIMUM_CALLREASONS	Maximum 10 call reasons are allowed.	422	Unprocessable Entity
`callReasons[]`	No	Max length 64	RCD_CALL_REASON_LENGTH	RCD call reason can be up to 64 characters.	422	Unprocessable Entity
`defaultCallReason`	No	Must be in callReasons	INVALID_DEFAULT_CALLREASON	Default call reason should be any one value from list of call reason.	422	Unprocessable Entity

Business Validations

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
VALIDATE_ENTITY_CODE	Invalid entityCode {0}, please provide a valid entityCode.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_ENTITY_CODE	Invalid Entity Code {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
VALIDATE_ENTITY_CODE	Invalid entityCode {0}, please provide a valid entityCode.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_LOGO	Please upload a logo file. It cannot be empty.	422	Unprocessable Entity (WebDAV) (RFC 4918)
RCD_FILE_FORMATS	Supported formats for logos: JPG, PNG, or BMP. Please upload a file in one of these formats.	422	Unprocessable Entity (WebDAV) (RFC 4918)
RCD_LOGO_VALIDATION	Please make sure that the logo's pixel dimensions are within the range of 256x256 to 1200x1200 pixels.	422	Unprocessable Entity (WebDAV) (RFC 4918)
EMPTY_CHECK_CALL_REASON	Call Reason cannot be null or blank.	422	Unprocessable Entity (WebDAV) (RFC 4918)
EMPTY_CHECK_CALL_REASON	Call Reason cannot be null or blank.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_CALL_REASON	You have entered a duplicate call reason.	409	Conflict
MAXIMUM_CALLREASONS	Maximum 10 call reasons are allowed.	422	Unprocessable Entity (WebDAV) (RFC 4918)
RCD_CALL_REASON_LENGTH	RCD call reason can be up to 64 characters {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
CURRENT_RCD_STATUS	The current status of the RCD is {0}. You can add it once it has been approved.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DEFAULT_CALLREASON_MAX_LENGTH	Default call reason can be a max of 64 characters.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_DEFAULT_CALLREASON	Default call reason should be any one value from list of call reason.	422	Unprocessable Entity (WebDAV) (RFC 4918)
ENTER_RCD_DETAILS	At least one RCD input which is either logo or call reason is required to create RCD API. (Also returned when the request has no multipart boundary.)	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","number-profiles","{numberProfileId}","rich-call-data"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"a1f24cef-f820-4c43-a283-641e043d9c53","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"logo","type":"file","uuid":"c8d15c96-78d5-4bcd-9406-de36a7baa11b","src":["/C:/Users/JudeSanthoshKumarJos/Downloads/numeracle2.bmp"]},{"key":"entityCode","value":"NUMEXXXXXXXXXX","type":"text","uuid":"c1a39e81-e73b-443b-9783-d9cd3f6e4ed0"},{"key":"callReasons","value":"callReasons1","type":"text","uuid":"319df400-380b-481a-adfd-63fc2cffd44c"},{"key":"callReasons","value":"callReasons2","type":"text","uuid":"25d458df-22ca-4826-a779-bc00a55a7d96"},{"key":"callReasons","value":"callReasons3","type":"text","uuid":"b7972e40-c5cb-4046-8723-810efa616e24"},{"key":"defaultCallReason","value":"callReasons2","type":"text","uuid":"19a2b6f5-d409-4ccc-bb32-505a9206ac59"}],"options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/rich-call-data"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-05T14:23:17:17Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"RCD details added.\",\n \"path\": \"/api/v1/number-profile/rcd\",\n \"data\": {\n \"status\": \"success\"\n }\n}"},{"id":"051cf161-a36d-4006-941b-746187abdce2","name":"422-Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"logo","type":"file","uuid":"c8d15c96-78d5-4bcd-9406-de36a7baa11b","src":[]},{"key":"entityCode","value":"NUMEXXXXXXXXXX","type":"text","uuid":"a7f7fddf-938f-460f-bd6d-262c3b2dba5a"},{"key":"callReasons","value":"callReasons","type":"text","uuid":"5ea98d37-c011-4e94-8b94-afdc831aa0d4"}],"options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/rich-call-data"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/{numberProfileId}/rich-call-data\",\n \"details\": [\n {\n \"issue\": \"Invalid entityCode {0}, please provide a valid entityCode.\",\n \"customCode\": \"VALIDATE_ENTITY_CODE\"\n },\n {\n \"issue\": \"Invalid Entity Code {0}.\",\n \"customCode\": \"INVALID_ENTITY_CODE\"\n },\n {\n \"issue\": \"Invalid entityCode {0}, please provide a valid entityCode.\",\n \"customCode\": \"VALIDATE_ENTITY_CODE\"\n }\n ]\n}"}],"_postman_id":"4fcf08b5-6d1d-41b1-a0be-7169d6b9ffce"},{"name":"PhoneNumberDetailsByProfileId","id":"6089d08f-b426-4c06-8212-5df6502b79e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groupCount\": 500,\r\n \"groupEndIndex\": 500,\r\n \"groupStartIndex\": 0,\r\n \"lastFetchDateTime\": \"2025-08-16T01:07:07Z\",\r\n \"shortResponse\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/{numberProfileId}/phone-numbers/search","description":"

Description

This API end point is used to retrieve phone number associated to the given relationship.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`groupCount`	int	Yes	groupCount	500
`groupEndIndex`	int	Yes	groupEndIndex	500
`groupStartIndex`	int	Yes	groupStartIndex	0
`lastFetchDateTime`	String	Yes	groupStartIndex	2025-08-16T01:07:07Z
`shortResponse`	String	Yes	shortResponse	Y

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Phone number remediation status are retrieved for given list of phone numbers.
`path`	String	The API endpoint path that was called	/api/v1/phone-number/getRelationshipNumbers
`data`	Object	Contains response data relevant to the request	phone number details
`data.totalCount`	Long	Contains the total count of number associated to this relationship	3
`data.activeCount`	Long	Contains the active count of number associated to this relationship	3
`data.maxFetchedDateTime`	LocalDateTime	Contains the Entity Code	2025-09-01T06:39:53Z
`data.phoneNumberList.phoneNumber`	Long	Contains phone number	2079460XXX
`data.phoneNumberList.type`	String	Contains phone number type	2079460XXX
`data.phoneNumberList.dno`	String	Contains phone number do not originate	2079460XXX
`data.phoneNumberList.active`	String	Contains phone number active	2079460XXX
`data.phoneNumberList.groupName`	String	Contains phone number group Name	2079460XXX
`data.phoneNumberList.entityCode`	String	Contains entity code	2079460XXX
`data.phoneNumberList.brandCode`	String	Contains brand code	2079460XXX
`data.phoneNumberList.createdDt`	LocalDateTime	Contains phone number created date	2079460XXX
`data.phoneNumberList.updatedDate`	LocalDateTime	Contains phone number updated date	2079460XXX

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`groupCount`	Yes	Group count must be greater than 0.	INVALID_GROUP_COUNT_MIN	400	Bad Request
`groupStartIndex`	Yes	Group start index must be greater than or equal to 0.	INVALID_GROUP_START_INDEX_MIN	400	Bad Request
`groupEndIndex`	Yes	Group end index must be greater than or equal to 0.	INVALID_GROUP_END_INDEX_MIN	400	Bad Request
`relationshipCode`	Yes	Relationship code cannot be null or empty.	INVALID_ENTITY_CODE	400	Bad Request
`shortResponse`	Yes	shortResponse must be either 'Y' or 'N' if provided.	INVALID_SHORT_RESPONSE	400	Bad Request
`lastFetchDateTime`	Yes	lastFetchDateTime must follow ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).	INVALID_LAST_FETCH_DATE_TIME_RESPONSE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
GROUP_START_POSITIVE	Group start index must be greater than or equal to 0.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_END_POSITIVE	Group end index must be greater than or equal to 0.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_END_INDEX	Group end index must be greater than or equal to group start index.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_INDEX_DIFFERENCE	The difference between group end index and group start index must be exactly {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
GROUP_COUNT	Group count must always be {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_RELATIONSHIP_CODE	Invalid \"Relationship Code\" {0}	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","number-profiles","{numberProfileId}","phone-numbers","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"691d2f10-9461-4839-b1a0-4eb45b2cc638","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groupCount\": 500,\r\n \"groupEndIndex\": 500,\r\n \"groupStartIndex\": 0,\r\n \"lastFetchDateTime\": \"2025-08-16T01:07:07Z\",\r\n \"shortResponse\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/phone-numbers/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-05T14:23:17:17Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone number remediation status are retrieved for given list of phone numbers.\",\n \"path\": \"/api/v1/phone-number/getRelationshipNumbers\",\n \"data\": {\n \"totalCount\": \"3\",\n \"activeCount\": \"3\",\n \"maxFetchedDateTime\": \"2025-09-01T06:39:53Z\",\n \"phoneNumberList\": {\n \"phoneNumber\": 2012140511,\n \"type\": \"out\",\n \"dno\": \"Y\",\n \"active\": \"Y\",\n \"groupName\": null,\n \"entityCode\": \"NUMEXXXXXXXXX\",\n \"brandCode\": \"NUMEXXXXXXXXX\",\n \"createdDate\": \"2025-08-31 13:35:53\",\n \"updatedDate\": \"2025-08-31 13:36:38\"\n }\n }\n}"},{"id":"533108f0-118f-4c8a-a7d2-f3a054801ba1","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"groupCount\": -1,\r\n \"groupEndIndex\": 500,\r\n \"groupStartIndex\": 0,\r\n \"lastFetchDateTime\": \"2025-08-16T01:07:07Z\",\r\n \"shortResponse\": \"Y\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/phone-numbers/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/number-profiles/{numberProfileId}/phone-numbers/search\",\n \"details\": [\n {\n \"field\": \"groupCount\",\n \"issue\": \"Group count must be greater than 0.\",\n \"customCode\": \"INVALID_GROUP_COUNT_MIN\"\n },\n {\n \"field\": \"groupStartIndex\",\n \"issue\": \"Group start index must be greater than or equal to 0.\",\n \"customCode\": \"INVALID_GROUP_START_INDEX_MIN\"\n },\n {\n \"field\": \"groupEndIndex\",\n \"issue\": \"Group end index must be greater than or equal to 0.\",\n \"customCode\": \"INVALID_GROUP_END_INDEX_MIN\"\n }\n ]\n}"}],"_postman_id":"6089d08f-b426-4c06-8212-5df6502b79e2"}],"id":"84753f8b-a3e7-4676-a8af-cf3bcab46b85","_postman_id":"84753f8b-a3e7-4676-a8af-cf3bcab46b85","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Split Number Profile Api's","item":[{"name":"Add Number Profile","id":"fe2ca6dc-eb4b-4d32-89f1-20fba13886aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"profileDescriptor\": \"testing add number for Demo20\",\r\n \"channel\": \"voice\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"brandEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"country\": \"US\",\r\n \"procuredFrom\": \"Internal\",\r\n \"displayName\": \"Acme Main Support\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"bpoContactCenter\": \"Internal Call Center\",\r\n \"infrastructureCpaas\": \"hariram new\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info","description":"

Description

The API is used to create number pofile. Profile can be created with the below values:

profileDescriptor, channel, rootEntityCode, brandEntityCode, country, procuredFrom, displayName, shortCallDisplay (optional), intent, numberHolder, bpoContactCenter, infrastructureCpaas.

Request Parameters:

Name	Type	Required	Description	Example
`profileDescriptor`	String	Yes	Human-readable name for the profile or campaign	Q3 Marketing Campaign 2025
`channel`	String	Yes	Communication channel used for the profile	voice
`rootEntityCode`	String	Yes	Unique identifier for the root business entity	NUMEXXXXXXXXXX
`brandEntityCode`	String	Yes	Unique identifier for the brand entity	NUMEXXXXXXXXXX
`country`	String	Yes	Country where the number or service is registered (ISO-2)	US
`terminatingCountry`	String	Conditional	Required when `country` is CA; must be omitted or blank for US/GB profiles.	US
`procuredFrom`	String	Yes	Source from which the number or service was procured	Internal
`displayName`	String	Yes	Display name shown to end users or carriers	Acme Main Support Line
`shortCallDisplay`	String	No	Short call display name (3–15 chars)	Acme Support
`intent`	String	Yes	Intended usage classification of the number	GOVN
`numberHolder`	String	Yes	Entity that legally holds or owns the number	NUMEXXXXXXXXXX
`bpoContactCenter`	String	Yes	Name of the BPO or contact center handling calls	Internal Call Center
`infrastructureCpaas`	String	Yes	CPaaS provider used for call infrastructure	Twilio

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the request was processed (ISO 8601)	2025-07-08T13:00:00Z
`status`	String	Overall API response status	SUCCESS
`message`	String	Human-readable response message	Number Profile Details are created.
`path`	String	API endpoint that processed the request	/api/v1/profiles/profile-info
`data`	Object	Container holding number profile details	—
`data.numberProfileId`	String	Unique identifier for the created number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`data.status`	String	Current lifecycle status of the number profile	NEW
`data.profileDescriptor`	String	Human-readable name for the profile or campaign	Q3 Marketing Campaign 2025
`data.createdDate`	String	Timestamp when the profile was created	2025-07-17T18:30:00Z
`data.updatedDate`	String	Timestamp when the profile was last updated	2025-07-17T18:30:00Z
`links`	Object	HATEOAS links related to the resource	—
`links.self`	String	URL to retrieve the current profile	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`links.nextAction`	String	URL for the next actionable step (number assignment)	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers

Input Validation

Name	Field	Type	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`rootEntityCode`	`rootEntityCode`	String	Yes	@NotNull`, `@Size	INVALID_ROOT_ENTITY_CODE	rootEntityCode cannot be null or blank.	400	Bad Request
`brandEntityCode`	`brandEntityCode`	String	Yes	@NotBlank`, `@Size	INVALID_BRAND_ENTITY_CODE	brandEntityCode cannot be null or blank.	400	Bad Request
`profileDescriptor`	`profileDescriptor`	String	Yes	@NotBlank	INVALID_PROFILE_DESCRIPTOR	profileDescriptor cannot be null or blank.	400	Bad Request
`profileDescriptor`	`profileDescriptor`	String	Yes	@Size	INVALID_PROFILE_DESCRIPTOR_LENGTH	profileDescriptor maximum length is 100 characters.	400	Bad Request
`procuredFrom`	`procuredFrom`	String	Yes	@Size	INVALID_PROCURED_FROM_BLANK	procuredFrom cannot be blank.	400	Bad Request
`displayName`	`displayName`	String	Yes	@Size	INVALID_DISPLAY_NAME_LENGTH	displayName minimum length is 3 characters and maximum length is 32 characters.	400	Bad Request
`intent`	`intent`	String	Yes	@Size	INVALID_INTENT_BLANK	intent cannot be blank.	400	Bad Request
`numberHolder`	`numberHolder`	String	Yes	@Size	INVALID_NUMBER_HOLDER_BLANK	numberHolder cannot be blank.	400	Bad Request
`bpoContactCenter`	`bpoContactCenter`	String	Yes	@NotBlank`, `@Size	INVALID_BPO_CONTACT_CENTER	bpoContactCenter minimum length is 3 Characters and maximum length is 100 characters.	400	Bad Request
`infrastructureCpaas`	`infrastructureCpaas`	String	Yes	@Size	INVALID_INFRASTRUCTURE_CPAAS_LENGTH	infrastructureCpaas minimum length is 3 Characters and maximum length is 100 characters.	400	Bad Request
`channel`	`channel`	String	Yes	@Pattern	INVALID_CHANNEL_PATTERN	channel must be voice.	400	Bad Request
`channel`	`channel`	String	Yes	@NotNull	INVALID_CHANNEL	channel cannot be null or blank.	400	Bad Request
`terminatingCountry`	`terminatingCountry`	String	Conditional (CA)	@Size	INVALID_TERMINATING_COUNTRY_LENGTH	TerminatingCountry maximum length is 50 characters.	400	Bad Request

Business Validations

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_ENTITY_CODE	Invalid entityCode {0}.	422	Unprocessable Entity
INVALID_ROOT_ENTITY_TYPE	Invalid rootEntityCode {0}.Ensure that rootEntity entityType is Root	422	Unprocessable Entity
INVALID_CALL_INTENT	Invalid \"Call Intent\"{0}	422	Unprocessable Entity
INVALID_NUMBER_HOLDER	Invalid Number Holder {0}. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity
PLEASE_ENTER_RELATIONSHIP_OWNER	Invalid \"Relationship Owner\"	422	Unprocessable Entity
BPO_CC_VENDOR_ENTITY_LENGTH	\"BPO or CC Vendor Entity\" must have minimum 3 characters	422	Unprocessable Entity
INFRA_CPAAS_ENTITY_LENGTH	\"Infra or CPaaS Entity\" must have minimum 3 characters	422	Unprocessable Entity
NUMBER_HOLDER_BRAND_STATUS	Number Holder or Brand entity is not submitted. Please submit the entity before adding the number profile.	422	Unprocessable Entity
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent, The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity
CROSS_COUNTRY_PROFILE_NOT_ALLOWED	Cross-country number profile is not allowed for entity {0}. The entity must have an additional address in {1}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
TERMINATING_COUNTRY_REQUIRED_FOR_CA	TerminatingCountry is required for country CA	422	Unprocessable Entity
TERMINATING_COUNTRY_ONLY_FOR_CA	TerminatingCountry is only for country CA	422	Unprocessable Entity
INVALID_TERMINATING_COUNTRY	Invalid TerminatingCountry	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","profile-info"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"87530058-f3f4-4c9a-93bd-786cefef0524","name":"201 - Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Accept","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"profileDescriptor\": \"testing add number for Demo15\",\r\n \"channel\": \"voice\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"brandEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"country\": \"US\",\r\n \"procuredFrom\": \"Internal\",\r\n \"displayName\": \"Acme Main Support\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"bpoContactCenter\": \"Internal Call Center\",\r\n \"infrastructureCpaas\": \"hariram new\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number Profile Details are created.\",\n \"path\": \"/api/v1/profiles/profile-info\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"status\": \"NEW\",\n \"profileDescriptor\": \"Q3 Marketing Campaign 2025\",\n \"createdDate\": \"2025-07-17T18:30:00Z\",\n \"updatedDate\": \"2025-07-17T18:30:00Z\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"nextAction\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\"\n }\n}"},{"id":"c228f59e-0771-47c8-86b8-7d00f12cd483","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Accept","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"profileDescriptor\": \"testing add number for Demo14\",\r\n \"channel\": \"voice\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"brandEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"country\": \"US\",\r\n \"procuredFrom\": \"Internal\",\r\n \"displayName\": \"Acme Main Support\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"bpoContactCenter\": \"Internal Call Center\",\r\n \"infrastructureCpaas\": \"hariram new\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/profiles/profile-info\",\r\n \"details\": [\r\n {\r\n \"field\": \"rootEntityCode\",\r\n \"issue\": \"Bad Request\",\r\n \"customCode\": \"INVALID_ROOT_ENTITY_CODE\"\r\n },\r\n {\r\n \"field\": \"brandEntityCode\",\r\n \"issue\": \"Bad Request\",\r\n \"customCode\": \"INVALID_BRAND_ENTITY_CODE\"\r\n },\r\n {\r\n \"field\": \"profileDescriptor\",\r\n \"issue\": \"Bad Request\",\r\n \"customCode\": \"INVALID_PROFILE_DESCRIPTOR\"\r\n }\r\n ]\r\n}"},{"id":"26166122-801d-4a5d-a674-7e2485492bd2","name":"422 - Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Accept","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"profileDescriptor\": \"testing add number for Demo14\",\r\n \"channel\": \"voice\",\r\n \"rootEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"brandEntityCode\": \"NUMEXXXXXXXXXX\",\r\n \"country\": \"US\",\r\n \"procuredFrom\": \"Internal\",\r\n \"displayName\": \"Acme Main Support\",\r\n \"intent\": \"GOVN\",\r\n \"numberHolder\": \"NUMEXXXXXXXXXX\",\r\n \"bpoContactCenter\": \"Internal Call Center\",\r\n \"infrastructureCpaas\": \"hariram new\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/profile-info\",\n \"details\": [\n {\n \"issue\": \"Business validation failed.\",\n \"customCode\": \"BUSINESS_ERROR\"\n }\n ]\n}"}],"_postman_id":"fe2ca6dc-eb4b-4d32-89f1-20fba13886aa"},{"name":"Get Number Profile","id":"ea271f81-01fd-48b3-badc-9a536374508c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info/{numberProfileId}","description":"

Description

This Api is used to fetch the number profile details using the number profile id.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Parameters:

Name	Type	Description	Example
`Name`	Type	Description	Example
`timestamp`	String	Time when the request was processed (ISO 8601)	2025-07-08T13:00:00Z
`status`	String	Overall API response status	SUCCESS
`message`	String	Human-readable response message	Number Profile Details are retrieved.
`path`	String	API endpoint that processed the request	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`data`	Object	Container holding number profile details	—
`data.numberProfileId`	String	Unique identifier for the created number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`data.status`	String	Current lifecycle status of the number profile	APPROVED
`data.profileDescriptor`	String	Human-readable name for the profile or campaign	Q3 Marketing Campaign 2025
`data.channel`	String	Communication channel associated with the profile	voice
`data.rootEntityCode`	String	Unique identifier of the root business entity	NUMEXXXXXXXXXX
`data.brandEntityCode`	String	Unique identifier of the brand entity	NUMEXXXXXXXXXX
`data.country`	String	Country where the number is registered (ISO-2)	US
`data.terminatingCountry`	String	TerminatingCountry (present for CA profiles)	US
`data.procuredFrom`	String	Source from which the number was procured	Internal
`data.displayName`	String	Display name presented to end users or carriers	Acme Main Support Line
`data.intent`	String	Intended regulatory or usage classification	GOVN
`data.numberHolder`	String	Entity that legally owns or holds the number	NUMEXXXXXXXXXX
`data.bpoContactCenter`	String	Contact center or BPO handling the calls	Internal Call Center
`data.infrastructureCpaas`	String	CPaaS provider used for call infrastructure	Twilio
`data.numberCount`	Integer	Number of phone number mapped under this profile	12
`data.created`	String	Timestamp when the profile was created	2025-07-17T18:30:00Z
`data.updated`	String	Timestamp when the profile was last updated	2025-07-17T18:30:00Z
`links`	Object	HATEOAS links related to the resource	—
`links.self`	String	URL to retrieve the current profile	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`links.numbers`	String	URL for the next actionable step (number assignment)	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers

Description

This API is used to delete the number profile.

HTTP Method : DELETE

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity

Description

This API is used to update the number profile details.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`profileDescriptor`	String	No	Human-readable name for the profile or campaign	Q3 Marketing Campaign 2025
`brandEntityCode`	String	No	Unique identifier for the brand entity	NUMEXXXXXXXXXX
`procuredFrom`	String	No	Source from which the number or service was procured	Internal
`displayName`	String	No	Display name shown to end users or carriers	Acme Main Support Line
`intent`	String	No	Intended usage classification of the number	GOVN
`numberHolder`	String	No	Entity that legally holds or owns the number	NUMEXXXXXXXXXX
`bpoContactCenter`	String	Yes	Name of the BPO or contact center handling calls	Internal Call Center
`infrastructureCpaas`	String	No	CPaaS provider used for call infrastructure	Twilio

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Time when the request was processed (ISO 8601)	2025-07-08T13:00:00Z
`status`	String	Overall API response status	SUCCESS
`message`	String	Human-readable response message	Number Profile Details are updated.
`path`	String	API endpoint that processed the request	/api/v1/profiles/profile-info
`data`	Object	Container holding number profile details	—
`data.numberProfileId`	String	Unique identifier for the created number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`data.status`	String	Current lifecycle status of the number profile	EDIT
`data.profileDescriptor`	String	Human-readable name for the profile or campaign	Q3 Marketing Campaign 2025
`data.createdDate`	String	Timestamp when the profile was created	2025-07-17T18:30:00Z
`data.updatedDate`	String	Timestamp when the profile was last updated	2025-07-17T18:30:00Z
`links`	Object	HATEOAS links related to the resource	—
`links.self`	String	URL to retrieve the current profile	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX
`links.numbers`	String	URL for the next actionable step (number assignment)	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`links.submit`	String	URL for the next actionable step (number assignment)	/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`profileDescriptor`	String	No	@Size	INVALID_PROFILE_DESCRIPTOR_LENGTH	profileDescriptor maximum length is 100 characters.	400	Bad Request
`procuredFrom`	String	No	@Size	INVALID_PROCURED_FROM_BLANK	procuredFrom cannot be blank.	400	Bad Request
`displayName`	String	No	@Size	INVALID_DISPLAY_NAME_LENGTH	displayName minimum length is 3 characters and maximum length is 32 characters.	400	Bad Request
`bpoContactCenter`	String	No	@Size	INVALID_BPO_CONTACT_CENTER_LENGHT	bpoContactCenter minimum length is 3 Characters and maximum length is 100 characters.	400	Bad Request
`infrastructureCpaas`	String	No	@Size	INVALID_INFRASTRUCTURE_CPAAS_LENGTH	infrastructureCpaas minimum length is 3 Characters and maximum length is 100 characters.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_BRAND_ENTITY_CODE	Invalid Brand Entity Code {0}.	422	Unprocessable Entity
INVALID_CODE_FOR_ENTITY	Invalid {0}.	422	Unprocessable Entity
INVALID_CALL_INTENT	Invalid \"Call Intent\" {0}	422	Unprocessable Entity
INVALID_NUMBER_HOLDER	Invalid Number Holder {0}. Make sure it is either a Root Entity Code or an Entity Code.	422	Unprocessable Entity
PLEASE_ENTER_RELATIONSHIP_OWNER	Invalid \"Relationship Owner\"	422	Unprocessable Entity
INVALID_HOLDER_BRAND_COMBINATION	Number Holder and Brand combination is not valid	422	Unprocessable Entity
INVALID_CALL_INTENT_COMBINATION	Invalid Call Intent. The selected entity does not have \"Non-Profit\" as its type of business. Please update the entity's business type to \"Non-Profit\".	422	Unprocessable Entity
DUPLICATE_PROFILE_DESCRIPTOR	Duplicate \"Profile Descriptor\"	409	Conflict
INVALID_RELATIONSHIP	Invalid \"Relationship\"	422	Unprocessable Entity
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","profile-info","{numberProfileId}"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"d40606af-cfcd-46d8-bade-9a196f303387","name":"200 - OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"profileDescriptor\": \"Description of Hari check2\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info/NUMEXXXXXXXXXX"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 29 Apr 2026 08:03:38 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Number Profile Details are updated.\",\n \"path\": \"/api/v1/profiles/profile-info\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"status\": \"EDIT\",\n \"profileDescriptor\": \"Q3 Marketing Campaign 2025\",\n \"createdDate\": \"2025-07-17T18:30:00Z\",\n \"updatedDate\": \"2025-07-17T18:30:00Z\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"numbers\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"submit\": \"/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions\"\n }\n}"},{"id":"a2aa7129-118c-4562-8cc6-0d218e444c0b","name":"400 - Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Ae\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info/NUMEXXXXXXXXXX"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 29 Apr 2026 10:10:49 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/profile-info/{numberProfileId}\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PROFILE_DESCRIPTOR_LENGTH\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PROCURED_FROM_BLANK\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_DISPLAY_NAME_LENGTH\"\n }\n ]\n}"},{"id":"2cf07982-a7c3-4914-9c03-ea3c6ed095c7","name":"422 - Unprocessable Entity","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Aecheck for testing\",\r\n \"brandEntityCode\": \"INTE2026HAR2322\",\r\n \"numberHolder\": \"INTE4930HAR2353\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/profile-info/NUMEXXXXXXXXXX"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 29 Apr 2026 10:15:16 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/profile-info/{numberProfileId}\",\n \"details\": [\n {\n \"issue\": \"Business validation failed.\",\n \"customCode\": \"BUSINESS_ERROR\"\n }\n ]\n}"}],"_postman_id":"470cd00b-7c44-481c-b778-babed2f9c26f"},{"name":"Add Phone Numbers","id":"d2ab8187-b7e1-470b-bd9f-2a59c7b4bf35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToAdd\": [\r\n {\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"Inbound\",\r\n \"active\": true,\r\n \"dno\": true,\r\n \"groupName\": \"Rest API\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers","description":"

Description

This API is to add phone numbers to the respective number profiles.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numbersToAdd.phoneNumber`	String	Yes	List the DID or Toll Free Number starting with area code, using no additional formatting such as parentheses or dashes.	2079460XXX
`numbersToAdd.type`	String	Yes	Identify the type of Communications on the Number – Inbound, Outbound, or Mixed.	Inbound
`numbersToAdd.active`	boolean	Yes	Current Number Status – Active, At Rest.	true - Active false - At Rest
`numbersToAdd.dno`	boolean	Yes	Designate the Number as Do Not Originate. Selecting \"Yes\" would allow Carriers to block any communications originating from the Number. Select \"No\" for any numbers that are Outbound or Mixed.	true - Yes true - No
`numbersToAdd.groupName`	String	No	Use this field to group a set of related Numbers for ease viewing and managing Numbers.	Rest API

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`Name`	Type	Description	Example
`timestamp`	String	The time when the request was processed	2025-07-08T13:00:00Z
`status`	String	The overall result of the operation	SUCCESS
`message`	String	Informational message about the request	Phone Numbers added to profile
`path`	String	API endpoint path	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`data.numberProfileId`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	EDIT
`data.numbersAddedCount`	Integer	Number of phone numbers add as part of this request	200
`data.numberCount`	Integer	Number of phone number mapped under this profile	250
`links.self`	String	URL to get the list of phone numbers added to this profile	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`links.profile`	String	URL to get the profile information	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
`links.submit`	String	URL to submit the profile	/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`numbersToAdd`	List	Yes	@NotNull	INVALID_NUMBERS_TO_ADD	numbersToAdd cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`numbersToAdd`	List	Yes	@NotEmpty	INVALID_NUMBERS_TO_ADD	numbersToAdd cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`phoneNumber`	String	Yes	@NotBlank	INVALID_PHONE_NUMBER	phoneNumber cannot be null or blank.	400	Bad Request
`active`	boolean	Yes	@NotNull	INVALID_ACTIVE	active cannot be null blank.active must be true or false.	400	Bad Request
`type`	String	Yes	@NotBlank	INVALID_TYPE	type cannot be null or blank.	400	Bad Request
`type`	String	Yes	@Pattern	INVALID_TYPE_PATTERN	Type must hold 'in', 'out', or 'both' (monolithic). Split APIs use 'Inbound', 'Outbound', or 'both'.	400	Bad Request
`dno`	boolean	Yes	@NotNull	INVALID_DNO	dno cannot be null blank.dno must be true or false.	400	Bad Request
`groupName`	String	No	@Size	INVALID_GROUP_LENGTH	groupName maximum length is 50 characters.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_E164	phoneNumber is invalid for country {0}. Expected valid format (e.g. {1}).	400	Bad Request
DUPLICATE_PHONE_NUMBER	Duplicate phone number detected: {0}. Please eliminate the duplicate.	409	Conflict
MAXIMUM_SIZE_OF_PHONENUMBER_SAVE_AND_SUBMIT	Invalid phone Number list size {0}.Ensure that phoneNumberList must have {1} Phone Numbers	422	Unprocessable Entity
INVALID_PHONE_NUMBER_AREA_CODE	Invalid area code for {0} in {1}	422	Unprocessable Entity
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity
UNIQUEPHONENUMBERCHECK	\"Phone Number\" already exists	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","{numberProfileId}","numbers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"c0d5eddb-d32a-4aee-9658-b5ab4fc9aa2d","name":"201 Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToAdd\": [\r\n {\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"Inbound\",\r\n \"active\": true,\r\n \"dno\": true,\r\n \"groupName\": \"Rest API\"\r\n },\r\n {\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"Inbound\",\r\n \"active\": true,\r\n \"dno\": true,\r\n \"groupName\": \"Rest API\",\r\n \"Test\":\"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=528BFC6349E85890256CA147B153AC94; Path=/; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 09:50:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone Numbers added to profile\",\n \"path\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"EDIT\",\n \"numbersAddedCount\": \"200\",\n \"numberCount\": \"250\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"profile\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"submit\": \"/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions\"\n }\n}"},{"id":"179d8f31-c856-454a-8ba1-f92386867364","name":"207 -Partial access","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToAdd\": [\r\n {\r\n \"phoneNumber\": \"1234567891\",\r\n \"type\": \"Inbound\",\r\n \"active\": true,\r\n \"dno\": true,\r\n \"groupName\": \"Rest API\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 09:55:46 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone Numbers added to profile\",\n \"path\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"EDIT\",\n \"numbersAddedCount\": \"200\",\n \"numberCount\": \"250\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"profile\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"submit\": \"/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions\"\n }\n}"},{"id":"e223ca04-fd32-4aa5-8bf9-1be8318db782","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToAdd\": [\r\n {\r\n \"phoneNumber\": \"\",\r\n \"type\": \"Inbound\",\r\n \"active\": true,\r\n \"dno\": true,\r\n \"groupName\": \"Rest API\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 09:54:40 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_NUMBERS_TO_ADD\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_NUMBERS_TO_ADD\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER\"\n }\n ]\n}"}],"_postman_id":"d2ab8187-b7e1-470b-bd9f-2a59c7b4bf35"},{"name":"Get Phone Numbers","id":"800d56bf-c1a9-4768-afa4-5a9a042561ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers","description":"

Description

This API retrieves a paginated list of phone numbers and their details for the specified number profile ID.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Parameters:

Name	Type	Description	Example
`Name`	Type	Description	Example
`timestamp`	String	The time when the request was processed	2025-07-08T13:00:00Z
`status`	String	The overall result of the operation	SUCCESS
`message`	String	Informational message about the request	Phone numbers details for a profile is retrieved successfully.
`path`	String	API endpoint path	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`data.numberProfileId`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	SUB
`data.numbers.phoneNumber`	String	List the DID or Toll Free Number starting with area code, using no additional formatting such as parentheses or dashes.	2079460XXX
`data.numbers.type`	String	Identify the type of Communications on the Number – Inbound, Outbound, or Mixed.	Inbound
`data.numbers.active`	boolean	Current Number Status – Active, At Rest.	true - Active false - At Rest
`data.numbers.dno`	boolean	Designate the Number as Do Not Originate. Selecting \"Yes\" would allow Carriers to block any communications originating from the Number. Select \"No\" for any numbers that are Outbound or Mixed.	true - Yes true - No
`data.numbers.groupName`	String	Use this field to group a set of related Numbers for ease viewing and managing Numbers.	Rest API
`data.numbers.created`	String	Timestamp when the profile was created	2025-07-17T18:30:00Z
`data.numbers.updated`	String	Timestamp when the profile was last updated	2025-07-17T18:30:00Z
`pagination.page`	Integer	Returns the current page	1
`pagination.size`	Integer	Returns the number of elements present in the current page	500(default 500)
`pagination.totalElements`	Integer	Returns the number of elements mapped to this profile	1500
`pagination.totalPages`	Integer	Returns the total number of pages.	3
`links.self`	String	URL to get the list of phone numbers added to this profile	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`links.profile`	String	URL to get the profile information	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
`links.next`	String	URL to get the next set of phone numbers	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers?page=2&size=500

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity
INVALID_PAGE	page must be greater than or equal to 1.	422	Unprocessable Entity
INVALID_SIZE	size must be between 1 and 500.	422	Unprocessable Entity
INVALID_QUERY_PARAMETER	page and size must be integers.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","{numberProfileId}","numbers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"d754c2cf-3838-495c-81df-44c2359aec96","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers","protocol":"https","host":["www","sandbox","numeracle","com"],"path":["api","v1","profiles","NUMEXXXXXXXXXX","numbers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"size","value":"500","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=F1236AF8D501946AAC1EB149FD0F2249; Path=/; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 09:58:56 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone numbers details for a profile is retrieved successfully.\",\n \"path\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"SUB\",\n \"numbers\": {\n \"phoneNumber\": \"2079460XXX\",\n \"type\": \"Inbound\",\n \"active\": \"true - Active false - At Rest\",\n \"dno\": \"true - Yes true - No\",\n \"groupName\": \"Rest API\",\n \"created\": \"2025-07-17T18:30:00Z\",\n \"updated\": \"2025-07-17T18:30:00Z\"\n }\n },\n \"pagination\": {\n \"page\": \"1\",\n \"size\": \"500(default 500)\",\n \"totalElements\": \"1500\",\n \"totalPages\": \"3\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"profile\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"next\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers?page=2&size=500\"\n }\n}"},{"id":"3642680f-2198-4887-ba34-722336e99d5f","name":"422 Unprocessable Entity","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:03:02 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Business validation failed.\",\n \"customCode\": \"BUSINESS_ERROR\"\n }\n ]\n}"}],"_postman_id":"800d56bf-c1a9-4768-afa4-5a9a042561ed"},{"name":"Update Phone Number","id":"7c38688b-16e2-4ea5-a3a5-55cb3813cf73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToEdit\": [\r\n {\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"type\": \"Inbound\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers","description":"

Description

To edit the phone numbers of respective number profile

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numbersToEdit.phoneNumber`	String	Yes	List the DID or Toll Free Number starting with area code, using no additional formatting such as parentheses or dashes.	2079460XXX
`numbersToEdit.type`	String	No	Identify the type of Communications on the Number – Inbound, Outbound, or Mixed.	Inbound
`numbersToEdit.active`	boolean	No	Current Number Status – Active, At Rest.	true - Active false - At Rest
`numbersToEdit.dno`	boolean	No	Designate the Number as Do Not Originate. Selecting \"Yes\" would allow Carriers to block any communications originating from the Number. Select \"No\" for any numbers that are Outbound or Mixed.	true - Yes true - No
`numbersToEdit.groupName`	String	No	Use this field to group a set of related Numbers for ease viewing and managing Numbers.	Rest API

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	The time when the request was processed	2025-07-08T13:00:00Z
`status`	String	The overall result of the operation	SUCCESS
`message`	String	Informational message about the request	Phone numbers updated successfully.
`path`	String	API endpoint path	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`data.numberProfileId`	String	Unique identifier for the number profile	NUMEXXXXXXXXXXX
`data.status`	String	Status of the number profile	EDIT
`data.numbersUpdatedCount`	Integer	Number of phone numbers updated as part of this request	200
`data.numberCount`	Integer	Number of phone number mapped under this profile	250
`links.self`	String	URL to get the list of phone numbers added to this profile	/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers
`links.profile`	String	URL to get the profile information	/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
`links.submit`	String	URL to submit the profile	/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`numbersToEdit`	List	Yes	@NotNull	INVALID_PHONE_NUMBER_LIST	numbersToEdit cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`numbersToEdit`	List	Yes	@NotEmpty	INVALID_PHONE_NUMBER_LIST	numbersToEdit cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`phoneNumber`	String	Yes	@NotBlank	INVALID_PHONE_NUMBER	phoneNumber cannot be null or blank.	400	Bad Request
`type`	String	No	@Pattern	INVALID_TYPE_PATTERN	Type must hold 'in', 'out', or 'both' (monolithic). Split APIs use 'Inbound', 'Outbound', or 'both'.	400	Bad Request
`groupName`	String	No	@Size	INVALID_GROUP_LENGTH	groupName maximum length is 50 characters.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_E164	phoneNumber is invalid for country {0}. Expected valid format (e.g. {1}).	400	Bad Request
DUPLICATE_PHONE_NUMBER	Duplicate phone number detected: {0}. Please eliminate the duplicate.	409	Conflict
MAXIMUM_SIZE_OF_PHONENUMBER_SAVE_AND_SUBMIT	Invalid phone Number list size {0}.Ensure that phoneNumberList must have {1} Phone Numbers	422	Unprocessable Entity
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","{numberProfileId}","numbers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"8f26dab9-8dea-4670-a338-c99abf8790f3","name":"200 OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToEdit\": [\r\n {\r\n \"phoneNumber\": \"1234567890\",\r\n \"type\":\"Inbound\",\r\n \"active\": false,\r\n \"dno\": false,\r\n \"groupName\": \"Rest API Update\"\r\n }\r\n \r\n \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Set-Cookie","value":"JSESSIONID=6661D943AA373D293DBD47BB9451E77F; Path=/; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:41:40 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone numbers updated successfully.\",\n \"path\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"data\": {\n \"numberProfileId\": \"NUMEXXXXXXXXXXX\",\n \"status\": \"EDIT\",\n \"numbersUpdatedCount\": \"200\",\n \"numberCount\": \"250\"\n },\n \"links\": {\n \"self\": \"/api/v1/profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/numbers\",\n \"profile\": \"/api/v1/profiles/profile-info/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"submit\": \"/api/v1/number-profiles/NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/actions\"\n }\n}"},{"id":"f3744aee-ac62-4e9f-b2dd-4b0c6c25863f","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToEdit\": [\r\n {\r\n \"phoneNumber\": \"2125550678\",\r\n \"type\":\"Inbound\",\r\n \"active\": false,\r\n \"dno\": false,\r\n \"groupName\": \"Rest API Update\"\r\n }\r\n \r\n \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:47:07 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LIST\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LIST\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER\"\n }\n ]\n}"},{"id":"5572ecb7-978d-4318-b73f-f47076a27c31","name":"422 Unprocessable Entity","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToEdit\": [\r\n {\r\n \"phoneNumber\": \"2125550678\",\r\n \"type\":\"Inbound\",\r\n \"active\": false,\r\n \"dno\": false,\r\n \"groupName\": \"Rest API Update\"\r\n }\r\n \r\n \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:47:07 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Business validation failed.\",\n \"customCode\": \"BUSINESS_ERROR\"\n }\n ]\n}"}],"_postman_id":"7c38688b-16e2-4ea5-a3a5-55cb3813cf73"},{"name":"Delete Phone Number","id":"3e329f5b-c19a-45d2-aeb9-5557a603f10a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToDelete\": [\r\n \"2079460XXX\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers","description":"

Description

This API is to delete the numbers of a number profile.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numberProfileId`	String	Yes	Unique identifier for the number profile	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`numbersToDelete`	Array of String	Yes	List the DID or Toll Free Number starting with area code, using no additional formatting such as parentheses or dashes.	2079460XXX

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation Annotation	Custom Error Code	Custom Error Message	HTTP Status Code	HTTP Error Message
`numbersToDelete`	List	Yes	@NotNull	INVALID_PHONE_NUMBER_LIST	numbersToDelete cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`numbersToDelete`	List	Yes	@NotEmpty	INVALID_PHONE_NUMBER_LIST	numbersToDelete cannot be null or empty. Ensure that a single number is added.	400	Bad Request
`phoneNumber`	String	Yes	@NotBlank	INVALID_PHONE_NUMBER	phoneNumber cannot be null or blank.	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code (Custom)	Error Message (Custom)	HTTP Status Code	HTTP Error Message
MAXIMUM_SIZE_OF_PHONENUMBER	Invalid phone Number list size {0}. Ensure that numbersToDelete must have 200 Phone Numbers.	422	Unprocessable Entity
INVALID_NUMBER_PROFILE_ID	Invalid Number Profile ID	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","profiles","{numberProfileId}","numbers"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"86d44e34-1f57-416b-98a1-8a00e4dfc7a8","name":"400 Bad Request","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToDelete\": [\r\n \"1234567890\" \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:50:50 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":""},{"id":"8950e186-8acc-4eb6-a4d6-bc9306c24dc8","name":"400 Bad Request","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToDelete\": [\r\n \"1234567890\" \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/{numberProfileId}/numbers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:50:50 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LIST\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LIST\"\n },\n {\n \"issue\": \"Bad Request\",\n \"customCode\": \"INVALID_PHONE_NUMBER\"\n }\n ]\n}"},{"id":"776a0713-601b-488a-be93-42ec89f60f7d","name":"422 Unprocessable Entity","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"numbersToDelete\": [\r\n \"1234567890\" \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/profiles/NUMEXXXXXXXXXX/numbers"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 14 May 2026 10:50:50 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/profiles/{numberProfileId}/numbers\",\n \"details\": [\n {\n \"issue\": \"Business validation failed.\",\n \"customCode\": \"BUSINESS_ERROR\"\n }\n ]\n}"}],"_postman_id":"3e329f5b-c19a-45d2-aeb9-5557a603f10a"}],"id":"7368aa18-4683-402c-880e-06574ae0f992","_postman_id":"7368aa18-4683-402c-880e-06574ae0f992","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"2586397e-ab8c-4aa1-8614-02d2c79c79a4","_postman_id":"2586397e-ab8c-4aa1-8614-02d2c79c79a4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"e6a7a9aa-75fc-4ed5-945b-337522956bbc","description":"

Number Management

To begin the registration process, Number Profiles needs to be
created. The profile helps in grouping the numbers together based on various
parameters. The parameters include brand (to whom the numbers belong or
assigned to), root entity (parent), Calling Party Name / Call display name,
Intent of the call and from where the numbers are procured from including other
parameters.

Phone Numbers:

As part of creating a Number Profile, proceed by associating
phone numbers with it. All properties defined in the Profile will apply to
every number linked to it. To finalize the registration process, ensure at
least one number is associated with the Number Profile. Numbers can be added
individually or in bulk. Number details would include the Telephone numbers, Number
type (Inbound, Outbound or Mixed), Do not originate (Y / N), Active (Y, N and D
– Delete), Number group.

General Codes used in Number Profile APIs

Country Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Country Name	Codes
United States	US
Canada	CA

Number Profile Call Intent Table

Call Intent Shortform	Call Intent Code
Sales/Telemarketing	SATE
Account Services	ACCS
Survey	SURV
Political	POLI
Fundraising	FUND
Debt Collection	DEBC
Appointment Reminder	APPR
Informational	INFO
Other	OTHE
Customer Services	CUSE
Appointment Setting	APPS
Billing	BILL
Emergency	EMER
Attorney / Law	ATTO
Financial Service	FSER
First Responder	FRES
Government	GOVN
HealthCare / Hospital	HOSP
Insurance	INSU
Pharmacy / Medical Supply	PHAR
Real Estate	REST
School/College	COLL
Non-Profit	NPF
Multi use line	MUL

Procured From Table

Name	Country Code
3Com	1
ACS Alaska Communications	1
Aircall	1
AireSpring	1
AIRUS, INC.	1
Altice	1
Alvaria	1
Amazon Connect	1
Apeiron	1
AT&T	1
ATT BellSouth	1
Avaya	1
Bandwidth Inc	1
Beacon Communications LLC	1
Blackboard Connect	1
Blitztel	1
BridgeConnex	1
Brightlink	1
BroadBand Dynamics	1
Buckeye Telesystem	1
Call Tracking Metrics	1
CallRevu	1
CallShaper	1
calltools.com	1
CCICom	1
CDK	1
Century Link	1
Charter	1
Chase Data	1
Cincinnatti Bell	1
CMS	1
COEO	1
Comcast	1
Comporium	1
Commio	1
Connexio	1
Cox Communications	1
Crexendo	1
Dealer.com	1
Desk Phone	1
DialPad	1
Double-Positive	1
DriveCentric	1
Everbridge	1
Finvi	1
First Communications	1
Five9	1
Flowroute	1
Fonative	1
Frontier Communications	1
FTC US	1
Fusion Connect	1
Fuze	1
Genesys	1
Genesys Cloud Voice	1
Granite	1
Grasshopper	1
HTC	1
IFX	1
Impact	1
InContact	1
Inspirato LLC	1
IntelePeer	1
Inteliquent	1
InteractiveTel	1
Invoca	1
Ipro	1
IVRT	1
JustCall	1
Key2IP	1
Kumo	1
Level 3 Communications	1
LiveVox	1
Logix	1
Loop Communications	1
Lumen	1
Magna	1
MediaCom US	1
Midco	1
Mightycall	1
Mitel	1
Momentum Telecom	1
Mpower	1
MyKaarma	1
Neutral Tandem (Inteliquent)	1
Nextiva	1
NICE InContact	1
Nobelbiz	1
Noble Systems	1
NovaTel	1
NUM.IO	1
Nuwave	1
O1 Communications	1
Onvoy	1
Outreach	1
Pac Bell	1
PanTerra Networks	1
PEERLESS NETWORK, LLC	1
Plivo	1
Powernet Global	1
Quality Voice & Data	1
Questblue	1
QVD	1
ReadyMode/Xencall	1
Ricochet	1
RingCentral	1
RingDNA	1
Sangoma	1
SNET Communications	1
Spectrum	1
Sprint	1
Suddenlink	1
TCN	1
Televergence	1
Telin	1
Telnyx	1
TetraVX	1
Thinq	1
T-Mobile	1
TNS	1
TouchTone Communications	1
TPX	1
Twilio	1
Vaspian	1
Veracity	1
Verizon	1
Verustat	1
Vinsolutions	1
VoIP Essential	1
VoIP Innovations	1
Vonage	1
Voxo	1
White Label Communications	1
Windstream	1
WINDSTREAM PAETEC	1
WOW!	1
Zoom	1
Rogers Communications	2
TELUS	2
BCE Inc.	2
Shaw Communications	2
Videotron	2
SaskTel	2

Country Code 1 = United States
\n
Country Code 2 = Canada
\n

\n","_postman_id":"e6a7a9aa-75fc-4ed5-945b-337522956bbc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Phone Number","item":[{"name":"v1","item":[{"name":"addImageFile","id":"9f3fa33d-1c84-41aa-8582-3eaa9d7f787e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Image Description\",\r\n \"reason\": \"Image Reason\",\r\n \"imageFile\": \"Upload .png to .jpg file\"\r\n}"},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/call-display/image","description":"

Description

This API endpoint allows us to add an image file. Unique imageID and uploadUrl generated from this API will be used in the request JSON of remediation API. This API endpoint needs to be invoked before calling remediation API.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`description`	String	Yes	description	Image Description
`reason`	String	Yes	reason	Image Reason
`Name`	Type	Required	Description	Example
`imageFile`	MultipartFile	Yes	imageFile	Upload .png to .jpg file

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
`message`	String	Human-readable message about the API operation	Image details are added.
`path`	String	The API endpoint path that was called	/api/v1/phone-number/addImageFile
`data.addImageFileResponse.imageID`	Long	Contains the image id	7fdcde9c54564efebf593dc885af08c1
`data.addImageFileResponse.imageFileName`	Long	Contains the image file name	imagename.png
`data.addImageFileResponse.description`	String	Contains the image description	ImageDetail
`data.addImageFileResponse.uploadedDate`	String	Contains the image uploaded date	Sep 01 2025

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
PLEASE_UPLOAD_IMAGE_FILE	Please upload image file	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_IMAGE_FILE_FORMAT	Invalid image file format. Please ensure the file is in .jpg, .png format	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_DATE_FORMAT_FOR_ACCOUNT	Invalid {0} format {1}.Supported date format is MMM dd yyyy	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVLAID_LOA_DESCRIPTION_LENGTH	{0} description maximum length is 50 characters.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_IMAGE_FILE_MINIMUM_REASON_LENGTH	{0} reason minimum length is 5 characters.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_IMAGE_FILE_REASON_LENGTH	{0} reason maximum length is 30 characters.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","call-display","image"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"05d05249-5d54-441d-83dc-95e84a2eee4a","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Image Description\",\r\n \"reason\": \"Image Reason\",\r\n \"imageFile\": \"Upload .png to .jpg file\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/call-display/image"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-05T14:23:17:17Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Image details are added.\",\n \"path\": \"/api/v1/phone-number/addImageFile\",\n \"data\": {\n \"addImageFileResponse\": {\n \"imageID\": \"7fdcde9c54564efebf593dc885af08c1\",\n \"imageFileName\": \"imagename.png\",\n \"description\": \"ImageDetail\",\n \"uploadedDate\": \"Sep 01 2025\"\n }\n }\n}"},{"id":"aec0c91e-8699-44f8-aa03-b54a4cdd43c8","name":"422-Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"imageFile","type":"file","uuid":"c8d15c96-78d5-4bcd-9406-de36a7baa11b","src":[]}],"options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/call-display/image"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/call-display/image\",\n \"details\": [\n {\n \"issue\": \"Please upload image file\",\n \"customCode\": \"PLEASE_UPLOAD_IMAGE_FILE\"\n },\n {\n \"issue\": \"Invalid image file format. Please ensure the file is in .jpg, .png format\",\n \"customCode\": \"INVALID_IMAGE_FILE_FORMAT\"\n },\n {\n \"issue\": \"Invalid {0} format {1}.Supported date format is MMM dd yyyy\",\n \"customCode\": \"INVALID_DATE_FORMAT_FOR_ACCOUNT\"\n }\n ]\n}"}],"_postman_id":"9f3fa33d-1c84-41aa-8582-3eaa9d7f787e"},{"name":"View Number Details","id":"ae341807-dca9-40bb-9ba5-a93f204cec32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/attributes/search","description":"

Description

This API endpoint retrieves phone number attribute information for one or more phone numbers.

For US numbers (when countryCode is omitted, blank, or US), each number must be a 10-digit value. For international lookups, provide countryCode.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`phoneNumberList`	Array of Long	Yes	Phone numbers to look up (maximum 50)	2079460XXX
`countryCode`	String	No	Country code for international lookup. When omitted, blank, or US, US 10-digit validation applies	US

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response timestamp in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	API call status	SUCCESS
`message`	String	Human-readable message	Phone number details are retrieved for given list of phone numbers.
`path`	String	API endpoint path	/api/v1/phone-numbers/attributes/search
`data.phoneNumbers`	Array	Phone number records
`data.phoneNumbers[].phoneNumber`	String	Phone number	2079460XXX
`data.phoneNumbers[].active`	String	Active status: Y (Active) or N (At Rest)	Y
`data.phoneNumbers[].type`	String	Communication type: in (Inbound), out (Outbound), or both (Mixed)	in
`data.phoneNumbers[].dno`	String	Do Not Originate: Y or N	N
`data.phoneNumbers[].groupName`	String	Group name	Default Group
`data.phoneNumbers[].numberProfileID`	String	Number profile ID	NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`phoneNumberList`	Yes	phoneNumberList cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumberList`	Yes	Maximum limit for Phone Numbers is 50.	INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Entity
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Entity
RECORD_NOT_EXISTED	No Record Found.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","attributes","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"e00ed32d-468d-4c3d-afbd-00a1d6831195","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/attributes/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-05T14:23:17:17Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone number details are retrieved for given list of phone numbers.\",\n \"path\": \"/api/v1/phone-numbers/attributes/search\",\n \"data\": {\n \"phoneNumbers\": {\n \"phoneNumber\": \"2079460XXX\",\n \"active\": \"Y\",\n \"type\": \"in\",\n \"dno\": \"N\",\n \"groupName\": \"Default Group\",\n \"numberProfileID\": \"NUMEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\n }\n }\n}"},{"id":"75e77f81-8bfd-4a46-abdf-f753141d8c20","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/attributes/search"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/attributes/search\",\n \"details\": [\n {\n \"issue\": \"Invalid phone numbers length {0}.It must be 10 digit.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LENGTH\"\n },\n {\n \"issue\": \"Invalid phone number {0}.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_IN_LIST\"\n },\n {\n \"issue\": \"No Record Found.\",\n \"customCode\": \"RECORD_NOT_EXISTED\"\n }\n ]\n}"}],"_postman_id":"ae341807-dca9-40bb-9ba5-a93f204cec32"},{"name":"View Number Rating Details","id":"03c56e21-be64-4ad0-aa70-219f3fd5ea8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/ratings/search","description":"

Description

This API endpoint retrieves risk rating information for one or more phone numbers.

When countryCode is omitted, blank, or US, US risk-rating sources are returned. For other countries, international provider ratings are returned and countryCode is used to format the number.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`phoneNumberList`	Array of Long	Yes	Phone numbers to look up (maximum 50)	2079460XXX
`countryCode`	String	No	Country code for international lookup. When omitted, blank, or US, US 10-digit validation applies	US

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	Response timestamp in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	API call status	SUCCESS
`message`	String	Human-readable message	Phone number risk rating details are retrieved for given list of phone numbers.
`path`	String	API endpoint path	/api/v1/phone-numbers/ratings/search
`data.ratings`	Array	Risk rating records
`data.ratings[].phoneNumber`	Long	Phone number	2079460XXX
`data.ratings[].phoneNumberE164`	String	E.164 formatted number (international lookups)	+442079460XXX
`data.ratings[].createdDate`	String	Phone number created date	Dec 20 2023
`data.ratings[].sources`	Array	Provider rating details
`data.ratings[].sources[].displayName`	String	Service provider name	VERIZON
`data.ratings[].sources[].rating`	String	Risk rating	Low
`data.ratings[].sources[].riskRatingDate`	String	Risk rating date	Jul 10 2025
`data.message`	String	Present when no rating records are found	Rating -No records found for given phone numbers list.

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`phoneNumberList`	Yes	phoneNumberList cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumberList`	Yes	Maximum limit for Phone Numbers is 50.	INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Entity
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Entity
RECORD_NOT_EXISTED	No Record Found.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","ratings","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"50e92d97-7e3d-4e06-b8fb-b21d4a6be0b7","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/ratings/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-30T07:33:30:30Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone number risk rating details are retrieved for given list of phone numbers.\",\n \"path\": \"/api/v1/phone-numbers/ratings/search\",\n \"data\": {\n \"ratings\": [\n {\n \"phoneNumber\": 1234567891,\n \"createdDate\": \"Dec 20 2023\",\n \"sources\": [\n {\n \"displayName\": \"T-MOBILE\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n },\n {\n \"displayName\": \"VERIZON\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n },\n {\n \"displayName\": \"AT&T\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n }\n ]\n },\n {\n \"phoneNumber\": 1234567892,\n \"createdDate\": \"Nov 15 2024\",\n \"sources\": [\n {\n \"displayName\": \"T-MOBILE\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n },\n {\n \"displayName\": \"VERIZON\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n },\n {\n \"displayName\": \"AT&T\",\n \"rating\": \"Not Rated\",\n \"riskRatingDate\": \"\"\n }\n ]\n }\n ]\n },\n \"links\": {}\n}"},{"id":"1693c3b0-e67e-47c0-9c6f-9d685f49f832","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"8005435346\",\r\n \"\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/ratings/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/ratings/search\",\n \"details\": [\n {\n \"field\": \"phoneNumberList\",\n \"issue\": \"phoneNumberList cannot be null or blank.\",\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST\"\n },\n {\n \"field\": \"phoneNumberList\",\n \"issue\": \"Maximum limit for Phone Numbers is 50.\",\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE\"\n }\n ]\n}"},{"id":"2bf8e87f-82ab-4bb6-a33b-132afd8d2fc4","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"123456789\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/ratings/search"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/ratings/search\",\n \"details\": [\n {\n \"issue\": \"Invalid phone numbers length {0}.It must be 10 digit.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LENGTH\"\n },\n {\n \"issue\": \"Invalid phone number {0}.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_IN_LIST\"\n },\n {\n \"issue\": \"No Record Found.\",\n \"customCode\": \"RECORD_NOT_EXISTED\"\n }\n ]\n}"}],"_postman_id":"03c56e21-be64-4ad0-aa70-219f3fd5ea8f"},{"name":"View Remediation Details","id":"0d457b8a-9b20-4f0d-936c-ffa062c23fa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediations/search","description":"

Description

This API endpoint retrieves remediation information for one or more phone numbers. Only remediations with a resolved date within the last 60 days are returned.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`phoneNumberList`	Array of Long	Yes	Phone numbers to look up (maximum 50)	2079460XXX

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	Response timestamp in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	API call status	SUCCESS
`message`	String	Human-readable message	Phone number remediation details are retrieved for given list of phone numbers.
`path`	String	API endpoint path	/api/v1/phone-numbers/remediations/search
`data.remediations`	Array	Remediation records
`data.remediations[].rootEntityName`	String	Root entity name	ABC Testing Company
`data.remediations[].rootEntityCode`	String	Root entity code	NUMEXXXXXX
`data.remediations[].entityName`	String	Entity name	ABC Testing Company
`data.remediations[].entityCode`	String	Entity code	NUMEXXXXXX
`data.remediations[].phoneNumber`	Long	Phone number	2079460XXX
`data.remediations[].country`	String	Country code	US
`data.remediations[].source`	String	Service provider name	VERIZON
`data.remediations[].submittedDate`	String	Remediation submitted date	Jul 10 2025
`data.remediations[].resolvedDate`	String	Remediation resolved date	Jul 10 2025
`data.remediations[].rating`	String	Risk rating	Spam
`data.remediations[].result`	String	Resulting risk rating	Low
`data.remediations[].remediationStatus`	String	Remediation status	Success
`data.message`	String	Present when no remediation records are found	Remediation -No records found for given phone numbers list.

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`phoneNumberList`	Yes	phoneNumberList cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumberList`	Yes	Maximum limit for Phone Numbers is 50.	INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Entity
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","remediations","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"38ba1fd4-43a3-4d36-875d-e65b0fbe6c60","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 1234567891\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediations/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-07-08T13:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone number remediation details are retrieved for given list of phone numbers.\",\n \"path\": \"/api/v1/phone-numbers/remediations/search\",\n \"data\": {\n \"remediations\": [\n {\n \"rootEntityName\": \"ABC Testing Company\",\n \"rootEntityCode\": \"NUMEXXXXXX\",\n \"entityName\": \"ABC Testing Company\",\n \"entityCode\": \"NUMEXXXXXX\",\n \"phoneNumber\": 1234567891,\n \"country\": \"US\",\n \"source\": \"AT&T\",\n \"submittedDate\": \"Sep 07 2026\",\n \"resolvedDate\": \"Sep 09 2026\",\n \"rating\": \"Spam\",\n \"result\": \"Low\",\n \"remediationStatus\": \"Success\"\n }\n \n ]\n },\n \"links\": {}\n}"},{"id":"70222bce-e461-406b-ac98-42b2770f8998","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"8005435346\",\r\n \"2234567896\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediations/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/remediations/search\",\n \"details\": [\n {\n \"field\": \"phoneNumberList\",\n \"issue\": \"phoneNumberList cannot be null or blank.\",\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST\"\n },\n {\n \"field\": \"phoneNumberList\",\n \"issue\": \"Maximum limit for Phone Numbers is 50.\",\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE\"\n }\n ]\n}"},{"id":"3b874fba-3b72-4c59-acd4-2b8d84bcbb02","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 123456789,\r\n 2234567896\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediations/search"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/remediations/search\",\n \"details\": [\n {\n \"issue\": \"Invalid phone numbers length {0}.It must be 10 digit.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LENGTH\"\n },\n {\n \"issue\": \"Invalid phone number {0}.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_IN_LIST\"\n }\n ]\n}"}],"_postman_id":"0d457b8a-9b20-4f0d-936c-ffa062c23fa1"},{"name":"View Remediation Status Details","id":"5fa2492a-5d76-48f3-b2fb-50bde003094c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediation-status/search","description":"

Description

This API endpoint retrieves remediation status information for one or more phone numbers.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`phoneNumberList`	Array of Long	Yes	Phone numbers to look up (maximum 50)	2079460XXX

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	Response timestamp in ISO 8601 format	2025-08-05T14:23:17:17Z
`status`	String	API call status	SUCCESS
`message`	String	Human-readable message	Phone number remediation status details are retrieved for given list of phone numbers.
`path`	String	API endpoint path	/api/v1/phone-numbers/remediation-status/search
`data.remediations`	Array	Remediation status records
`data.remediations[].rootEntityName`	String	Root entity name	ABC Testing Company
`data.remediations[].rootEntityCode`	String	Root entity code	NUMEXXXXXX
`data.remediations[].entityName`	String	Entity name	ABC Testing Company
`data.remediations[].entityCode`	String	Entity code	NUMEXXXXXX
`data.remediations[].phoneNumber`	Long	Phone number	2079460XXX
`data.remediations[].country`	String	Country code	US
`data.remediations[].source`	String	Service provider name	VERIZON
`data.remediations[].weeklyRating`	String	Weekly rating	Spam
`data.remediations[].weeklyRatingDate`	String	Weekly rating date	Jul 03 2025
`data.remediations[].submittedDate`	String	Submitted date	Jul 03 2025
`data.remediations[].resolvedDate`	String	Resolved date	Jul 03 2025
`data.remediations[].rating`	String	Phone number rating	Spam
`data.remediations[].result`	String	Rating after remediation	Low
`data.remediations[].remediationStatus`	String	Remediation status	In-Progress
`data.remediations[].adhocRemediation`	Object	Ad hoc remediation details (when present)
`data.remediations[].adhocRemediation.submittedDate`	String	Ad hoc submitted date	Jul 03 2025
`data.remediations[].adhocRemediation.resolvedDate`	String	Ad hoc resolved date	Jul 03 2025
`data.remediations[].adhocRemediation.rating`	String	Ad hoc rating	Spam
`data.remediations[].adhocRemediation.result`	String	Ad hoc result	Low
`data.remediations[].adhocRemediation.remediationStatus`	String	Ad hoc remediation status	In-Progress
`data.remediations[].adhocRemediation.requestId`	String	Ad hoc remediation request ID	RE434yuhTY
`data.message`	String	Present when no remediation status records are found	Remediation -No records found for given phone numbers list.

Input Validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
`phoneNumberList`	Yes	phoneNumberList cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_LIST	400	Bad Request
`phoneNumberList`	Yes	Maximum limit for Phone Numbers is 50.	INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE	400	Bad Request

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Entity
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Entity

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","remediation-status","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"03838efa-b36b-4562-8c61-44de0fe1ca46","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"2079460XXX\",\r\n \"2079461XXX\"\r\n ],\r\n \"countryCode\": \"US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediation-status/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-05T14:23:17:17Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Phone number remediation status details are retrieved for given list of phone numbers.\",\n \"path\": \"/api/v1/phone-numbers/remediation-status/search\",\n \"data\": {\n \"remediations\": {\n \"rootEntityName\": \"ABC Testing Company\",\n \"rootEntityCode\": \"NUMEXXXXXX\",\n \"entityName\": \"ABC Testing Company\",\n \"entityCode\": \"NUMEXXXXXX\",\n \"phoneNumber\": \"2079460XXX\",\n \"country\": \"US\",\n \"source\": \"VERIZON\",\n \"weeklyRating\": \"Spam\",\n \"weeklyRatingDate\": \"Jul 03 2025\",\n \"submittedDate\": \"Jul 03 2025\",\n \"resolvedDate\": \"Jul 03 2025\",\n \"rating\": \"Spam\",\n \"result\": \"Low\",\n \"remediationStatus\": \"In-Progress\",\n \"adhocRemediation\": {\n \"submittedDate\": \"Jul 03 2025\",\n \"resolvedDate\": \"Jul 03 2025\",\n \"rating\": \"Spam\",\n \"result\": \"Low\",\n \"remediationStatus\": \"In-Progress\",\n \"requestId\": \"RE434yuhTY\"\n }\n },\n \"message\": \"Remediation -No records found for given phone numbers list.\"\n }\n}"},{"id":"04622309-b432-4a7b-9ec9-82152a87c109","name":"400-Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"8005435346\",\r\n \"2234567896\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediation-status/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/phone-numbers/remediation-status/search\",\r\n \"details\": [\r\n {\r\n \"field\": \"phoneNumberList\",\r\n \"issue\": \"phoneNumberList cannot be null or blank.\",\r\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST\"\r\n },\r\n {\r\n \"field\": \"phoneNumberList\",\r\n \"issue\": \"Maximum limit for Phone Numbers is 50.\",\r\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST_SIZE\"\r\n }\r\n ]\r\n}"},{"id":"d91cc898-683c-4850-87fe-6039199f1b3e","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 800543534,\r\n 2234567896\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/remediation-status/search"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/phone-numbers/remediation-status/search\",\n \"details\": [\n {\n \"issue\": \"Invalid phone numbers length {0}.It must be 10 digit.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_LENGTH\"\n },\n {\n \"issue\": \"Invalid phone number {0}.\",\n \"customCode\": \"INVALID_PHONE_NUMBER_IN_LIST\"\n }\n ]\n}"}],"_postman_id":"5fa2492a-5d76-48f3-b2fb-50bde003094c"},{"name":"View FCC Issue Number Details","id":"83cb429d-d919-4b3a-b09f-2bd5b59462f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 1234567891,\r\n 1234567892\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/fcc-complaints/search","description":"

This API end point retrieves phone number fcc information for a single phone number or multiple numbers.

Request Body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
phoneNumberList	List	Yes	phoneNumberList	1234567891
startDate	String	Yes	startDate	Jun 23 2025
endDate	String	Yes	endDate	Aug 23 2025

Response Body:

Name	Type	Description	Example
timestamp	String	Date and time of the response in ISO 8601 format	2025-08-05T14:23:17:17Z
status	String	Status of the API call (e.g., SUCCESS, ERROR)	SUCCESS
message	String	Human-readable message about the API operation	Phone number list fcc details are retrieved for given list.
path	String	The API endpoint path that was called	/api/v1/phone-number/fcc
data	Object	Contains response data relevant to the request	fccissues
data.fccissues.phoneNumber	Long	Contains the phone number	1234567891
data.fccissues.ticketId	Long	Contains the ticker id	8108907
data.fccissues.ticketCreated	String	Contains the ticket created date	2025-08-28
data.fccissues.dateCreated	String	Contains the fccissue created date	2025-08-28
data.fccissues.issueDate	Long	Contains the issue date	2025-08-28
data.fccissues.issueTime	String	Contains the issue time	2:40 PM
data.fccissues.issueType	String	Contains the issue type	Phone
data.fccissues.method	String	Contains the issue method	Internet (VOIP)
data.fccissues.issue	String	Contains the issue	Unwanted Calls
data.fccissues.callerIdNumber	Long	Contains the called id number	1234567891
data.fccissues.typeOfCallOrMessage	String	Contains the type of call or message	Live Voice
data.fccissues.advertiserBusinessPhoneNumber	Long	Contains advertiser business phone number	1234567891
data.fccissues.city	String	Contains the city	Fresno
data.fccissues.state	String	Contains the state	CA
data.fccissues.zip	String	Contains the zip code	93722
data.fccissues.location1	String	Contains the location	{\"latitude\":36.78069,\"longitude\":-119.88031,\"human_address\":\"{\\\"address\\\": \\\"\\\", \\\"city\\\": \\\"CA\\\", \\\"state\\\": \\\"\\\", \\\"zip\\\": \\\"93722\\\"}\"}
data.fccissues.typeOfPropertyGoodsOrServices	String	Contains the type of property goods or sevices	Solar Panels Services

Input Validation:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Message	Custom Error Code	HTTP Status Code	HTTP Status Message
phoneNumberList	Yes	phoneNumberList cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_LIST	400	Bad Request
phoneNumberList	Yes	Maximum limit for Phone Numbers is 50.	INVALID_VISIBILITY_PHONE_NUMBER_LIST_LENGTH	400	Bad Request
startDate	Yes	startDate cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_START_DATE	400	Bad Request
startDate	Yes	startDate cannot be blank.And date format is MMM dd yyyy.	INVALID_VISIBILITY_PHONE_NUMBER_START_DATE_FORMAT	400	Bad Request
endDate	Yes	endDate cannot be null or blank.	INVALID_VISIBILITY_PHONE_NUMBER_END_DATE	400	Bad Request
endDate	Yes	endDate cannot be blank.And date format is MMM dd yyyy.	INVALID_VISIBILITY_PHONE_NUMBER_END_DATE_FORMAT	400	Bad Request

Business Validation:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_DATE_FORMAT_FOR_ACCOUNT	Invalid {0} format {1}.Supported date format is MMM dd yyyy	422	Unprocessable Entity (WebDAV) (RFC 4918)
INVALID_FCC_DATE_RANGE	Invalid date range StartDate {0} EndDate {1}.FCC data is available for last 60 days.	422	Unprocessable Entity (WebDAV) (RFC 4918)

","urlObject":{"protocol":"https","path":["api","v1","phone-numbers","fcc-complaints","search"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"a2482d3f-c63b-4bdc-9414-bcd9f60b24e1","name":"200-OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 1234567891,\r\n 1234567892\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/fcc-complaints/search"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-07-08T13:00:00Z\",\r\n \"status\": \"SUCCESS\",\r\n \"message\": \"Phone number FCC Issue details are retrieved for given list of phone numbers.\",\r\n \"path\": \"/api/v1/phone-numbers/fcc-complaints/search\",\r\n \"data\": {\r\n \"fccissues\": [\r\n {\r\n \"phoneNumber\": 1234567891,\r\n \"ticketId\": 8108907,\r\n \"ticketCreated\": \"2025-08-28\",\r\n \"dateCreated\": \"2025-08-27\",\r\n \"issueDate\": \"2025-08-27\",\r\n \"issueTime\": \"2:40 PM\",\r\n \"issueType\": \"Phone\",\r\n \"method\": \"Internet (VOIP)\",\r\n \"issue\": \"Unwanted Calls\",\r\n \"callerIdNumber\": null,\r\n \"typeOfCallOrMessage\": \"Live Voice\",\r\n \"advertiserBusinessPhoneNumber\": 5595534835,\r\n \"city\": \"Fresno\",\r\n \"state\": \"CA\",\r\n \"zip\": \"93722\",\r\n \"location1\": \"{\\\"latitude\\\":36.78069,\\\"longitude\\\":-119.88031,\\\"human_address\\\":\\\"{\\\\\\\"address\\\\\\\": \\\\\\\"\\\\\\\", \\\\\\\"city\\\\\\\": \\\\\\\"CA\\\\\\\", \\\\\\\"state\\\\\\\": \\\\\\\"\\\\\\\", \\\\\\\"zip\\\\\\\": \\\\\\\"93722\\\\\\\"}\\\"}\",\r\n \"typeOfPropertyGoodsOrServices\": \"Other Services\"\r\n },\r\n {\r\n \"phoneNumber\": 1234567892,\r\n \"ticketId\": 8108513,\r\n \"ticketCreated\": \"2025-08-27\",\r\n \"dateCreated\": \"2025-08-27\",\r\n \"issueDate\": \"2025-08-27\",\r\n \"issueTime\": \"10:57 am\",\r\n \"issueType\": \"Phone\",\r\n \"method\": \"Wired\",\r\n \"issue\": \"Unwanted Calls\",\r\n \"callerIdNumber\": 3046478961,\r\n \"typeOfCallOrMessage\": \"Prerecorded Voice\",\r\n \"advertiserBusinessPhoneNumber\": 3046478961,\r\n \"city\": \"Port angeles\",\r\n \"state\": \"WA\",\r\n \"zip\": \"98362\",\r\n \"location1\": \"{\\\"latitude\\\":48.11892,\\\"longitude\\\":-123.43112,\\\"human_address\\\":\\\"{\\\\\\\"address\\\\\\\": \\\\\\\"\\\\\\\", \\\\\\\"city\\\\\\\": \\\\\\\"WA\\\\\\\", \\\\\\\"state\\\\\\\": \\\\\\\"\\\\\\\", \\\\\\\"zip\\\\\\\": \\\\\\\"98362\\\\\\\"}\\\"}\",\r\n \"typeOfPropertyGoodsOrServices\": \"\"\r\n }\r\n ]\r\n },\r\n \"links\": {}\r\n}"},{"id":"c326fd83-7f23-4f2e-a8ca-b820a4c97cf0","name":"400-Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n \"8005435346\",\r\n \"2234567896\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/fcc-complaints/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-08-28T05:00:48:48Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/phone-numbers/fcc-complaints/search\",\r\n \"details\": [\r\n {\r\n \"field\": \"phoneNumberList\",\r\n \"issue\": \"phoneNumberList cannot be null or blank.\",\r\n \"customCode\": \"INVALID_VISIBILITY_PHONE_NUMBER_LIST\"\r\n }\r\n ]\r\n}"},{"id":"401360b3-6d21-4db4-ac7a-4a0700ea5bbe","name":"422-Unprocessable Content","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumberList\": [\r\n 800543534,\r\n 2234567896\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/phone-numbers/fcc-complaints/search"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-10-10T18:19:00:00Z\",\r\n \"status\": \"ERROR\",\r\n \"message\": \"Business validation failed for one or more fields.\",\r\n \"path\": \"/api/v1/phone-numbers/fcc-complaints/search\",\r\n \"details\": [\r\n {\r\n \"issue\": \"Invalid phone numbers length [800543534].It must be 10 digit.\",\r\n \"customCode\": \"INVALID_PHONE_NUMBER_LENGTH\"\r\n }\r\n ]\r\n}"}],"_postman_id":"83cb429d-d919-4b3a-b09f-2bd5b59462f3"}],"id":"e046e9d6-1d80-492a-808d-dd31ab0630a6","description":"

This suite of REST APIs facilitates a structured and modular approach to retrieve the risk rating, remediation and fcc data for the given phone number list.

View Risk Rating Number Details

This method retrieves the rating information (across carriers) for a single phone number or multiple numbers.

View Remediation Number Details

This API end point retrieves remediation information for a single phone number or multiple numbers.

View Remediation status Number Details

This API end point retrieves remediation status information for a single phone number or multiple numbers.

View FCC Issue Number Details

This API end point is used to retrieve FCC complaints associated with a phone number or multiple numbers.

FCC data can be retrieved for last 60 days with respect to ticket created date. Range between start date and end date should not be extend more than 60 days.

View Phone Number Details

This API end point is used to retrieve phone number information for a single phone number or multiple numbers.

Get Phone Number Details By Relationship Code

This API end point is used to retrieve phone number associated to the given relationship.

Add Image API

\n","_postman_id":"e046e9d6-1d80-492a-808d-dd31ab0630a6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"8dffacc7-1c57-493f-9c47-4b99a37a7156","description":"

Appendix

Rating Table (Rating API)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Rating Field	Description
Not Rated	The number hasn’t been rated yet, rating still in process
Low	The number is clean
Medium	The number is clean
Spam	The number is tagged as spam
Fraud	The number is tagged as fraudulent

Rating and Result Table (Remediation API)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Rating Field	Description
Low	The number is clean
Medium	The number is clean
Spam	The number is tagged as spam
Fraud	The number is tagged as fraudulent

Frequently asked questions:

How can you determine if the number registration (cleaning) process is complete?

If the ‘rating’ field in the {{url}}/api/phone-number/rating API shows a value other than Not Rated, the rating process is complete. Possible values include Low, Medium, Spam, and Fraud.

What do the different values in the rating field represent?

Not Rated: The number has not been rated yet and is still being processed.
\n
Low: The number is clean.
\n
Medium: The number is clean.
\n
Spam: The number is flagged as spam.
\n
Fraud: The number is flagged as fraudulent.
\n

Does Numeracle auto initiate remediation for numbers identified as tagged (Spam, Fraud)?

Yes, Numeracle automatically initiates remediation with carrier analytical partners, such as First Orion, TNS, and Hiya, for numbers identified as tagged during the rating API updates unless the contract states otherwise.

How can you determine if a remediation request is complete?

If a record exists in the {{url}}/api/phone-number/remediation API with a recent ‘resolvedDate’ and a corresponding value in the ‘result’ field, the remediation request is complete.
\n
Possible values for both ‘rating’ and ‘result’ fields are Low, Medium, Spam, and Fraud.
\n

How long does the remediation process typically take?

The remediation process generally takes a few days from the time ratings are available. However, in some cases, it may take longer.

How often can the ratings and remediation APIs be called?

Rating API: Can be called weekly on Mondays, with a backup call on Tuesdays if no updates are available (based on riskRatingDate).
\n
Remediation API: Ideally called once or twice a week for updates.
\n

Can the reason for a failed remediation request be identified via API’s?

The APIs do not provide information on why a remediation request failed. For further details, you can contact our Customer Success Team at support@numeracle.com.

\n","_postman_id":"8dffacc7-1c57-493f-9c47-4b99a37a7156","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Remediation","item":[{"name":"v1","item":[{"name":"Submit","id":"49f0924b-2db4-452d-86e1-48ba8b494c36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"carriers\": [\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"imageID\": \"7ef9916221f74558a16df724ff517003\"\r\n },\r\n {\r\n \"cnamValue\": \"Fraud\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"imageID\": \"7ef9916221f74558a16df724ff517003\"\r\n }\r\n ],\r\n \"serviceProvider\": \"Verizon\"\r\n },\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\"\r\n },\r\n {\r\n \"cnamValue\": \"Fraud\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\"\r\n }\r\n ],\r\n \"serviceProvider\": \"T-Mobile\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/remediations","description":"

Description

Submits a remediation request for one or more phone numbers across one or more service providers.

Each request contains service provider information, phone numbers, requested CNAM/rating values, optional image IDs, and number profile IDs. The service creates one remediation row per phone number/service provider entry and creates a remediation log row for the generated request ID.

On success, it returns a unique requestId and a links.self URL that can be used to view the remediation result after processing completes.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`carriers`	Array	Yes	Service provider groups. Must not be null or empty.	[ { ... } ]
`carriers[].serviceProvider`	String	Yes	Service provider name or code. It is resolved by ServiceProviderDAO.findByNameOrCode and must match the number profile country.	\"Verizon\"
`carriers[].phoneNumberInfo`	Array	Yes	Phone number remediation records for the service provider. Must not be null or empty.	[ { ... } ]
`carriers[].phoneNumberInfo[].phoneNumber`	String	Yes	Digit-only phone number. Bean validation allows 10-15 digits; US profiles must be exactly 10 digits. Non-US profiles are normalized using the country on the number profile.	2079460XXX
`carriers[].phoneNumberInfo[].numberProfileId`	String	Yes	Number profile / relationship ID used to resolve profile, entity, country, and access information.	\"NUME813585ecbab34548951e372725459bea\"
`carriers[].phoneNumberInfo[].cnamValue`	String	Yes	Requested remediation rating. Must be `Spam` or `Fraud`.	\"Spam\"
`carriers[].phoneNumberInfo[].imageID`	String	No	Optional image/document ID. If provided, it must exist and is attached to the CSM notification email.

Response Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description	Example
`timestamp`	String	UTC response timestamp formatted by `RemediationResponseTO`.	\"2025-09-02T03:00:30:30Z\"
`status`	String	SUCCESS on successful submission.	\"SUCCESS\"
`message`	String	Localized success message.	\"Phone numbers successfully reported.\"
`path`	String	API path that was invoked.	\"api/v1/remediations\"
`data`	Object	Request details returned after submission.	{\"requestId\": \"...\", \"submittedBy\": \"...\"}
`data.requestId`	String	Generated request ID for this remediation submission.	\"39a45c9551e04e64b5ce128404397433\"
`data.submittedBy`	String	Authenticated user from ThreadLocalUtil.getUserName().	\"api-user@example.com\"
`links`	Object	Related API links.	{\"self\": \"api/v1/remediations/{requestId}\"}
`links.self`	String	View endpoint for the generated request ID.	\"api/v1/remediations/39a45c9551e04e64b5ce128404397433\"

Input Validation:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Validation Annotation	Message / Rule	HTTP Status Code	HTTP Error Message
`carriers`	List	Yes	`@Valid`, `@NotNull`, `@NotEmpty`	`carriers cannot be null; ensure that exactly one record is provided.` / `carriers cannot be empty; ensure that exactly one record is provided.`	400	Bad Request
`carriers[].serviceProvider`	String	Yes	`@NotNull`, `@NotBlank`	`serviceProvider cannot be null or blank.`	400	Bad Request
`carriers[].phoneNumberInfo`	List	Yes	`@Valid`, `@NotNull`, `@NotEmpty`	`phoneNumberInfo cannot be null; ensure that exactly one record is provided.` / `phoneNumberInfo cannot be empty; ensure that exactly one record is provided.`	400	Bad Request
`carriers[].phoneNumberInfo[].phoneNumber`	String	Yes	`@NotNull`, `@Size(min=10,max=15)`, `@Pattern(^\\\\d+$)`	`phoneNumber cannot be null or blank.`, `phoneNumber length must be between 10 and 15 digits.`, `phoneNumber must contain digits only.`	400	Bad Request
`carriers[].phoneNumberInfo[].numberProfileId`	String	Yes	`@NotBlank`, `@NotEmpty`	`numberProfileId cannot be null or blank.`	400	Bad Request
`carriers[].phoneNumberInfo[].cnamValue`	String	Yes	`@NotNull` `@Pattern`	`cnamValue cannot be null or blank.`, `cnamValue must be 'Spam' or 'Fraud'.`	400	Bad Request
`carriers[].phoneNumberInfo[].imageID`	String	No	None	Optional. If empty, no image is attached.	—	—

Business Validations:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
DUPLICATE_PHONE_NUMBER	Duplicate phone number detected: {0}. Please eliminate the duplicate.	409	Conflict
REQUEST_ALREADY_EXIST	Request IDs are already in place. Please initiate the request(s) after 24 hours.	409	Conflict
MAX_SIZE_OF_PHONE_NUMBER_FOR_REMEDIATION	Users are permitted to submit a maximum of six numbers. Please ensure that the total count of numbers submitted does not exceed this limit to ensure proper processing.	422	Unprocessable Content
INVALID_RELATIONSHIP_CODE	Invalid \"Relationship Code\" {0}.	422	Unprocessable Content
NUMBER_PROFILE_IS_DELETED	numberProfileId {0} is Deleted.	422	Unprocessable Content
REMEDIATION_FEATURE	Remediation feature is Not enable at entity level please contact Numeracle team.	422	Unprocessable Content
INVALID_SOURCE_NAME	Invalid ServiceProvider {0}.	422	Unprocessable Content
SERVICE_PROVIDER_COUNTRY_MISMATCH	ServiceProvider {0} belongs to country {1}, but numberProfileId {2} belongs to country {3}.	422	Unprocessable Content
INVALID_PHONE_NUMBER_LENGTH	Invalid phone numbers length {0}.It must be 10 digit.	422	Unprocessable Content
INVALID_PHONE_NUMBER_IN_LIST	Invalid phone number {0}.	422	Unprocessable Content
INVALID_CNAM	Invalid cnamValue for phoneNumber: {0} connected to serviceProvider: {1} numberProfileId: {2}. Please submit numbers tagged as SPAM or Fraud.	422	Unprocessable Content
INVAILD_IMAGE_ID	Invalid imageID {0}.	422	Unprocessable Content

","urlObject":{"protocol":"https","path":["api","v1","remediations"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"64682e9f-a6cd-4971-8432-d05aba19d0f1","name":"201-Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"carriers\": [\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2147676580\"\r\n },\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2148878878\"\r\n }\r\n ],\r\n \"serviceProvider\": \"AT&T\"\r\n },\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2148878879\"\r\n },\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2147676580\"\r\n }\r\n ],\r\n \"serviceProvider\": \"T-Mobile\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/remediations"},"status":"201-Created","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"timestamp\": \"2025-09-02T03:00:30:30Z\",\r\n \"status\": \"SUCCESS\",\r\n \"message\": \"Phone numbers successfully reported.\",\r\n \"path\": \"api/v1/remediations\",\r\n \"data\": {\r\n \"requestId\": \"53081d59b07c4c6bbc840bdddf81e555\",\r\n \"submittedBy\": \"api-user@example.com\",\r\n \"remediationStatus\": \"In-Progress\"\r\n },\r\n \"links\": {\r\n \"self\": \"api/v1/remediations/53081d59b07c4c6bbc840bdddf81e555\"\r\n }\r\n}"},{"id":"5c74934b-7f08-4405-9d0c-8c10fc742851","name":"400-BadRequest","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"carriers\": [\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"214XXX65\"\r\n },\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"214XXX8878\"\r\n }\r\n ],\r\n \"serviceProvider\": \"AT&T\"\r\n },\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"214XXX8879\"\r\n },\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"214XXX6580\"\r\n }\r\n ],\r\n \"serviceProvider\": \"T-Mobile\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/remediations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2025-08-11T00:51:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Validation failed for one or more fields.\",\n \"path\": \"/api/v1/remediations\",\n \"details\": [\n {\n \"issue\": \"Bad Request\"\n },\n {\n \"issue\": \"Bad Request\"\n },\n {\n \"issue\": \"Bad Request\"\n }\n ]\n}"},{"id":"8acdd20d-dee6-453f-8f83-f80d88d05fd8","name":"422-Unprocessable Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"carriers\": [\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"imageID\": \"7ef9916221f74558a16df724ff517003\"\r\n },\r\n {\r\n \"cnamValue\": \"Fraud\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\",\r\n \"imageID\": \"7ef9916221f74558a16df724ff517003\"\r\n }\r\n ],\r\n \"serviceProvider\": \"Verizon\"\r\n },\r\n {\r\n \"phoneNumberInfo\": [\r\n {\r\n \"cnamValue\": \"Spam\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\"\r\n },\r\n {\r\n \"cnamValue\": \"Fraud\",\r\n \"numberProfileId\": \"NUMEXXXXXXXXXXXXXXXb56dd66c019\",\r\n \"phoneNumber\": \"2079460XXX\"\r\n }\r\n ],\r\n \"serviceProvider\": \"T-Mobile\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.sandbox.numeracle.com/api/v1/remediations"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jul 2026 09:10:40 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: 00c37e1d-f7f3-4b48-830b-7a06257e1a47\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-10-10T13:15:56:56Z\",\n \"status\": \"ERROR\",\n \"message\": \"Business validation failed for one or more fields.\",\n \"path\": \"/api/v1/remediations\",\n \"details\": [\n {\n \"issue\": \"Duplicate phone number detected: {0}. Please eliminate the duplicate.\",\n \"customCode\": \"DUPLICATE_PHONE_NUMBER\"\n },\n {\n \"issue\": \"Request IDs are already in place. Please initiate the request(s) after 24 hours.\",\n \"customCode\": \"REQUEST_ALREADY_EXIST\"\n },\n {\n \"issue\": \"Users are permitted to submit a maximum of six numbers. Please ensure that the total count of numbers submitted does not exceed this limit to ensure proper processing.\",\n \"customCode\": \"MAX_SIZE_OF_PHONE_NUMBER_FOR_REMEDIATION\"\n }\n ]\n}"}],"_postman_id":"49f0924b-2db4-452d-86e1-48ba8b494c36"},{"name":"View","id":"59b16de7-7529-4bfc-98da-4a71562d61c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://www.sandbox.numeracle.com/api/v1/remediations/{requestId}","description":"

Description

Retrieves remediation records for a completed remediation request ID.

The endpoint validates request ownership for non-super users before loading the data. It returns results only when the remediation log status is COMPLETED; otherwise it returns a 422 business validation response.

Request Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Location	Type	Required	Description
`requestId`	Path Variable	String	Yes	Unique remediation request ID returned by POST /api/v1/remediations. Example: `53081d59b07c4c6bbc840bdddf81e555`

Response Parameters:

Name	Type	Description	Example
`timestamp`	String	UTC response timestamp formatted by RemediationGetResponseTO.	\"2025-10-01T05:20:38:38Z\"
`status`	String	SUCCESS on successful retrieval.	\"SUCCESS\"
`message`	String	Localized success message.	\"Remediation details are retrieved.\"
`path`	String	API path for this request ID.	\"api/v1/remediations/53081d59b07c4c6bbc840bdddf81e555\"
`data`	Array	List of remediation records for the request ID.	[ { ... } ]
`data[].phoneNumber`	Number	Submitted phone number normalized to the profile country.	2079460XXX
`data[].country`	String	Country abbreviation from the number profile.	US
`data[].rating`	String	Submitted remediation rating/CNAM value.	\"Spam\"
`data[].result`	String	Remediation result after processing, when available.	\"Low\"
`data[].rootEntity`	String	Root entity name from the number profile.	\"Demo Root Entity\"
`data[].entityName`	String	Assigned/brand entity name from the number profile.	\"Demo Brand\"
`data[].submittedBy`	String	User that submitted the remediation request.	\"api-user@example.com\"
`data[].serviceProvider`	String	Remediation source/service provider stored on the remediation row.	\"TNS\"
`data[].submittedDate`	String	Date when remediation was submitted.	\"2024-11-27\"
`data[].resolvedDate`	String	Date when remediation was resolved, omitted until available.	\"2024-11-27\"

Business Validations

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Custom Error Code	Message	HTTP Status Code	HTTP Error Message
INVALID_REQUEST_ID	Invalid RequestId {0}.	422	Unprocessable Content
REQUEST_ID_STILL_IN_PROGRESS	RequestId {0} still in-progress.	422	Unprocessable Content

Creates a new remediation request for one or more phone numbers under a given entity. Once submitted, the API returns a unique requestId which can later be used to query the status of the request using the GET endpoint.

\n","_postman_id":"e47d36e7-6a03-4c52-a7f9-e55dc102fe54","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"65a1ab68-b37e-4455-9df8-32394b16edaa","description":"

Note: These APIs are planned for a future capability and are not supported for production integration at this time.

This API will allow clients to submit remediation requests outside the rating cycle by allowing clients to report tagged numbers across various carriers like T-Mobile, Verizon and AT&T. Clients can optionally attach JPG , PNG files for each reported number submitted for remediation (This
will be taken care in the next subsequent releases)

WebHook Implementation

Remediation timelines for phone numbers across different carriers will differ. It generally takes a few days for the process to complete. A schedular is configured to run every hour to capture on updates related to the remediation status of the phone numbers submitted across a given request
id.

Updates on phone number linked to Request ID will be provided to client via a webhook once all the numbers associated with the request is complete.

The following parameters are needed from client as a pre-requisite for webhook url ,to present the status of batch.

Webhook UserName,Webhook Password, Webhook URL and Webhook Email to notify client in case of any webhook URL failure

The following fields are to be presented in the json request for webhook URL

{

\"eventType\":\"string\",

\"Id\":\"string \",

\"status\":\"string \",

\"action\":\"string \",

\"timestamp\":\"string \"

}

\n","_postman_id":"65a1ab68-b37e-4455-9df8-32394b16edaa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Webhook","item":[{"name":"Entity events","item":[{"name":"entityApprovalEvent-Token","id":"a5f427c2-537c-44bb-9f9d-41893d407340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.approved\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Entity Approved\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"0bef01c0-b6db-452b-aac5-0c56ca1a5d5e","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.approved\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Entity Approved\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 16 Oct 2025 06:42:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"236"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"356a5bc7-6a5f-415e-968b-d1b1aebbe994"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"},{"key":"x-amz-apigw-id","value":"ShwNhHpXCYcET7A="},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,DELETE,OPTIONS"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68f093ef-757b418b71f6235512d79a05;Parent=5e95f5a1d46422e2;Sampled=0;Lineage=1:9c875fae:0"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Webhook data received and stored successfully\",\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\n}"}],"_postman_id":"a5f427c2-537c-44bb-9f9d-41893d407340"},{"name":"entityApprovalEvent-Basic","id":"3fa2bce0-8150-4c29-9bc7-a476e37667f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.approved\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Entity Approved\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"943e9e13-b48a-4d85-a1b4-d85d029fbd05","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.approved\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Entity Approved\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"3fa2bce0-8150-4c29-9bc7-a476e37667f2"},{"name":"entityRejectionEvent-Token","id":"b62885bd-acaa-4ab5-b48e-be6633c6ea25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.rejected\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Entity Reject\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"b09cc003-6959-4b89-9166-325028c3ebf6","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.rejected\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Entity Reject\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"b62885bd-acaa-4ab5-b48e-be6633c6ea25"},{"name":"entityRejectionEvent-Basic","id":"367cfa9e-0f70-4770-8050-cbbb6667447b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.rejected\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Entity Reject\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"1cb59c6c-a3aa-4782-ace8-c3192c18dc4e","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"entity.rejected\",\r\n \"id\": \"NXXXXXX1846\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Entity Reject\",\r\n \"timeStamp\": \"Mar 18 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"367cfa9e-0f70-4770-8050-cbbb6667447b"}],"id":"b81cc069-ca0f-4965-843c-0bbe2be28f0f","description":"

Entity events:

These webhooks relate to the approval or rejection of an entity. The id field in this payload refers to
the unique entityCode associated with the entity.

\n","_postman_id":"b81cc069-ca0f-4965-843c-0bbe2be28f0f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Number profile events","item":[{"name":"numberProfileApprovalEvent-Token","id":"4bad4fab-bf3e-4f21-bf0f-f2daa839dc7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.approved\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Profile Approved\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"5e9dc18b-2ad9-4e18-8dc3-6fcdd82bfceb","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.approved\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Profile Approved\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"4bad4fab-bf3e-4f21-bf0f-f2daa839dc7f"},{"name":"numberProfileApprovalEvent-Basic","id":"291d2629-f789-4b97-bb59-3c97194b7128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.approved\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Profile Approved\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"ab3fc818-033e-454d-b6b7-dd2894e8e11c","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.approved\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"Profile Approved\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"291d2629-f789-4b97-bb59-3c97194b7128"},{"name":"numberProfileRejectionEvent-Token","id":"422e0df4-539b-4b75-9cf5-c82d8a3a256d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.rejected\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Profile Rejected\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"98084f2a-3f68-471f-8a46-4735518df5ef","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.rejected\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Profile Rejected\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"422e0df4-539b-4b75-9cf5-c82d8a3a256d"},{"name":"numberProfileRejectionEvent-Basic","id":"ad769c19-73b5-4d08-9243-89bd62c1c552","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.rejected\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Profile Rejected\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"000ef70a-0df9-42de-a164-e80fd452a4bf","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"profile.rejected\",\r\n \"id\": \"NUME44f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"Profile Rejected\",\r\n \"timeStamp\": \"Mar 20 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"ad769c19-73b5-4d08-9243-89bd62c1c552"}],"id":"7948d1fc-4c96-48c5-9821-55e958bc0276","description":"

Number profile events:

These webhooks relate to the approval or rejection of a number profile. The id field in this payload
refers to the unique number profile id associated with the entity.

\n","_postman_id":"7948d1fc-4c96-48c5-9821-55e958bc0276","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Rich call data events","item":[{"name":"rcdApprovalEvent-Token","id":"bc833442-87dd-4412-a1d3-ca56e1e81ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.approved\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"RCD Approved\",\r\n \"timeStamp\": \"Mar 19 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"eec593fa-4773-4e82-97f4-9c8c5f1b55b8","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.approved\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"RCD Approved\",\r\n \"timeStamp\": \"Mar 19 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"bc833442-87dd-4412-a1d3-ca56e1e81ac4"},{"name":"rcdApprovalEvent-Basic","id":"fc7fc25d-e15a-40c3-be38-68518fa87fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.approved\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"RCD Approved\",\r\n \"timeStamp\": \"Mar 19 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"5b44776d-d31e-43ec-a35d-2cc9aeeaf3c9","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.approved\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"APPROVED\",\r\n \"action\": \"RCD Approved\",\r\n \"timeStamp\": \"Mar 19 2025 07:39:48 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"fc7fc25d-e15a-40c3-be38-68518fa87fe4"},{"name":"rcdRejectionEvent-Token","id":"168b77d7-ccc0-43e8-899e-21d7c0aaac38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.rejected\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"RCD Rejected\",\r\n \"timeStamp\": \"Mar 19 2025 07:51:37 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"669e1bc1-507b-4478-8879-db9cb53e81d8","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.rejected\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"RCD Rejected\",\r\n \"timeStamp\": \"Mar 19 2025 07:51:37 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"168b77d7-ccc0-43e8-899e-21d7c0aaac38"},{"name":"rcdRejectionEvent-Basic","id":"4f5584e5-7fbe-44e0-a608-d63b3474dfc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.rejected\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"RCD Rejected\",\r\n \"timeStamp\": \"Mar 19 2025 07:51:37 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x","urlObject":{"protocol":"https","path":["webhooks","mf16o624-1ymt5o168v-1t9pjsxz97x"],"host":["webhooks","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"652f682e-fd4d-4a5b-924f-3e895781c688","name":"200-OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"eventType\": \"rcd.rejected\",\r\n \"id\": \"e64344f49d3XXXXXXdd485225e703\",\r\n \"status\": \"REJECT\",\r\n \"action\": \"RCD Rejected\",\r\n \"timeStamp\": \"Mar 19 2025 07:51:37 am\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webhooks.numeracle.com/webhooks/mf16o624-1ymt5o168v-1t9pjsxz97x"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Webhook data received and stored successfully\",\r\n \"webhookId\": \"mf2g2ycz-b6ngf2gm2nj-2ogda5gyye\",\r\n \"dataId\": \"webhooks/mf2g2ycz-b6ngf2gm2nj-2ogda5gyye/data/1760596976006.json\",\r\n \"receivedAt\": \"2025-10-16T06:42:56.006Z\"\r\n}"}],"_postman_id":"4f5584e5-7fbe-44e0-a608-d63b3474dfc8"}],"id":"029cab78-7de7-495a-95d9-6707fe54434c","description":"

Rich call data events:

These webhooks relate to the approval or rejection of Rich call data (logo and/or one or more call
reasons). The id field in this payload refers to the unique number profile id associated with the entity.

\n","_postman_id":"029cab78-7de7-495a-95d9-6707fe54434c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"f149c1a8-3d4e-4c8b-8c83-b1f8876bf8a3","description":"

Introduction
This document provides a technical overview of the webhooks available for our API. Webhooks
enable your application to receive real-time notifications about key events, eliminating the need for
continuous polling.

Webhook Registration
To enable webhook notifications, you are required to register a secure callback URL with appropriate
authentication credentials. Supported authentication methods include either a username/password
pair or an API token.

Webhook event types
This document covers the following webhooks
* Entity approval
* Number profile approval
* Rich call data approval

These webhooks are categorized by the eventType field in the JSON payload, which corresponds to
the type of resource being modified.

Base URL :
Client needs to provide the URL.

Webhook parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
eventType	String	Indicates the type of resource being modified
id	String	Provides the entity code or the Number profile ID
status	String	The actual status
action	String	Message associated with the webhook
timestamp	String	Time stamp when the event occurred

Payload structure:

{
\"eventType\": \"string\",
\"id\": \"string\",
\"status\": \"string\",
\"action\": \"string\",
\"timeStamp\": \"string\"
}

Exception Handling and Retry Process

1. Failure Detection: The retry mechanism is activated when webhook delivery encounters any
of the following conditions:
• Delivery failure
• System exceptions
• HTTP response codes outside the 2xx range

2. Event Logging: Upon failure detection, the system generates two distinct log entries:
• Captures retry-specific information with retry status flag
• Records API monitoring data for system oversight

3. Automated Retry Logic: A scheduled background process executes every 15 minutes
to reattempt failed deliveries, allowing for a maximum of 3 delivery attempts per webhook.

4. Attempt Monitoring: The system maintains a retry counter that increments following each
delivery attempt.

5. Final Failure Resolution:
• Status Update: The webhook is permanently flagged as non-retriable, preventing any
additional delivery attempts

\n","_postman_id":"f149c1a8-3d4e-4c8b-8c83-b1f8876bf8a3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}},{"name":"Lookup","item":[{"name":"v1","item":[{"name":"List country codes","id":"6e74b1e3-2ca8-45b5-b43b-e5f8fe1f32f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/country-codes","description":"

Description

Returns all supported country codes from lookup_country (ISO alpha-2 code, display name, dial code).

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","country-codes"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"95064f9c-a1cc-428c-9d36-fa6f09d805e6","name":"200-Success","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/country-codes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jul 2026 08:39:48 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: 997418ae-0eec-443a-9e4d-a1cc5a94a0b5\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-06-15T12:00:00:00Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Country codes retrieved successfully.\",\n \"path\": \"/api/v1/country-codes\",\n \"data\": {\n \"countryCodes\": [\n {\n \"countryCode\": \"CA\",\n \"countryName\": \"Canada\",\n \"dialCode\": \"+1\"\n },\n {\n \"countryCode\": \"US\",\n \"countryName\": \"United States\",\n \"dialCode\": \"+1\"\n }\n ],\n \"totalCount\": 3\n },\n \"links\": {\n \"self\": \"/api/v1/country-codes\"\n }\n}"}],"_postman_id":"6e74b1e3-2ca8-45b5-b43b-e5f8fe1f32f9"},{"name":"List legal structures by country","id":"0de8dc64-8bb9-439a-bbf6-ff47c95332c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/country-codes/{countryCode}/legal-structures","description":"

Description

Returns legal structure values for entityBusinessDetails.legalStructure for the given ISO country code from lookup_legal_structure.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`countryCode`	String	Yes	ISO alpha-2 country code (case-insensitive)	US
`Name`	Type	Required	Description	Example
`sort`	String	No	Sort field: `legalStructure` or `legalStructureName`. Default: `legalStructureName`	legalStructure
`order`	String	No	Sort order: `asc` or `desc`. Default: `asc`	asc

Description

Returns subdivisions (states, provinces, regions, etc.) for the given ISO country code from lookup_state.

Path Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description	Example
`countryCode`	String	Yes	ISO alpha-2 country code (case-insensitive)	US
`Name`	Type	Required	Description	Example
`subdivisionType`	String	No	Filter by subdivision type (e.g. state, province)	STATE
`sort`	String	No	Sort field: `subdivisionCode`, `subdivisionName`, or `subdivisionType`. Default: `subdivisionName`	subdivisionCode
`order`	String	No	Sort order: `asc` or `desc`. Default: `asc`	asc

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","country-codes","{countryCode}","subdivisions"],"host":["www","sandbox","numeracle","com"],"query":[],"variable":[]}},"response":[{"id":"a57f7d32-51a8-4629-a777-ad1923e4550d","name":"List subdivisions by country","originalRequest":{"method":"GET","header":[],"url":"https://www.sandbox.numeracle.com/api/v1/country-codes/{countryCode}/subdivisions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jul 2026 08:46:32 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Bearer realm=\"oauth2-resource\", error=\"invalid_token\", error_description=\"Invalid access token: 997418ae-0eec-443a-9e4d-a1cc5a94a0b5\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"timestamp\": \"2026-07-23T17:11:40:40Z\",\n \"status\": \"SUCCESS\",\n \"message\": \"Subdivisions retrieved successfully.\",\n \"path\": \"/api/v1/country-codes/US/subdivisions\",\n \"data\": {\n \"countryCode\": \"US\",\n \"subdivisions\": [\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"AL\",\n \"subdivisionName\": \"Alabama\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"AK\",\n \"subdivisionName\": \"Alaska\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"AZ\",\n \"subdivisionName\": \"Arizona\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"AR\",\n \"subdivisionName\": \"Arkansas\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"CA\",\n \"subdivisionName\": \"California\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"CO\",\n \"subdivisionName\": \"Colorado\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"CT\",\n \"subdivisionName\": \"Connecticut\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"DE\",\n \"subdivisionName\": \"Delaware\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"DC\",\n \"subdivisionName\": \"District of Columbia\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"FL\",\n \"subdivisionName\": \"Florida\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"GA\",\n \"subdivisionName\": \"Georgia\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"HI\",\n \"subdivisionName\": \"Hawaii\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"ID\",\n \"subdivisionName\": \"Idaho\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"IL\",\n \"subdivisionName\": \"Illinois\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"IN\",\n \"subdivisionName\": \"Indiana\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"IA\",\n \"subdivisionName\": \"Iowa\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"KS\",\n \"subdivisionName\": \"Kansas\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"KY\",\n \"subdivisionName\": \"Kentucky\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"LA\",\n \"subdivisionName\": \"Louisiana\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"ME\",\n \"subdivisionName\": \"Maine\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MD\",\n \"subdivisionName\": \"Maryland\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MA\",\n \"subdivisionName\": \"Massachusetts\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MI\",\n \"subdivisionName\": \"Michigan\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MN\",\n \"subdivisionName\": \"Minnesota\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MS\",\n \"subdivisionName\": \"Mississippi\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MO\",\n \"subdivisionName\": \"Missouri\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"MT\",\n \"subdivisionName\": \"Montana\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NE\",\n \"subdivisionName\": \"Nebraska\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NV\",\n \"subdivisionName\": \"Nevada\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NH\",\n \"subdivisionName\": \"New Hampshire\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NJ\",\n \"subdivisionName\": \"New Jersey\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NM\",\n \"subdivisionName\": \"New Mexico\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NY\",\n \"subdivisionName\": \"New York\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"NC\",\n \"subdivisionName\": \"North Carolina\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"ND\",\n \"subdivisionName\": \"North Dakota\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"OH\",\n \"subdivisionName\": \"Ohio\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"OK\",\n \"subdivisionName\": \"Oklahoma\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"OR\",\n \"subdivisionName\": \"Oregon\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"PA\",\n \"subdivisionName\": \"Pennsylvania\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"PR\",\n \"subdivisionName\": \"Puerto Rico\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"RI\",\n \"subdivisionName\": \"Rhode Island\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"SC\",\n \"subdivisionName\": \"South Carolina\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"SD\",\n \"subdivisionName\": \"South Dakota\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"TN\",\n \"subdivisionName\": \"Tennessee\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"TX\",\n \"subdivisionName\": \"Texas\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"UT\",\n \"subdivisionName\": \"Utah\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"VT\",\n \"subdivisionName\": \"Vermont\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"VA\",\n \"subdivisionName\": \"Virginia\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"WA\",\n \"subdivisionName\": \"Washington\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"WV\",\n \"subdivisionName\": \"West Virginia\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"WI\",\n \"subdivisionName\": \"Wisconsin\"\n },\n {\n \"subdivisionType\": \"STATE\",\n \"subdivisionCode\": \"WY\",\n \"subdivisionName\": \"Wyoming\"\n }\n ],\n \"totalCount\": 52\n },\n \"links\": {\n \"self\": \"/api/v1/country-codes/US/subdivisions\"\n }\n}"}],"_postman_id":"33f93223-2752-4121-ab76-5d91308de4c4"}],"id":"36f2a987-b310-42d1-a126-01193df509e8","_postman_id":"36f2a987-b310-42d1-a126-01193df509e8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"id":"03bd8a33-0995-4642-ac68-31f49c6032ad","description":"

Introduction

Lookup APIs provide read-only reference data for countries, subdivisions, and legal structures. Use them to populate UI pickers and to validate ISO country codes used by Entity and Profile APIs (for example @SupportedCountry and address country fields).

All Lookup endpoints require a Bearer token (same OAuth 2.0 flow as Entity and Profile).

Summary of Lookup API Endpoints

List country codes
\n
Returns all supported ISO alpha-2 country codes with display names and dial codes. Optional sort (countryCode, countryName) and order (asc, desc).
\n
List subdivisions by country
\n
Returns states, provinces, or other subdivisions for a given country code. Optional subdivisionType filter and sort / order parameters.
\n
List legal structures by country
\n
Returns allowed entityBusinessDetails.legalStructure values for a given country code from lookup_legal_structure. Optional sort (legalStructure, legalStructureName) and order (asc, desc).
\n

\n\n

Entity and Profile write APIs reference /v1/country-codes when validating country fields. After choosing a country, use subdivisions to resolve state/province codes for addresses and legal structures to populate business-info legal structure pickers.

\n","_postman_id":"03bd8a33-0995-4642-ac68-31f49c6032ad","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","id":"a79650fb-9fe5-4f2c-884b-2774aa554ec0","name":"Numeracle API-V1.0.0-Number Reputation Management","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"9b01a657-7a3b-4a9c-978c-a4c3cceca65a"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"bbc54f0a-bf61-4509-a61a-d1524e0c23a0"}}],"variable":[{"key":"https://dev2-eim.numeracle.com/","value":""},{"key":"intent","value":""}]}