rename ADDRESS to POSTAL_ADDRESS (#231)

Author: shreyav

docusaurus-docs/docs/platform-configuration.md

@@ -172,12 +172,20 @@ Available counterparty fields (to be specified with a `name` and `mandatory` fla
 |---------------------------------------|-------------|
 | `FULL_NAME` | Full legal name of the individual or business |
 | `BIRTH_DATE` | Date of birth in YYYY-MM-DD format (for individuals) |
-| `NATIONALITY` | Nationality of the individual |
-| `ADDRESS` | Physical address including country, city, etc. |
-| `PHONE_NUMBER` | Contact phone number including country code |
+| `NATIONALITY` | Nationality of the individual (ISO 3166-1 alpha-2 code) |
+| `COUNTRY_OF_RESIDENCE` | The individual's country of residence (ISO 3166-1 alpha-2 code) |
+| `POSTAL_ADDRESS` | Physical address in the following format `{"line1":"123 Main St", "line2":"Apt 4B", "city":"Los Angeles", "state":"CA", "postalCode":"94105", "country":"US"}` |
+| `PHONE_NUMBER` | Contact phone number (E.164 international format) |
 | `EMAIL` | Email address |
+| `USER_TYPE` | `INDIVIDUAL` or `BUSINESS` |
 | `BUSINESS_NAME` | Legal business name (for business entities) |
+| `REGISTRATION_NUMBER` | Business registration number |
 | `TAX_ID` | Tax identification number |
+| `ACCOUNT_IDENTIFIER` | Stable id identifying the UMA account |
+| `FI_LEGAL_ENTITY_NAME` | Legal entity name of the FI participating in the UMA settlement |
+| `FI_ADDRESS` | Address of the FI participating in the UMA settlement |
+| `PURPOSE_OF_PAYMENT` | One of the following: `GIFT`, `SELF`, `GOODS_OR_SERVICES`, `EDUCATION`, `HEALTH_OR_MEDICAL`, `REAL_ESTATE_PURCHASE`, `LOAN_PAYMENT`, `TAX_PAYMENT`, `UTILITY_BILL`, `DONATION`, `TRAVEL`, `OTHER` |
+| `ULTIMATE_INSTITUTION_COUNTRY` | The country of the ultimate institution from which the UMA participant sends/receives funds (ISO 3166-1 alpha-2 code) |
 
 Each field in `requiredCounterpartyFields` is an object containing:
 

generated/api-docs.md

@@ -253,7 +253,7 @@ Update the platform configuration settings
 |»»» name|NATIONALITY|
 |»»» name|PHONE_NUMBER|
 |»»» name|EMAIL|
-|»»» name|ADDRESS|
+|»»» name|POSTAL_ADDRESS|
 |»»» name|TAX_ID|
 |»»» name|REGISTRATION_NUMBER|
 |»»» name|ACCOUNT_NUMBER|
@@ -263,7 +263,7 @@ Update the platform configuration settings
 |»» umaProviderRequiredUserFields|NATIONALITY|
 |»» umaProviderRequiredUserFields|PHONE_NUMBER|
 |»» umaProviderRequiredUserFields|EMAIL|
-|»» umaProviderRequiredUserFields|ADDRESS|
+|»» umaProviderRequiredUserFields|POSTAL_ADDRESS|
 |»» umaProviderRequiredUserFields|TAX_ID|
 |»» umaProviderRequiredUserFields|REGISTRATION_NUMBER|
 |»» umaProviderRequiredUserFields|ACCOUNT_NUMBER|
@@ -2144,7 +2144,7 @@ Status Code **200**
 |name|NATIONALITY|
 |name|PHONE_NUMBER|
 |name|EMAIL|
-|name|ADDRESS|
+|name|POSTAL_ADDRESS|
 |name|TAX_ID|
 |name|REGISTRATION_NUMBER|
 |name|ACCOUNT_NUMBER|
@@ -4504,7 +4504,7 @@ Name of a type of field containing info about a platform's user or counterparty
 |*anonymous*|NATIONALITY|
 |*anonymous*|PHONE_NUMBER|
 |*anonymous*|EMAIL|
-|*anonymous*|ADDRESS|
+|*anonymous*|POSTAL_ADDRESS|
 |*anonymous*|TAX_ID|
 |*anonymous*|REGISTRATION_NUMBER|
 |*anonymous*|ACCOUNT_NUMBER|

mintlify/openapi.yaml

@@ -81,7 +81,7 @@ Request body:
           "mandatory": true
         },
         {
-          "name": "ADDRESS",
+          "name": "POSTAL_ADDRESS",
           "mandatory": false
         }
       ]
@@ -112,7 +112,7 @@ Response:
           "mandatory": true
         },
         {
-          "name": "ADDRESS",
+          "name": "POSTAL_ADDRESS",
           "mandatory": false
         }
       ],
@@ -173,12 +173,20 @@ Available counterparty fields (to be specified with a `name` and `mandatory` fla
 |---------------------------------------|-------------|
 | `FULL_NAME` | Full legal name of the individual or business |
 | `BIRTH_DATE` | Date of birth in YYYY-MM-DD format (for individuals) |
-| `NATIONALITY` | Nationality of the individual |
-| `ADDRESS` | Physical address including country, city, etc. |
-| `PHONE_NUMBER` | Contact phone number including country code |
+| `NATIONALITY` | Nationality of the individual (ISO 3166-1 alpha-2 code) |
+| `COUNTRY_OF_RESIDENCE` | The individual's country of residence (ISO 3166-1 alpha-2 code) |
+| `POSTAL_ADDRESS` | Physical address in the following format `{"line1":"123 Main St", "line2":"Apt 4B", "city":"SF", "state":"CA", "postalCode":"94105", "country":"US"}` |
+| `PHONE_NUMBER` | Contact phone number (E.164 international format) |
 | `EMAIL` | Email address |
+| `USER_TYPE` | `INDIVIDUAL` or `BUSINESS` |
 | `BUSINESS_NAME` | Legal business name (for business entities) |
+| `REGISTRATION_NUMBER` | Business registration number |
 | `TAX_ID` | Tax identification number |
+| `ACCOUNT_IDENTIFIER` | Stable id identifying the UMA account |
+| `FI_LEGAL_ENTITY_NAME` | Legal entity name of the FI participating in the UMA settlement |
+| `FI_ADDRESS` | Address of the FI participating in the UMA settlement |
+| `PURPOSE_OF_PAYMENT` | One of the following: `GIFT`, `SELF`, `GOODS_OR_SERVICES`, `EDUCATION`, `HEALTH_OR_MEDICAL`, `REAL_ESTATE_PURCHASE`, `LOAN_PAYMENT`, `TAX_PAYMENT`, `UTILITY_BILL`, `DONATION`, `TRAVEL`, `OTHER` |
+| `ULTIMATE_INSTITUTION_COUNTRY` | The country of the ultimate institution from which the UMA participant sends/receives funds (ISO 3166-1 alpha-2 code) |
 
 Each field in `requiredCounterpartyFields` is an object containing:
 

mintlify/remittances/developer-guides/platform-configuration.mdx

@@ -1,4 +1,5 @@
 type: object
+description: Physical address information
 required:
   - line1
   - postalCode
@@ -12,13 +13,17 @@ properties:
     type: string
     description: Street address line 2
     example: Apt 4B
+  town:
+    type: string
+    description: Town/Neighborhood
+    example: Hollywood
   city:
     type: string
     description: City
-    example: San Francisco
+    example: Los Angeles
   state:
     type: string
-    description: State/Province/Region
+    description: State/County/Province/Region
     example: CA
   postalCode:
     type: string

openapi.yaml

@@ -5,7 +5,7 @@ enum:
   - NATIONALITY
   - PHONE_NUMBER
   - EMAIL
-  - ADDRESS
+  - POSTAL_ADDRESS
   - TAX_ID
   - REGISTRATION_NUMBER
   - USER_TYPE

openapi/components/schemas/common/Address.yaml

@@ -94,7 +94,7 @@ post:
               requestedReceiverUserInfoFields:
                 - name: NATIONALITY
                   mandatory: true
-                - name: ADDRESS
+                - name: POSTAL_ADDRESS
                   mandatory: false
               timestamp: '2023-08-15T14:32:00Z'
               webhookId: Webhook:019542f5-b3e7-1d02-0000-000000000007

openapi/components/schemas/users/UserInfoFieldName.yaml

@@ -148,8 +148,8 @@ private fun buildResponseUserData(requestedFields: List<CounterpartyFieldDefinit
             "PHONE_NUMBER" -> {
                 builder.putAdditionalProperty("PHONE_NUMBER",JsonValue.from("+16502535555"))
             }
-            "ADDRESS" -> {
-                builder.putAdditionalProperty("ADDRESS", JsonValue.from(Address.builder()
+            "POSTAL_ADDRESS" -> {
+                builder.putAdditionalProperty("POSTAL_ADDRESS", JsonValue.from(Address.builder()
                     .line1("123 Sample St")
                     .city("Sampleville")
                     .state("CA")