Merge pull request #1149 from maxmind/greg/add-phone-outputs

Add billing_phone and shipping_phone minFraud outputs
maxmind · Jun 26, 2024 · c7a93be · c7a93be
2 parents 808f50b + 4902feb
commit c7a93be
Show file tree

Hide file tree

Showing 7 changed files with 129 additions and 0 deletions.
diff --git a/content/minfraud/api-documentation/_examples/response.ts b/content/minfraud/api-documentation/_examples/response.ts
@@ -29,6 +29,12 @@ export const insights = {
     latitude: 37.545,
     longitude: -122.421,
   },
+  biling_phone: {
+    country: "US",
+    is_voip: true,
+    network_operator: "Verizon/1",
+    number_type: "fixed",
+  },
   credit_card: {
     brand: 'Visa',
     country: 'US',
@@ -216,6 +222,12 @@ export const insights = {
     latitude: 37.632,
     longitude: -122.313,
   },
+  shipping_phone: {
+    country: "CA",
+    is_voip: true,
+    network_operator: "Telus Mobility-SVR/2",
+    number_type: "mobile",
+  },
 };
 
 export const factors = {

diff --git a/content/minfraud/api-documentation/_schemas/Response.mdx b/content/minfraud/api-documentation/_schemas/Response.mdx
@@ -119,6 +119,19 @@ minFraud service you query and the inputs provided.
     not be parsed, this object will not be present in the response.
   </Property>
 
+  <Property
+    linkToSchemaName={'Response | Shipping Phone'}
+    name="shipping_phone"
+    services={[
+      'insights',
+      'factors',
+    ]}
+  >
+    This object contains minFraud response data associated with the shipping
+    phone. If the shipping phone was not provided in the request or could
+    not be parsed, this object will not be present in the response.
+  </Property>
+
   <Property
     linkToSchemaName={'Response | Billing Address'}
     name="billing_address"
@@ -132,6 +145,19 @@ minFraud service you query and the inputs provided.
     not be parsed, this object will not be present in the response.
   </Property>
 
+  <Property
+    linkToSchemaName={'Response | Billing Phone'}
+    name="billing_phone"
+    services={[
+      'insights',
+      'factors',
+    ]}
+  >
+    This object contains minFraud response data associated with the billing
+    phone. If the billing phone was not provided in the request or could
+    not be parsed, this object will not be present in the response.
+  </Property>
+
   <Property
     linkToSchemaName={'Response | Disposition'}
     name="disposition"

diff --git a/content/minfraud/api-documentation/_schemas/ResponseBillingPhone.mdx b/content/minfraud/api-documentation/_schemas/ResponseBillingPhone.mdx
@@ -0,0 +1,36 @@
+import responseJson from '../_examples/response';
+
+<MinFraudSchema
+  json={responseJson.billing_phone}
+  jsonPointer="/billing_phone"
+  name="Response | Billing Phone"
+  services={[
+    'insights',
+    'factors',
+  ]}
+>
+  <Property
+    name="country"
+  >
+    A two-character [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) country code for the country associated with the billing phone number.
+  </Property>
+
+  <Property
+    name="network_operator"
+  >
+    The name of the original network operator associated with the billing phone number. This field does not reflect phone numbers that have been ported from the original operator to another, nor does it identify [mobile virtual network operators](https://en.wikipedia.org/wiki/Mobile_virtual_network_operator).
+  </Property>
+
+  <Property
+    name="number_type"
+  >
+    One of the following values: `fixed` or `mobile`. Additional values may be added in the future.
+  </Property>
+
+  <Property
+    name="is_voip"
+    type="boolean"
+  >
+    This is `true` if the billing phone number is a Voice over Internet Protocol (VoIP) number allocated by a regulator. It is `false` if the billing phone number is not a VoIP number allocated by a regulator. The key is only present when a valid billing phone number has been provided and we have data for it.
+  </Property>
+</MinFraudSchema>
diff --git a/content/minfraud/api-documentation/_schemas/ResponseShippingPhone.mdx b/content/minfraud/api-documentation/_schemas/ResponseShippingPhone.mdx
@@ -0,0 +1,36 @@
+import responseJson from '../_examples/response';
+
+<MinFraudSchema
+  json={responseJson.shipping_phone}
+  jsonPointer="/shipping_phone"
+  name="Response | Shipping Phone"
+  services={[
+    'insights',
+    'factors',
+  ]}
+>
+  <Property
+    name="country"
+  >
+    A two-character [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) country code for the country associated with the [shipping/shipping] phone number.
+  </Property>
+
+  <Property
+    name="network_operator"
+  >
+    The name of the original network operator associated with the shipping phone number. This field does not reflect phone numbers that have been ported from the original operator to another, nor does it identify [mobile virtual network operators](https://en.wikipedia.org/wiki/Mobile_virtual_network_operator).
+  </Property>
+
+  <Property
+    name="number_type"
+  >
+    One of the following values: `fixed` or `mobile`. Additional values may be added in the future.
+  </Property>
+
+  <Property
+    name="is_voip"
+    type="boolean"
+  >
+    This is `true` if the shipping phone number is a Voice over Internet Protocol (VoIP) number allocated by a regulator. It is `false` if the shipping phone number is not a VoIP number allocated by a regulator. The key is only present when a valid shipping phone number has been provided and we have data for it.
+  </Property>
+</MinFraudSchema>
diff --git a/content/minfraud/api-documentation/_schemas/index.mdx b/content/minfraud/api-documentation/_schemas/index.mdx
@@ -24,7 +24,9 @@ export { default as ResponseDevice } from './ResponseDevice';
 export { default as ResponseEmail } from './ResponseEmail';
 export { default as ResponseEmailDomain } from './ResponseEmailDomain';
 export { default as ResponseShippingAddress } from './ResponseShippingAddress';
+export { default as ResponseShippingPhone } from './ResponseShippingPhone';
 export { default as ResponseBillingAddress } from './ResponseBillingAddress';
+export { default as ResponseBillingPhone } from './ResponseBillingPhone';
 export { default as ResponseDisposition } from './ResponseDisposition';
 export { default as ResponseSubscores } from './ResponseSubscores';
 export { default as ResponseWarnings } from './ResponseWarnings';

diff --git a/content/minfraud/api-documentation/responses.mdx b/content/minfraud/api-documentation/responses.mdx
@@ -238,7 +238,9 @@ definition that further describes that specific object.
 <Schemas.ResponseEmail />
 <Schemas.ResponseEmailDomain />
 <Schemas.ResponseShippingAddress />
+<Schemas.ResponseShippingPhone />
 <Schemas.ResponseBillingAddress />
+<Schemas.ResponseBillingPhone />
 <Schemas.ResponseDisposition />
 <Schemas.ResponseSubscores />
 <Schemas.ResponseWarnings />

diff --git a/content/minfraud/whats-new-in-minfraud-score-and-minfraud-insights.mdx b/content/minfraud/whats-new-in-minfraud-score-and-minfraud-insights.mdx
@@ -186,12 +186,27 @@ The following outputs have been added.
   - `distance_to_billing_address`
   - `is_in_ip_country`
 
+- `shipping_phone`
+
+  - `country`
+  - `network_operator`
+  - `number_type`
+  - `is_voip`
+
 - `billing_address`
+
   - `latitude`<sup>\*</sup>
   - `longitude`<sup>\*</sup>
   - `distance_to_ip_location`
   - `is_in_ip_country`
 
+- `billing_phone`
+
+  - `country`
+  - `network_operator`
+  - `number_type`
+  - `is_voip`
+
 <small>\* Latitude and longitude are not precise and should not be used to identify a
 particular street address or household.</small>