Show Menu

Advanced Profile Status

Company Advanced Profiles Status

This API call is used to get the status of the remitter application using company advanced profile. The status would be one of these Submitted, Pending or Approved.

post/API/v4/Register/CompanyAdvancedProfileStatus

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

FromAccountNumberstring

String length: inclusive between 1 and 25. Can be Issuer account number(SPNXXX) or Beneficiary company account number (SPNXXX)

Reponse Parameters

AdvancedProfileStatusResultstring

Returned if successful beneficiary found.

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Register/CompanyAdvancedProfileStatus

    {
    }
						

Sample Response:


{
	"AdvancedProfileStatusResponse": {
		"AdvancedProfileStatusResult": {
			"BeneficiaryID": "SPN17126699",
			"Message": "Submitted/Pending/Approved",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}