API Route - Customer
API endpoints
[POST] Create a customer
Details
This API enpoint allows you to create a customer.
API endpoint :
/api/v1/customers?customerType={customerType}
Parameter request :
{
"Customer": {
"CustomerName": "string",
"CustomerStatus": "1",
"CustomerNumber": "string",
"ExternalCustomerNumber": "string",
"CustomerType": "1,2,3",
"CustomerSubType": "1",
"CustomerCategory": "301",
"InsuredSince": "2023-02-22T15:22:40.1143343Z",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyCompany": {
"CompanyInformation": {
"EntityNameName": "string",
"BusinessType": "1",
"TaxIDFEIN": "string",
"ExternalIdentifier": "string",
"IdentifierType": "1,2",
"CompanyPhone": "string",
"CompanyFax": "string",
"CompanyEmail": "string",
"SizeParameter": "1,2,3",
"Size": 0,
"NumberofEmployees": "1",
"Website": "string",
"Description": "string",
"RestrictedCustomer": true,
"EntityNationalProviderIdentifier": "string",
"SendDigitalCommunications": true,
"SendPaperCommunications": true
},
"MailingAddress": {
"MailingAddressLine1": "string",
"MailingAddressLine2": "string",
"MailingCity": "string",
"MailingCountry": "1",
"MailingPostalCode": "string",
"MailingState": "1"
},
"PhysicalAddress": {
"PhysicalAddressLine1": "string",
"PhysicalAddressLine2": "string",
"PhysicalCity": "string",
"PhysicalCountry": "1",
"PhysicalPostalCode": "string",
"PhysicalState": "1"
},
"Contact": {
"KeyContact": true,
"TitleFunction": "1",
"Title": "1",
"ContactFirstName": "string",
"ContactLastName": "string",
"MainContactSuffix": "1901",
"WorkPhone": "string",
"HomePhone": "string",
"CellPhone": "string",
"AlternatePhone": "string",
"Fax": "string",
"Email": "string",
"ContactMailingAddressLine1": "string",
"ContactMailingAddressLine2": "string",
"ContactMailingCity": "string",
"ContactMailingCountry": "1",
"ContactMailingStateProvince": "1",
"ContactMailingZipCode": "string",
"ContactPhysicalAddressLine1": "string",
"ContactPhysicalAddressLine2": "string",
"ContactPhysicalCity": "string",
"ContactPhysicalCountry": "1",
"ContactPhysicalStateProvince": "1",
"ContactPhysicalZipCode": "string"
},
"ListOfAdditionalContacts": [
{
"AddContactFirstName": "string",
"AddContactLastName": "string",
"AddContactSuffix": "1901",
"ContactType": "4",
"AdditionalContactEmail": "string"
}
]
},
"MyPerson": {
"MyPersonalCustomer": {
"PersonTitle": "1",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"SocialSecurityNumber": "string",
"NationalProviderIdentifier": "string",
"PersonWorkPhone": "string",
"PersonHomePhone": "string",
"PersonCellPhone": "string",
"PersonFax": "string",
"PersonEmail": "string",
"PersonAlternateEmail": "string",
"Gender": "1",
"DateofBirth": "2023-02-22T15:22:40.1455879Z",
"DateofDeath": "2023-02-22T15:22:40.1455879Z",
"Suffix": "1901",
"PersonWebsite": "string"
},
"PersonalMailingAddress": {
"PersonalMailingAddressLine1": "string",
"PersonalMailingAddressLine2": "string",
"PersonalMailingPostalCode": "string",
"PersonalMailingCity": "string",
"PersonalMailingState": "1",
"PersonalMailingCountry": "1"
},
"PersonalPhysicalAddress": {
"PersonalPhysicalAddressLine1": "string",
"PersonalPhysicalAddressLine2": "string",
"PersonalPhysicalPostalCode": "string",
"PersonalPhysicalCity": "string",
"PersonalPhysicalState": "1",
"PersonalPhysicalCountry": "1"
},
"Background": {
"PersonalCustomer-InstitutionName": "string",
"PersonalCustomer-InstitutionStartDate": "2023-02-22T15:22:40.1612157Z",
"PersonalCustomer-InstitutionEndDate": "2023-02-22T15:22:40.1612157Z",
"PersonalCustomer-InstitutionState": "1",
"PersonalCustomer-InstitutionCountry": "1",
"PersonalCustomer-InstitutionCountryOther": "string",
"PersonalCustomer-InstitutionDegree": "1901"
},
"ListofPredefinedPaymentInformation": [
{
"PaymentInformationUsage": "1,2,3",
"PaymentType": "1",
"Name": "string",
"CardNumber": "string",
"CardExpirationMonth": "1",
"CardExpirationYear": "string",
"PaymentInformationExternalIdentifier": "string",
"RoutingNumber": "string",
"AccountNumber": "string",
"AccountType": "1,2",
"CardHolderName": "string",
"DefaultPaymentInformation": true,
"IsInvalidPaymentInformation": true,
"ID": "string",
"FunctionalIdentifierForWebAPI": "string"
}
]
},
"ListofSubsidiaries": [
{
"HealthcareEntityCustomerName": "string",
"IndividualProviderCustomerName": "string",
"HealthcareEntityCustomerNumber": "string",
"IndividualProviderCustomerNumber": "string"
}
],
"ListofIndividualProviderCustomerLicenses": [
{
"LicenseType": "1901",
"LicenseNumber": "string"
}
]
}
}
Json response :
{
"Customer": {
"CustomerName": "string",
"CustomerStatus": "1",
"CustomerNumber": "string",
"ExternalCustomerNumber": "string",
"IsInModification": true,
"CustomerType": "1,2,3",
"CustomerSubType": "1",
"CustomerCategory": "301",
"InsuredSince": "2023-02-22T15:22:40.1924657Z",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyCompany": {
"CompanyInformation": {
"EntityNameName": "string",
"BusinessType": "1",
"TaxIDFEIN": "string",
"ExternalIdentifier": "string",
"IdentifierType": "1,2",
"CompanyPhone": "string",
"CompanyFax": "string",
"CompanyEmail": "string",
"SizeParameter": "1,2,3",
"Size": 0,
"NumberofEmployees": "1",
"Website": "string",
"Description": "string",
"RestrictedCustomer": true,
"EntityNationalProviderIdentifier": "string",
"SendDigitalCommunications": true,
"SendPaperCommunications": true
},
"MailingAddress": {
"MailingAddressLine1": "string",
"MailingAddressLine2": "string",
"MailingCity": "string",
"MailingCountry": "1",
"MailingPostalCode": "string",
"MailingState": "1"
},
"PhysicalAddress": {
"PhysicalAddressLine1": "string",
"PhysicalAddressLine2": "string",
"PhysicalCity": "string",
"PhysicalCountry": "1",
"PhysicalPostalCode": "string",
"PhysicalState": "1"
},
"Contact": {
"KeyContact": true,
"TitleFunction": "1",
"Title": "1",
"ContactFirstName": "string",
"ContactLastName": "string",
"MainContactSuffix": "1901",
"WorkPhone": "string",
"HomePhone": "string",
"CellPhone": "string",
"AlternatePhone": "string",
"Fax": "string",
"Email": "string",
"ContactMailingAddressLine1": "string",
"ContactMailingAddressLine2": "string",
"ContactMailingCity": "string",
"ContactMailingCountry": "1",
"ContactMailingStateProvince": "1",
"ContactMailingZipCode": "string",
"ContactPhysicalAddressLine1": "string",
"ContactPhysicalAddressLine2": "string",
"ContactPhysicalCity": "string",
"ContactPhysicalCountry": "1",
"ContactPhysicalStateProvince": "1",
"ContactPhysicalZipCode": "string"
},
"ListOfAdditionalContacts": [
{
"AddContactFirstName": "string",
"AddContactLastName": "string",
"AddContactSuffix": "1901",
"ContactType": "4",
"AdditionalContactEmail": "string"
}
]
},
"MyPerson": {
"MyPersonalCustomer": {
"PersonTitle": "1",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"SocialSecurityNumber": "string",
"NationalProviderIdentifier": "string",
"PersonWorkPhone": "string",
"PersonHomePhone": "string",
"PersonCellPhone": "string",
"PersonFax": "string",
"PersonEmail": "string",
"PersonAlternateEmail": "string",
"Gender": "1",
"DateofBirth": "2023-02-22T15:22:40.1924657Z",
"DateofDeath": "2023-02-22T15:22:40.1924657Z",
"Suffix": "1901",
"PersonWebsite": "string"
},
"PersonalMailingAddress": {
"PersonalMailingAddressLine1": "string",
"PersonalMailingAddressLine2": "string",
"PersonalMailingPostalCode": "string",
"PersonalMailingCity": "string",
"PersonalMailingState": "1",
"PersonalMailingCountry": "1"
},
"PersonalPhysicalAddress": {
"PersonalPhysicalAddressLine1": "string",
"PersonalPhysicalAddressLine2": "string",
"PersonalPhysicalPostalCode": "string",
"PersonalPhysicalCity": "string",
"PersonalPhysicalState": "1",
"PersonalPhysicalCountry": "1"
},
"Background": {
"PersonalCustomer-InstitutionName": "string",
"PersonalCustomer-InstitutionStartDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionEndDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionState": "1",
"PersonalCustomer-InstitutionCountry": "1",
"PersonalCustomer-InstitutionCountryOther": "string",
"PersonalCustomer-InstitutionDegree": "1901"
},
"ListofPredefinedPaymentInformation": [
{
"PaymentInformationUsage": "1,2,3",
"PaymentType": "1",
"Name": "string",
"CardNumber": "string",
"CardExpirationMonth": "1",
"CardExpirationYear": "string",
"PaymentInformationExternalIdentifier": "string",
"RoutingNumber": "string",
"AccountNumber": "string",
"AccountType": "1,2",
"CardHolderName": "string",
"DefaultPaymentInformation": true,
"IsInvalidPaymentInformation": true,
"ID": "string",
"FunctionalIdentifierForWebAPI": "string"
}
]
},
"ListofSubsidiaries": [
{
"HealthcareEntityCustomerName": "string",
"IndividualProviderCustomerName": "string",
"HealthcareEntityCustomerNumber": "string",
"IndividualProviderCustomerNumber": "string"
}
],
"ListofIndividualProviderCustomerLicenses": [
{
"LicenseType": "1901",
"LicenseNumber": "string"
}
]
}
}
[GET] Get a customer
Details
This API enpoint gets customer details using the customer number.
API endpoint :
/api/v1/customers/{customerNumber}?customerType={customerType}
Json response :
{
"Customer": {
"CustomerName": "string",
"CustomerStatus": "1",
"CustomerNumber": "string",
"ExternalCustomerNumber": "string",
"IsInModification": true,
"CustomerType": "1,2,3",
"CustomerSubType": "1",
"CustomerCategory": "301",
"InsuredSince": "2023-02-22T15:22:40.1924657Z",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyCompany": {
"CompanyInformation": {
"EntityNameName": "string",
"BusinessType": "1",
"TaxIDFEIN": "string",
"ExternalIdentifier": "string",
"IdentifierType": "1,2",
"CompanyPhone": "string",
"CompanyFax": "string",
"CompanyEmail": "string",
"SizeParameter": "1,2,3",
"Size": 0,
"NumberofEmployees": "1",
"Website": "string",
"Description": "string",
"RestrictedCustomer": true,
"EntityNationalProviderIdentifier": "string",
"SendDigitalCommunications": true,
"SendPaperCommunications": true
},
"MailingAddress": {
"MailingAddressLine1": "string",
"MailingAddressLine2": "string",
"MailingCity": "string",
"MailingCountry": "1",
"MailingPostalCode": "string",
"MailingState": "1"
},
"PhysicalAddress": {
"PhysicalAddressLine1": "string",
"PhysicalAddressLine2": "string",
"PhysicalCity": "string",
"PhysicalCountry": "1",
"PhysicalPostalCode": "string",
"PhysicalState": "1"
},
"Contact": {
"KeyContact": true,
"TitleFunction": "1",
"Title": "1",
"ContactFirstName": "string",
"ContactLastName": "string",
"MainContactSuffix": "1901",
"WorkPhone": "string",
"HomePhone": "string",
"CellPhone": "string",
"AlternatePhone": "string",
"Fax": "string",
"Email": "string",
"ContactMailingAddressLine1": "string",
"ContactMailingAddressLine2": "string",
"ContactMailingCity": "string",
"ContactMailingCountry": "1",
"ContactMailingStateProvince": "1",
"ContactMailingZipCode": "string",
"ContactPhysicalAddressLine1": "string",
"ContactPhysicalAddressLine2": "string",
"ContactPhysicalCity": "string",
"ContactPhysicalCountry": "1",
"ContactPhysicalStateProvince": "1",
"ContactPhysicalZipCode": "string"
},
"ListOfAdditionalContacts": [
{
"AddContactFirstName": "string",
"AddContactLastName": "string",
"AddContactSuffix": "1901",
"ContactType": "4",
"AdditionalContactEmail": "string"
}
]
},
"MyPerson": {
"MyPersonalCustomer": {
"PersonTitle": "1",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"SocialSecurityNumber": "string",
"NationalProviderIdentifier": "string",
"PersonWorkPhone": "string",
"PersonHomePhone": "string",
"PersonCellPhone": "string",
"PersonFax": "string",
"PersonEmail": "string",
"PersonAlternateEmail": "string",
"Gender": "1",
"DateofBirth": "2023-02-22T15:22:40.1924657Z",
"DateofDeath": "2023-02-22T15:22:40.1924657Z",
"Suffix": "1901",
"PersonWebsite": "string"
},
"PersonalMailingAddress": {
"PersonalMailingAddressLine1": "string",
"PersonalMailingAddressLine2": "string",
"PersonalMailingPostalCode": "string",
"PersonalMailingCity": "string",
"PersonalMailingState": "1",
"PersonalMailingCountry": "1"
},
"PersonalPhysicalAddress": {
"PersonalPhysicalAddressLine1": "string",
"PersonalPhysicalAddressLine2": "string",
"PersonalPhysicalPostalCode": "string",
"PersonalPhysicalCity": "string",
"PersonalPhysicalState": "1",
"PersonalPhysicalCountry": "1"
},
"Background": {
"PersonalCustomer-InstitutionName": "string",
"PersonalCustomer-InstitutionStartDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionEndDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionState": "1",
"PersonalCustomer-InstitutionCountry": "1",
"PersonalCustomer-InstitutionCountryOther": "string",
"PersonalCustomer-InstitutionDegree": "1901"
},
"ListofPredefinedPaymentInformation": [
{
"PaymentInformationUsage": "1,2,3",
"PaymentType": "1",
"Name": "string",
"CardNumber": "string",
"CardExpirationMonth": "1",
"CardExpirationYear": "string",
"PaymentInformationExternalIdentifier": "string",
"RoutingNumber": "string",
"AccountNumber": "string",
"AccountType": "1,2",
"CardHolderName": "string",
"DefaultPaymentInformation": true,
"IsInvalidPaymentInformation": true,
"ID": "string",
"FunctionalIdentifierForWebAPI": "string"
}
]
},
"ListofSubsidiaries": [
{
"HealthcareEntityCustomerName": "string",
"IndividualProviderCustomerName": "string",
"HealthcareEntityCustomerNumber": "string",
"IndividualProviderCustomerNumber": "string"
}
],
"ListofIndividualProviderCustomerLicenses": [
{
"LicenseType": "1901",
"LicenseNumber": "string"
}
]
}
}
[POST] Update a customer
Details
This API endpoint updates a customer.
API endpoint :
/api/v1/customers/{customerNumber}?customerType={customerType}
Parameter request :
{
"Customer": {
"CustomerName": "string",
"CustomerStatus": "1",
"CustomerNumber": "string",
"ExternalCustomerNumber": "string",
"CustomerType": "1,2,3",
"CustomerSubType": "1",
"CustomerCategory": "301",
"InsuredSince": "2023-02-22T15:22:40.1143343Z",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyCompany": {
"CompanyInformation": {
"EntityNameName": "string",
"BusinessType": "1",
"TaxIDFEIN": "string",
"ExternalIdentifier": "string",
"IdentifierType": "1,2",
"CompanyPhone": "string",
"CompanyFax": "string",
"CompanyEmail": "string",
"SizeParameter": "1,2,3",
"Size": 0,
"NumberofEmployees": "1",
"Website": "string",
"Description": "string",
"RestrictedCustomer": true,
"EntityNationalProviderIdentifier": "string",
"SendDigitalCommunications": true,
"SendPaperCommunications": true
},
"MailingAddress": {
"MailingAddressLine1": "string",
"MailingAddressLine2": "string",
"MailingCity": "string",
"MailingCountry": "1",
"MailingPostalCode": "string",
"MailingState": "1"
},
"PhysicalAddress": {
"PhysicalAddressLine1": "string",
"PhysicalAddressLine2": "string",
"PhysicalCity": "string",
"PhysicalCountry": "1",
"PhysicalPostalCode": "string",
"PhysicalState": "1"
},
"Contact": {
"KeyContact": true,
"TitleFunction": "1",
"Title": "1",
"ContactFirstName": "string",
"ContactLastName": "string",
"MainContactSuffix": "1901",
"WorkPhone": "string",
"HomePhone": "string",
"CellPhone": "string",
"AlternatePhone": "string",
"Fax": "string",
"Email": "string",
"ContactMailingAddressLine1": "string",
"ContactMailingAddressLine2": "string",
"ContactMailingCity": "string",
"ContactMailingCountry": "1",
"ContactMailingStateProvince": "1",
"ContactMailingZipCode": "string",
"ContactPhysicalAddressLine1": "string",
"ContactPhysicalAddressLine2": "string",
"ContactPhysicalCity": "string",
"ContactPhysicalCountry": "1",
"ContactPhysicalStateProvince": "1",
"ContactPhysicalZipCode": "string"
},
"ListOfAdditionalContacts": [
{
"AddContactFirstName": "string",
"AddContactLastName": "string",
"AddContactSuffix": "1901",
"ContactType": "4",
"AdditionalContactEmail": "string"
}
]
},
"MyPerson": {
"MyPersonalCustomer": {
"PersonTitle": "1",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"SocialSecurityNumber": "string",
"NationalProviderIdentifier": "string",
"PersonWorkPhone": "string",
"PersonHomePhone": "string",
"PersonCellPhone": "string",
"PersonFax": "string",
"PersonEmail": "string",
"PersonAlternateEmail": "string",
"Gender": "1",
"DateofBirth": "2023-02-22T15:22:40.1455879Z",
"DateofDeath": "2023-02-22T15:22:40.1455879Z",
"Suffix": "1901",
"PersonWebsite": "string"
},
"PersonalMailingAddress": {
"PersonalMailingAddressLine1": "string",
"PersonalMailingAddressLine2": "string",
"PersonalMailingPostalCode": "string",
"PersonalMailingCity": "string",
"PersonalMailingState": "1",
"PersonalMailingCountry": "1"
},
"PersonalPhysicalAddress": {
"PersonalPhysicalAddressLine1": "string",
"PersonalPhysicalAddressLine2": "string",
"PersonalPhysicalPostalCode": "string",
"PersonalPhysicalCity": "string",
"PersonalPhysicalState": "1",
"PersonalPhysicalCountry": "1"
},
"Background": {
"PersonalCustomer-InstitutionName": "string",
"PersonalCustomer-InstitutionStartDate": "2023-02-22T15:22:40.1612157Z",
"PersonalCustomer-InstitutionEndDate": "2023-02-22T15:22:40.1612157Z",
"PersonalCustomer-InstitutionState": "1",
"PersonalCustomer-InstitutionCountry": "1",
"PersonalCustomer-InstitutionCountryOther": "string",
"PersonalCustomer-InstitutionDegree": "1901"
},
"ListofPredefinedPaymentInformation": [
{
"PaymentInformationUsage": "1,2,3",
"PaymentType": "1",
"Name": "string",
"CardNumber": "string",
"CardExpirationMonth": "1",
"CardExpirationYear": "string",
"PaymentInformationExternalIdentifier": "string",
"RoutingNumber": "string",
"AccountNumber": "string",
"AccountType": "1,2",
"CardHolderName": "string",
"DefaultPaymentInformation": true,
"IsInvalidPaymentInformation": true,
"ID": "string",
"FunctionalIdentifierForWebAPI": "string"
}
]
},
"ListofSubsidiaries": [
{
"HealthcareEntityCustomerName": "string",
"IndividualProviderCustomerName": "string",
"HealthcareEntityCustomerNumber": "string",
"IndividualProviderCustomerNumber": "string"
}
],
"ListofIndividualProviderCustomerLicenses": [
{
"LicenseType": "1901",
"LicenseNumber": "string"
}
]
}
}
Json response :
{
"Customer": {
"CustomerName": "string",
"CustomerStatus": "1",
"CustomerNumber": "string",
"ExternalCustomerNumber": "string",
"IsInModification": true,
"CustomerType": "1,2,3",
"CustomerSubType": "1",
"CustomerCategory": "301",
"InsuredSince": "2023-02-22T15:22:40.1924657Z",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyCompany": {
"CompanyInformation": {
"EntityNameName": "string",
"BusinessType": "1",
"TaxIDFEIN": "string",
"ExternalIdentifier": "string",
"IdentifierType": "1,2",
"CompanyPhone": "string",
"CompanyFax": "string",
"CompanyEmail": "string",
"SizeParameter": "1,2,3",
"Size": 0,
"NumberofEmployees": "1",
"Website": "string",
"Description": "string",
"RestrictedCustomer": true,
"EntityNationalProviderIdentifier": "string",
"SendDigitalCommunications": true,
"SendPaperCommunications": true
},
"MailingAddress": {
"MailingAddressLine1": "string",
"MailingAddressLine2": "string",
"MailingCity": "string",
"MailingCountry": "1",
"MailingPostalCode": "string",
"MailingState": "1"
},
"PhysicalAddress": {
"PhysicalAddressLine1": "string",
"PhysicalAddressLine2": "string",
"PhysicalCity": "string",
"PhysicalCountry": "1",
"PhysicalPostalCode": "string",
"PhysicalState": "1"
},
"Contact": {
"KeyContact": true,
"TitleFunction": "1",
"Title": "1",
"ContactFirstName": "string",
"ContactLastName": "string",
"MainContactSuffix": "1901",
"WorkPhone": "string",
"HomePhone": "string",
"CellPhone": "string",
"AlternatePhone": "string",
"Fax": "string",
"Email": "string",
"ContactMailingAddressLine1": "string",
"ContactMailingAddressLine2": "string",
"ContactMailingCity": "string",
"ContactMailingCountry": "1",
"ContactMailingStateProvince": "1",
"ContactMailingZipCode": "string",
"ContactPhysicalAddressLine1": "string",
"ContactPhysicalAddressLine2": "string",
"ContactPhysicalCity": "string",
"ContactPhysicalCountry": "1",
"ContactPhysicalStateProvince": "1",
"ContactPhysicalZipCode": "string"
},
"ListOfAdditionalContacts": [
{
"AddContactFirstName": "string",
"AddContactLastName": "string",
"AddContactSuffix": "1901",
"ContactType": "4",
"AdditionalContactEmail": "string"
}
]
},
"MyPerson": {
"MyPersonalCustomer": {
"PersonTitle": "1",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"SocialSecurityNumber": "string",
"NationalProviderIdentifier": "string",
"PersonWorkPhone": "string",
"PersonHomePhone": "string",
"PersonCellPhone": "string",
"PersonFax": "string",
"PersonEmail": "string",
"PersonAlternateEmail": "string",
"Gender": "1",
"DateofBirth": "2023-02-22T15:22:40.1924657Z",
"DateofDeath": "2023-02-22T15:22:40.1924657Z",
"Suffix": "1901",
"PersonWebsite": "string"
},
"PersonalMailingAddress": {
"PersonalMailingAddressLine1": "string",
"PersonalMailingAddressLine2": "string",
"PersonalMailingPostalCode": "string",
"PersonalMailingCity": "string",
"PersonalMailingState": "1",
"PersonalMailingCountry": "1"
},
"PersonalPhysicalAddress": {
"PersonalPhysicalAddressLine1": "string",
"PersonalPhysicalAddressLine2": "string",
"PersonalPhysicalPostalCode": "string",
"PersonalPhysicalCity": "string",
"PersonalPhysicalState": "1",
"PersonalPhysicalCountry": "1"
},
"Background": {
"PersonalCustomer-InstitutionName": "string",
"PersonalCustomer-InstitutionStartDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionEndDate": "2023-02-22T15:22:40.1924657Z",
"PersonalCustomer-InstitutionState": "1",
"PersonalCustomer-InstitutionCountry": "1",
"PersonalCustomer-InstitutionCountryOther": "string",
"PersonalCustomer-InstitutionDegree": "1901"
},
"ListofPredefinedPaymentInformation": [
{
"PaymentInformationUsage": "1,2,3",
"PaymentType": "1",
"Name": "string",
"CardNumber": "string",
"CardExpirationMonth": "1",
"CardExpirationYear": "string",
"PaymentInformationExternalIdentifier": "string",
"RoutingNumber": "string",
"AccountNumber": "string",
"AccountType": "1,2",
"CardHolderName": "string",
"DefaultPaymentInformation": true,
"IsInvalidPaymentInformation": true,
"ID": "string",
"FunctionalIdentifierForWebAPI": "string"
}
]
},
"ListofSubsidiaries": [
{
"HealthcareEntityCustomerName": "string",
"IndividualProviderCustomerName": "string",
"HealthcareEntityCustomerNumber": "string",
"IndividualProviderCustomerNumber": "string"
}
],
"ListofIndividualProviderCustomerLicenses": [
{
"LicenseType": "1901",
"LicenseNumber": "string"
}
]
}
}
[GET] Get external user declared in Sunlight Enterprise
Details
This API enpoint gets a specific Xtend user information based on the provided guidUser or emailUser.
API endpoint :
/api/v1/externalportal/users?guidUser={guid}&emailUser={email}
Json response :
{
"XtendPortalUser": {
"UserEmail": "string",
"MyCustomer": {
"CustomerNumber": "string",
"CustomerName": "string",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyPerson": {
"MyPersonalCustomer": {
"FirstName": "string",
"LastName": "string",
"PersonCellPhone": "string",
"PersonEmail": "string",
"MyPhysicalAddress": {
"PersonPhysicalAddressLine1": "string",
"PersonPhysicalAddressLine2": "string",
"PersonPhysicalCity": "string",
"PersonPhysicalState": "1",
"PersonPhysicalCountry": "1",
"PersonPhysicalPostalCode": "string"
}
}
}
}
}
}
[POST] Declare an Xtend user in Sunlight
Details
This API enpoint creates an Xtend user based on the body payload provided.
API endpoint :
/api/v1/externalportal/users
Parameter request :
{
"XtendPortalUser": {
"UserEmail": "string",
"MyCustomer": {
"FunctionalIdentifier": "string"
}
}
}
Json response :
{
"XtendPortalUser": {
"UserEmail": "string",
"MyCustomer": {
"CustomerNumber": "string",
"CustomerName": "string",
"CustomerPaymentInformationExternalIdentifier": "string",
"MyPerson": {
"MyPersonalCustomer": {
"FirstName": "string",
"LastName": "string",
"PersonCellPhone": "string",
"PersonEmail": "string",
"MyPhysicalAddress": {
"PersonPhysicalAddressLine1": "string",
"PersonPhysicalAddressLine2": "string",
"PersonPhysicalCity": "string",
"PersonPhysicalState": "1",
"PersonPhysicalCountry": "1",
"PersonPhysicalPostalCode": "string"
}
}
}
}
}
}