Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 124 additions & 39 deletions swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1257,14 +1257,19 @@ components:
properties:
deviceId:
type: string
description: ID único do dispositivo gerado pela plataforma.
description: |
ID único do dispositivo gerado pela plataforma.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor/).
example: 00000000-54b3-e7c7-0000-000046bffd97
isRootedDevice:
type: boolean
description: |
Indica se o dispositivo atualmente está com permissão de “root”.

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante o pagamento for Android ou iOS.
[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante a vinculação de conta ou realização do pagamento for Android ou iOS.
example: false
screenBrightness:
type: number
Expand All @@ -1281,14 +1286,28 @@ components:
description: |
Indica por quanto tempo (em milissegundos) o dispositivo está ligado.

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante o pagamento for Android ou iOS.
[Android] Informação obtida através do [link](https://developer.android.com/reference/android/os/SystemClock#elapsedRealtime%28%29).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/kernel/kern/).

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante a vinculação de conta ou realização do pagamento for Android ou iOS.
osVersion:
type: string
description: Versão do sistema operacional.
description: |
Versão do sistema operacional.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/os/Build.VERSION#RELEASE).
[iOS] - Informação obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620043-systemversion/).
example: "14"
userTimeZoneOffset:
type: string
description: |
Indica a configuração de fuso horário do dispositivo do usuário, com o formato UTC offset: ±hh[:mm]
Indica a configuração de fuso horário do dispositivo do usuário, com o formato UTC offset: ±hh[:mm]. O formato especificado permite a omissão da parte correspondente aos minutos, caso esta última tenha valor zero. Assim, ambos os valores '-03:00' e '-03' são válidos e representam o mesmo fuso horário.

[Android] Informação obtida através do [link](https://developer.android.com/reference/java/time/ZonedDateTime#getOffset()) ou, para versões anteriores à 8.0, [link](https://developer.android.com/reference/java/util/TimeZone#getOffset(long)).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/foundation/timezone/).
example: '-03'
language:
type: string
description: Indica o idioma do dispositivo no formato ISO 639-1.
Expand All @@ -1301,38 +1320,46 @@ components:
properties:
height:
type: integer
format: int64
example: 2340
description: Altura da tela, em pixels.
width:
type: integer
format: int64
description: Largura da tela, em pixels.
example: 1080
accountTenure:
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
description: Data de cadastro do cliente na iniciadora.
geolocation:
type: object
description: Dados de geolocalização do cliente enquanto logado na iniciadora
description: |
Localização do usuário, obtida com seu consentimento.

[Android] Informação obtida através do [link](https://developers.google.com/android/reference/com/google/android/gms/location/FusedLocationProviderClient#public-abstract-tasklocation-getlastlocation) considerando as permissões necessárias.

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/corelocation/).

[Restrição] A ITP deve solicitar ao usuário a permissão para compartilhamento de sua localização. Este campo poderá ser omitido caso o GPS esteja indisponível, isto é, sem sinal, ou em dispositivos sem o hardware necessário; ou caso o usuário negue o consentimento.
properties:
latitude:
type: number
format: double
description: Coordenada latitudial do cliente enquanto logado na iniciadora
example: -15.738602
longitude:
type: number
format: double
description: Coordenada longitudinal do cliente enquanto logado na iniciadora
example: -47.926498
type:
type: string
description: |
Tipo de mecanismo utilizado na geração da geolocalização
Tipo de mecanismo utilizado na geração da geolocalização
enum:
- COARSE
- FINE
- INFERRED
isCallingProgress:
example: FINE
isCallInProgress:
type: boolean
description: |
Indica chamada ativa no momento do vínculo.
Expand All @@ -1343,7 +1370,14 @@ components:
description: Indica se o dispositivo está em modo de desenvolvedor.
isMockGPS:
type: boolean
description: Indica se o dispositivo está usando um GPS falso.
description: |
Indica se o dispositivo está usando um GPS falso. Deve ser enviado sempre que exista o campo geolocation com tipo `COARSE` ou `FINE`.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/location/Location.html#isMock()) ou, para versões anteriores à 12, [link](https://developer.android.com/reference/android/location/Location.html#isFromMockProvider()).

[iOS] Informação obtida através dos links:
sourceInformation, [link](https://developer.apple.com/documentation/corelocation/cllocation/3861803-sourceinformation).
isSimulatedBySoftware, [link](https://developer.apple.com/documentation/corelocation/cllocationsourceinformation/3861807-issimulatedbysoftware).
isEmulated:
type: boolean
description: Indica se o dispositivo é emulado ou real.
Expand All @@ -1352,7 +1386,12 @@ components:
description: Indica o uso do MonkeyRunner.
isCharging:
type: boolean
description: Indica se a bateria do dispositivo está sendo carregada.
description: |
Indica se a bateria do dispositivo está sendo carregada.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/os/BatteryManager).

[iOS] Informações obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620045-batterymonitoringenabled/).
antennaInformation:
type: string
description: Indica em qual antena o dispositivo está conectado.
Expand All @@ -1369,9 +1408,11 @@ components:
appRecognitionVerdict:
type: string
description: Informa a integridade do app
example: "PLAY_RECOGNIZED"
deviceRecognitionVerdict:
type: string
description: Informa a integridade do dispositivo
example: '[\"MEETS_DEVICE_INTEGRITY\"]'
automatic:
type: object
required:
Expand Down Expand Up @@ -1400,9 +1441,6 @@ components:
type: object
required:
- deviceId
- isRootedDevice
- screenBrightness
- elapsedTimeSinceBoot
- osVersion
- userTimeZoneOffset
- language
Expand All @@ -1415,74 +1453,119 @@ components:
properties:
deviceId:
type: string
description: ID único do dispositivo gerado pela plataforma.
description: |
ID único do dispositivo gerado pela plataforma.

Utiliza-se a propriedade do sistema que identifica a combinação de usuário logado, chave de assinatura do aplicativo e dispositivo.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor/).
example: 00000000-54b3-e7c7-0000-000046bffd97
isRootedDevice:
type: boolean
description: Indica se o dispositivo atualmente está com permissão de “root”.
description: |
Indica se o dispositivo atualmente está com permissão de “root”.

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante a vinculação de conta ou realização do pagamento for Android ou iOS.
example: false
screenBrightness:
type: number
format: double
description: |
Indica o nível de brilho da tela do dispositivo.
Em dispositivos Android o valor é um inteiro, entre 0 e 255, inclusive;
Em dispositivos iOS o valor é um ponto flutuante entre 0.0 e 1.0.
Indica o nível de brilho da tela do dispositivo.

[Android] O valor é inteiro, tipicamente entre 0 a 255, podendo a faixa de valores variar de acordo com o fabricante do celular. Referência no [link](https://developer.android.com/reference/android/provider/Settings.System#SCREEN_BRIGHTNESS).

[iOS] O valor é ponto flutuante entre “0.0” e “1.0”. Referência no [link](https://developer.apple.com/documentation/uikit/uiscreen/).

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante a vinculação de conta ou realização do pagamento for Android ou iOS.
elapsedTimeSinceBoot:
type: integer
format: int64
description: Indica por quanto tempo (em milissegundos) o dispositivo está ligado.
description: |
Indica por quanto tempo (em milissegundos) o dispositivo está ligado.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/os/SystemClock#elapsedRealtime%28%29).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/kernel/kern/).

[Restrição] Campos de envio obrigatório quando o sistema operacional utilizado pelo usuário durante a vinculação de conta ou realização do pagamento for Android ou iOS.
example: 6356027
osVersion:
type: string
description: Versão do sistema operacional.
description: |
Versão do sistema operacional.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/os/Build.VERSION#RELEASE).
[iOS] - Informação obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620043-systemversion/).
example: "14"
userTimeZoneOffset:
type: string
description: |
Indica a configuração de fuso horário do dispositivo do usuário, com o formato UTC offset: ±hh[:mm]
Indica a configuração de fuso horário do dispositivo do usuário, com o formato UTC offset: ±hh[:mm]. O formato especificado permite a omissão da parte correspondente aos minutos, caso esta última tenha valor zero. Assim, ambos os valores '-03:00' e '-03' são válidos e representam o mesmo fuso horário.

[Android] Informação obtida através do [link](https://developer.android.com/reference/java/time/ZonedDateTime#getOffset()) ou, para versões anteriores à 8.0, [link](https://developer.android.com/reference/java/util/TimeZone#getOffset(long)).

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/foundation/timezone/).
example: '-03'
language:
type: string
description: Indica o idioma do dispositivo no formato ISO 639-1.
description: |
Indica o idioma do dispositivo no formato ISO 639-1.

[Android] Informação obtida através do [link](https://developer.android.com/reference/java/util/Locale#getLanguage()).
[iOS] - Informação obtida através do [link](https://developer.apple.com/documentation/foundation/locale/languagecode/).
example: 'pt'
screenDimensions:
type: object
description: Dimensões da tela do dispositivo
description: |
Dimensões que o aplicativo ocupa na tela do dispositivo.

[Android] Informação obtida através do [link](https://developer.android.com/reference/android/view/WindowMetrics#getBounds()), ou, para versões anteriores à 11, [link](https://developer.android.com/reference/android/util/DisplayMetrics).

[iOS] - Informação obtida através do [link](https://developer.apple.com/documentation/metal/mtlrasterizationratemap/3088873-screensize/).
required:
- height
- width
properties:
height:
type: integer
format: int64
description: Altura da tela, em pixels.
example: 2340
width:
type: integer
format: int64
description: Largura da tela, em pixels.
example: 2340
accountTenure:
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$'
description: Data de cadastro do cliente na iniciadora.
geolocation:
type: object
description: Dados de geolocalização do cliente enquanto logado na iniciadora
description: |
Localização do usuário, obtida com seu consentimento.

[Android] Informação obtida através do [link](https://developers.google.com/android/reference/com/google/android/gms/location/FusedLocationProviderClient#public-abstract-tasklocation-getlastlocation) considerando as permissões necessárias.

[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/corelocation/).

[Restrição] A ITP deve solicitar ao usuário a permissão para compartilhamento de sua localização. Este campo poderá ser omitido caso o GPS esteja indisponível, isto é, sem sinal, ou em dispositivos sem o hardware necessário; ou caso o usuário negue o consentimento.
properties:
latitude:
type: number
format: double
description: Coordenada latitudial do cliente enquanto logado na iniciadora
example: -15.738602
longitude:
type: number
format: double
description: Coordenada longitudinal do cliente enquanto logado na iniciadora
example: -47.926498
type:
type: string
description: |
Tipo de mecanismo utilizado na geração da geolocalização
enum:
- COARSE
- FINE
- INFERRED
isCallingProgress:
example: FINE
isCallInProgress:
type: boolean
description: |
Indica chamada ativa no momento do vínculo.
Expand Down Expand Up @@ -1519,9 +1602,11 @@ components:
appRecognitionVerdict:
type: string
description: Informa a integridade do app
example: "PLAY_RECOGNIZED"
deviceRecognitionVerdict:
type: string
description: Informa a integridade do dispositivo
example: '[\"MEETS_DEVICE_INTEGRITY\"]'
RiskSignalsConsentEdition:
type: object
required:
Expand Down